Struct TgaDecoder

Source
pub struct TgaDecoder<R> {
    r: R,
    width: usize,
    height: usize,
    bytes_per_pixel: usize,
    has_loaded_metadata: bool,
    image_type: ImageType,
    color_type: ColorType,
    original_color_type: Option<ExtendedColorType>,
    header: Header,
    color_map: Option<ColorMap>,
}
Expand description

A decoder for TGA images

Currently this decoder does not support 8, 15 and 16 bit color images. The representation of a TGA decoder

Fields§

§r: R§width: usize§height: usize§bytes_per_pixel: usize§has_loaded_metadata: bool§image_type: ImageType§color_type: ColorType§original_color_type: Option<ExtendedColorType>§header: Header§color_map: Option<ColorMap>

Implementations§

Source§

impl<R: Read> TgaDecoder<R>

Source

pub fn new(r: R) -> ImageResult<TgaDecoder<R>>

Create a new decoder that decodes from the stream r

Source

fn read_header(&mut self) -> ImageResult<()>

Source

fn read_metadata(&mut self) -> ImageResult<()>

Source

fn read_color_information(&mut self) -> ImageResult<()>

Loads the color information for the decoder

To keep things simple, we won’t handle bit depths that aren’t divisible by 8 and are larger than 32.

Source

fn read_image_id(&mut self) -> ImageResult<()>

Read the image id field

We’re not interested in this field, so this function skips it if it is present

Source

fn read_color_map(&mut self) -> ImageResult<()>

Source

fn expand_color_map(&self, pixel_data: &[u8]) -> Result<Vec<u8>>

Expands indices into its mapped color

Source

fn read_encoded_data(&mut self, num_bytes: usize) -> Result<Vec<u8>>

Reads a run length encoded data for given number of bytes

Source

fn read_all_encoded_data(&mut self) -> ImageResult<Vec<u8>>

Reads a run length encoded packet

Source

fn reverse_encoding_in_output(&mut self, pixels: &mut [u8])

Reverse from BGR encoding to RGB encoding

TGA files are stored in the BGRA encoding. This function swaps the blue and red bytes in the pixels array.

Source

fn flip_vertically(&mut self, pixels: &mut [u8])

Flip the image vertically depending on the screen origin bit

The bit in position 5 of the image descriptor byte is the screen origin bit. If it’s 1, the origin is in the top left corner. If it’s 0, the origin is in the bottom left corner. This function checks the bit, and if it’s 0, flips the image vertically.

Source

fn is_flipped_vertically(&self) -> bool

Check whether the image is vertically flipped

The bit in position 5 of the image descriptor byte is the screen origin bit. If it’s 1, the origin is in the top left corner. If it’s 0, the origin is in the bottom left corner. This function checks the bit, and if it’s 0, flips the image vertically.

Trait Implementations§

Source§

impl<R: Read> ImageDecoder for TgaDecoder<R>

Source§

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image
Source§

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder
Source§

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding
Source§

fn read_image(self, buf: &mut [u8]) -> ImageResult<()>

Returns all the bytes in the image. Read more
Source§

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe. Read more
Source§

fn icc_profile(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one. Read more
Source§

fn exif_metadata(&mut self) -> ImageResult<Option<Vec<u8>>>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it. Read more
Source§

fn orientation(&mut self) -> ImageResult<Orientation>

Returns the orientation of the image. Read more
Source§

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image. Read more
Source§

fn set_limits(&mut self, limits: Limits) -> ImageResult<()>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set. Read more

Auto Trait Implementations§

§

impl<R> Freeze for TgaDecoder<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for TgaDecoder<R>
where R: RefUnwindSafe,

§

impl<R> Send for TgaDecoder<R>
where R: Send,

§

impl<R> Sync for TgaDecoder<R>
where R: Sync,

§

impl<R> Unpin for TgaDecoder<R>
where R: Unpin,

§

impl<R> UnwindSafe for TgaDecoder<R>
where R: UnwindSafe,

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
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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.