Struct tetra::graphics::ImageData[][src]

pub struct ImageData { /* fields omitted */ }
Expand description

Raw image data.

Supported Formats

Various file formats are supported, and can be enabled or disabled via Cargo features:

FormatCargo featureEnabled by default?
PNGtexture_pngYes
JPEGtexture_jpegYes
GIFtexture_gifYes
BMPtexture_bmpYes
TIFFtexture_tiffNo
TGAtexture_tgaNo
WebPtexture_webpNo
ICOtexture_icoNo
PNMtexture_pnmNo
DDS/DXTtexture_ddsNo

Implementations

Loads image data from the given file.

The format will be determined based on the file extension.

Errors

Decodes image data that is encoded in one of Tetra’s supported file formats (except for TGA).

This is useful in combination with include_bytes, as it allows you to include your image data directly in the binary.

The format will be determined based on the ‘magic bytes’ at the beginning of the data. Note that TGA files do not have recognizable magic bytes, so this function will not recognize them.

Errors

Creates an ImageData from raw RGBA8 data.

This function takes Into<Vec<u8>>. If you pass a Vec<u8>, that Vec will be reused for the created ImageData without reallocating. Otherwise, the data will be copied.

This function requires you to provide enough data to fill the image’s bounds. If you provide too little data, an error will be returned. If you provide too much data, it will be truncated.

Errors
👎 Deprecated since 0.6.4:

renamed to from_rgba8 for consistency

Returns the width of the image.

Returns the height of the image.

Returns the size of the image.

Returns the image’s data, as a slice of raw bytes.

Returns the image’s underlying buffer.

Creates a new ImageData from a region.

This will copy the data into a new buffer - as such, calling this function can be expensive!

Creates a new Texture from the stored data.

Errors

Gets the color of the pixel at the specified location.

Panics

Panics if the location is outside the bounds of the image.

Sets the color of the pixel at the specified location.

Panics

Panics if the location is outside the bounds of the image.

Transforms the image data by applying a function to each pixel.

Multiplies the RGB components of each pixel by the alpha component.

This can be useful when working with premultiplied alpha blending.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.