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

pub struct ImageData { /* fields omitted */ }

Raw image data.

Currently, the image data is always internally represented as RGBA8. This may change, however, so this API intentionally does not expose the internal representation at the moment. Lower level access to the raw pixel data may be added in a future version.

Supported Formats

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

FormatCargo featureEnabled by default?


Creating or cloning an ImageData is a relatively expensive operation. If you can, store them in your State struct rather than recreating them each frame.


impl ImageData[src]

pub fn from_file<P>(path: P) -> Result<ImageData> where
    P: AsRef<Path>, 

Loads image data from the given file.

The format will be determined based on the file extension.


pub fn from_file_data(data: &[u8]) -> Result<ImageData>[src]

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.


pub fn from_rgba<D>(width: i32, height: i32, data: D) -> Result<ImageData> where
    D: Into<Vec<u8>>, 

Creates an ImageData from raw RGBA 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.


pub fn width(&self) -> i32[src]

Returns the width of the image.

pub fn height(&self) -> i32[src]

Returns the height of the image.

pub fn size(&self) -> (i32, i32)[src]

Returns the size of the image.

pub fn region(&self, region: Rectangle<i32>) -> ImageData[src]

Creates a new ImageData from a region.

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

pub fn to_texture(&self, ctx: &mut Context) -> Result<Texture>[src]

Creates a new Texture from the stored data.


pub fn get_pixel_color(&self, position: Vec2<i32>) -> Color[src]

Gets the color of the pixel at the specified location.


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

pub fn set_pixel_color(&mut self, position: Vec2<i32>, color: Color)[src]

Sets the color of the pixel at the specified location.


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

pub fn transform<F>(&mut self, func: F) where
    F: FnMut(Vec2<i32>, Color) -> Color

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

pub fn premultiply(&mut self)[src]

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

This can be useful when working with premultiplied alpha blending.

Trait Implementations

impl Clone for ImageData[src]

impl Debug for ImageData[src]

Auto Trait Implementations

Blanket Implementations

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

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

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

impl<T> From<T> for T[src]

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.