Struct egui::TextureHandle

source ·
pub struct TextureHandle { /* private fields */ }
Expand description

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§

source§

impl TextureHandle

source

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

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

source

pub fn id(&self) -> TextureId

source

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

Assign a new image to an existing texture.

source

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

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

source

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

width x height

source

pub fn size_vec2(&self) -> Vec2

width x height

source

pub fn byte_size(&self) -> usize

width x height x bytes_per_pixel

source

pub fn aspect_ratio(&self) -> f32

width / height

source

pub fn name(&self) -> String

Debug-name.

Trait Implementations§

source§

impl Clone for TextureHandle

source§

fn clone(&self) -> TextureHandle

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Drop for TextureHandle

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a> From<&'a TextureHandle> for SizedTexture

source§

fn from(handle: &'a TextureHandle) -> Self

Converts to this type from the input type.
source§

impl From<&TextureHandle> for TextureId

source§

fn from(handle: &TextureHandle) -> TextureId

Converts to this type from the input type.
source§

impl From<&mut TextureHandle> for TextureId

source§

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

Converts to this type from the input type.
source§

impl Hash for TextureHandle

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for TextureHandle

source§

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

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

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.
source§

impl Eq for TextureHandle

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.