pub struct Paa { /* private fields */ }Expand description
A PAA texture.
Implementations§
Source§impl Paa
impl Paa
Sourcepub fn compression(&self) -> &str
pub fn compression(&self) -> &str
Compression format name as read from the file, e.g. "DXT5", "ARGB4444", "ARGB1555" or "AI88".
Sourcepub fn mipmap_count(&self) -> usize
pub fn mipmap_count(&self) -> usize
Number of mipmaps.
Sourcepub fn tagg(&self, name: &str) -> Option<&[u8]>
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.
Sourcepub fn read<I: Read + Seek>(input: &mut I) -> Result<Paa, Error>
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.
Sourcepub fn to_dynamic_image(&self) -> Result<DynamicImage, Error>
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.
Sourcepub fn from_dynamic_image(
img: &DynamicImage,
format: PaaFormat,
) -> Result<Paa, Error>
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.
Sourcepub fn lzo_compress(&mut self) -> Result<(), Error>
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.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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