Struct RawTga

pub struct RawTga<'a> { /* private fields */ }

Raw TGA image.

RawTga can be used to access lower level information about a TGA file and to access the raw pixel data. It can be created directly by using the from_slice constructor or accessed by calling as_raw method of a Tga object.

Implementations

impl<'a> RawTga<'a>

pub fn from_slice(data: &'a [u8]) -> Result<Self, ParseError>

Parse a TGA image from a byte slice.

pub fn size(&self) -> Size

Returns the dimensions of this image.

pub fn color_map(&self) -> Option<&ColorMap<'a>>

Returns the color map.

None is returned if the image contains no color map.

pub fn color_bpp(&self) -> Bpp

Returns the color bit depth (BPP) of this image.

This function always returns the bit depth of the decoded pixels, regardless of how they are stored in the TGA file. Use image_data_bpp to get the number of bits used to store one pixel in the image data.

pub fn image_origin(&self) -> ImageOrigin

Returns the image origin.

pub fn data_type(&self) -> DataType

Returns the data type.

pub fn compression(&self) -> Compression

Returns the compression type.

pub fn image_data(&self) -> &'a [u8]

Returns the raw image data contained in this image.

pub fn image_data_bpp(&self) -> Bpp

Returns the size of a single pixel in bits.

This function returns the number of bits used to store a single pixel in the image data.

For true color and grayscale images, where the colors are stored directly in the image data, the returned value will match the value returned by color_bpp.

For color mapped images, where the image data consists of color indices, the returned value describes the bit depth of the indices and may differ from the depth returned by color_bpp.

pub fn pixels(&self) -> RawPixels<'_>

Returns an iterator over the raw pixels in this image.

pub fn header(&self) -> TgaHeader

Returns the TGA header.

The returned object is a direct representation of the header contained in the TGA file. Most of the information contained in the header is also available using other methods, which are the preferred way of accessing them.

Performance

To save memory the header is parsed every time this method is called.

pub fn developer_directory(&self) -> Option<&'a [u8]>

Returns the developer directory.

Performance

To save memory the footer is parsed every time this method is called.

pub fn extension_area(&self) -> Option<&'a [u8]>

Returns the extension area.

Performance

To save memory the footer is parsed every time this method is called.

pub fn image_id(&self) -> Option<&'a [u8]>

Returns the content of the image ID.

If the TGA file doesn’t contain an image ID None is returned.

Performance

To save memory the header is parsed every time this method is called.

Trait Implementations

impl<'a> Clone for RawTga<'a>

fn clone(&self) -> RawTga<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for RawTga<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for RawTga<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl<'a> Ord for RawTga<'a>

fn cmp(&self, other: &RawTga<'a>) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for RawTga<'a>

fn eq(&self, other: &RawTga<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for RawTga<'a>

fn partial_cmp(&self, other: &RawTga<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for RawTga<'a>

impl<'a> Eq for RawTga<'a>

impl<'a> StructuralPartialEq for RawTga<'a>