Struct Texture

pub struct Texture { /* private fields */ }

Texture, tex data stored in GPU memory (VRAM)

Implementations

impl Texture

pub fn width(&self) -> u32

Texture base width

pub fn height(&self) -> u32

Texture base height

pub fn mipmaps(&self) -> u32

Mipmap levels, 1 by default

pub fn format(&self) -> PixelFormat

Data format

pub fn from_file(file_name: &str) -> Option<Self>

Load texture from file into GPU memory (VRAM)

pub fn from_image(image: &Image) -> Option<Self>

Load texture from image data

pub fn from_cubemap( image: &Image, layout: CubemapLayout, ) -> Option<TextureCubemap>

Load cubemap from image, multiple image cubemap layouts supported

pub fn update(&mut self, pixels: &[u8]) -> bool

Update GPU texture with new data

Returns true on success, false if pixels has wrong size (use get_pixel_data_size())

pub fn update_rect(&mut self, rect: Rectangle, pixels: &[u8]) -> bool

Update GPU texture rectangle with new data

Returns true on success, false if pixels has wrong size or rect goes out of bounds

pub fn get_pixel_data_size(&self) -> usize

Get pixel data size in bytes for this texture

pub fn generate_mipmaps(&mut self)

Generate GPU mipmaps for a texture

pub fn set_filter(&mut self, filter: TextureFilter)

Set texture scaling filter mode

pub fn set_wrap(&mut self, wrap: TextureWrap)

Set texture wrapping mode

pub fn as_raw(&self) -> &Texture

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut Texture

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: Texture) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Debug for Texture

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

Formats the value using the given formatter.

impl Drop for Texture

fn drop(&mut self)

Executes the destructor for this type.