Struct tetra::graphics::texture::Texture

pub struct Texture { /* fields omitted */ }

A 2D texture, held in GPU memory.

The following file formats are supported:

• PNG
• JPEG
• GIF
• BMP
• TIFF
• TGA
• WEBP
• ICO
• PNM

This type acts as a lightweight handle to the associated graphics hardware data, and so can be cloned with little overhead.

Methods

impl Texture

pub fn new<P>(ctx: &mut Context, path: P) -> Result<Texture> where
    P: AsRef<Path>, 

Creates a new texture from the given file.

The format will be determined based on the file extension.

Errors

If the file could not be read, a TetraError::Io will be returned.

If the image data was invalid, a TetraError::Image will be returned.

pub fn from_file_data(ctx: &mut Context, data: &[u8]) -> Result<Texture>

Creates a new texture from a slice of data, 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 textures directly in the binary.

The format will be determined based on the 'magic bytes' at the beginning of the data. This should be reasonably reliable, but a from_data_with_format function might have to be added later. Note that TGA files do not have recognizable magic bytes, so this function will not recognize them.

Errors

If the image data was invalid, a TetraError::Image will be returned.

pub fn from_rgba(
    ctx: &mut Context,
    width: i32,
    height: i32,
    data: &[u8]
) -> Result<Texture>

Creates a new texture from a slice of RGBA pixel data.

This is useful if you wish to create a texture at runtime.

Note that this method requires you to provide enough data to fill the texture. If you provide too much data, it will be truncated.

Errors

If not enough data is provided to fill the texture, a TetraError::NotEnoughData will be returned. This is to prevent OpenGL from reading uninitialized memory.

pub fn from_data(ctx: &mut Context, data: &[u8]) -> Result<Texture>

Deprecated since 0.2.13:

Renamed to from_file_data to disambiguate from other image data formats (e.g. RGBA).

pub fn width(&self) -> i32

Returns the width of the texture.

pub fn height(&self) -> i32

Returns the height of the texture.

Trait Implementations

impl Drawable for Texture

fn draw<P>(&self, ctx: &mut Context, params: P) where
    P: Into<DrawParams>, 

Draws self to the screen (or a canvas, if one is enabled), using the specified parameters.

impl Clone for Texture

fn clone(&self) -> Texture

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Texture> for Texture

fn eq(&self, other: &Texture) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Texture

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

Formats the value using the given formatter.