Struct me3_framework::overlay::TextureHandle

pub struct TextureHandle { /* private fields */ }

Used to paint images.

An image is pixels stored in RAM, and represented using ImageData. Before you can paint it however, you need to convert it to a texture.

If you are using egui, use egui::Context::load_texture.

The TextureHandle can be cloned cheaply. When the last TextureHandle for specific texture is dropped, the texture is freed.

See also TextureManager.

Implementations

impl TextureHandle

pub fn new(tex_mngr: Arc<RwLock<TextureManager>>, id: TextureId) -> TextureHandle

If you are using egui, use egui::Context::load_texture instead.

pub fn id(&self) -> TextureId

pub fn set(&mut self, image: impl Into<ImageData>, filter: TextureFilter)

Assign a new image to an existing texture.

pub fn set_partial(
    &mut self,
    pos: [usize; 2],
    image: impl Into<ImageData>,
    filter: TextureFilter
)

Assign a new image to a subregion of the whole texture.

pub fn size(&self) -> [usize; 2]

width x height

pub fn size_vec2(&self) -> Vec2

width x height

pub fn aspect_ratio(&self) -> f32

width / height

pub fn name(&self) -> String

Debug-name.

Trait Implementations

impl Clone for TextureHandle

fn clone(&self) -> TextureHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for TextureHandle

fn drop(&mut self)

Executes the destructor for this type.

impl From<&TextureHandle> for TextureId

fn from(handle: &TextureHandle) -> TextureId

Converts to this type from the input type.

impl From<&mut TextureHandle> for TextureId

fn from(handle: &mut TextureHandle) -> TextureId

Converts to this type from the input type.

impl Hash for TextureHandle

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<TextureHandle> for TextureHandle

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TextureHandle