Skip to main content

Paa

Struct Paa 

Source
pub struct Paa { /* private fields */ }
Expand description

A PAA texture.

Implementations§

Source§

impl Paa

Source

pub fn width(&self) -> u16

Width of the largest mipmap in pixels.

Source

pub fn height(&self) -> u16

Height of the largest mipmap in pixels.

Source

pub fn compression(&self) -> &str

Compression format name as read from the file, e.g. "DXT5", "ARGB4444", "ARGB1555" or "AI88".

Source

pub fn mipmap_count(&self) -> usize

Number of mipmaps.

Source

pub fn tagg(&self, name: &str) -> Option<&[u8]>

The data of the tagg called name, if the file has one.

The mipmap offset tagg (GGATSFFO) is not exposed: Paa::write generates it.

Source

pub fn read<I: Read + Seek>(input: &mut I) -> Result<Paa, Error>

Reads a PAA texture.

§Errors

Returns an error if the input is not a supported PAA file or is malformed.

Source

pub fn to_dynamic_image(&self) -> Result<DynamicImage, Error>

Decodes the largest mipmap into an image.

§Errors

Returns an error if the PAA has no image data, the format is unsupported or the data does not fit the declared dimensions.

Source

pub fn from_dynamic_image( img: &DynamicImage, format: PaaFormat, ) -> Result<Paa, Error>

Encodes an image as a PAA texture, building the mipmap chain down to 4x4.

§Errors

Returns an error for images too large for the format.

Source

pub fn lzo_compress(&mut self) -> Result<(), Error>

LZO-compresses the mipmaps wider than 128 pixels of a DXT texture.

A mipmap is replaced by its compressed form only if that is shorter, so the others stay raw (and Paa::write leaves them unmarked). Mipmaps that are already compressed, mipmaps of 128 pixels or less and textures of other formats are left unchanged; that is not an error, and calling this twice has no further effect.

§Errors

Currently never fails; the result leaves room for limits on the compressed size.

Source

pub fn write<O: Write>(&self, output: &mut O) -> Result<(), Error>

Writes the PAA texture.

§Errors

Returns an error on I/O failure or an unsupported compression type.

Trait Implementations§

Source§

impl Debug for Paa

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Paa

§

impl RefUnwindSafe for Paa

§

impl Send for Paa

§

impl Sync for Paa

§

impl Unpin for Paa

§

impl UnsafeUnpin for Paa

§

impl UnwindSafe for Paa

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.