Skip to main content

TextureRef

Struct TextureRef 

Source
pub struct TextureRef<'tex> { /* private fields */ }
Expand description

A convenient, typed wrapper around ImGui’s ImTextureRef (v1.92+)

Can reference either a plain TextureId (legacy path) or a managed TextureData. Managed texture references carry the lifetime of the referenced texture data; legacy TextureId references can be converted into any texture-reference lifetime because they do not borrow Rust texture data.

Examples

  • With a plain GPU handle (legacy path):
let tex_id = TextureId::new(12345);
ui.image(tex_id, [64.0, 64.0]);
  • With a managed texture (ImGui 1.92 texture system):
let mut tex = TextureData::new();
tex.create(TextureFormat::RGBA32, 256, 256);
// Fill pixels or schedule updates...
ui.image(&mut *tex, [256.0, 256.0]);
// The renderer backend will honor WantCreate/WantUpdates/WantDestroy
// via DrawData::textures_mut() when rendering this frame.

Managed references cannot be stored beyond the texture data they point at:

let leaked: TextureRef<'static>;
{
    let mut tex = TextureData::new();
    leaked = (&mut tex).into();
}
let _ = leaked.raw();

Raw ImTextureRef values can contain arbitrary managed texture pointers, so constructing this wrapper from raw data is unsafe:

let raw = sys::ImTextureRef {
    _TexData: std::ptr::null_mut(),
    _TexID: 0,
};
let _ = TextureRef::from_raw(raw);

Implementations§

Source§

impl<'tex> TextureRef<'tex>

Source

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

Create a texture reference from a raw ImGui texture ref.

§Safety

If raw._TexData is non-null, the caller must guarantee that it points to a valid ImTextureData for the entire 'tex lifetime and that using the resulting reference does not violate Rust aliasing rules.

Source

pub fn raw(self) -> ImTextureRef

Get the underlying ImGui texture ref (by value)

Trait Implementations§

Source§

impl<'tex> Clone for TextureRef<'tex>

Source§

fn clone(&self) -> TextureRef<'tex>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'tex> Debug for TextureRef<'tex>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'tex> From<&TextureData> for TextureRef<'tex>

Source§

fn from(td: &TextureData) -> Self

Converts to this type from the input type.
Source§

impl<'tex> From<&'tex mut TextureData> for TextureRef<'tex>

Source§

fn from(td: &'tex mut TextureData) -> Self

Converts to this type from the input type.
Source§

impl<'tex> From<TextureId> for TextureRef<'tex>

Source§

fn from(id: TextureId) -> Self

Converts to this type from the input type.
Source§

impl<'tex> Copy for TextureRef<'tex>

Auto Trait Implementations§

§

impl<'tex> Freeze for TextureRef<'tex>

§

impl<'tex> !RefUnwindSafe for TextureRef<'tex>

§

impl<'tex> !Send for TextureRef<'tex>

§

impl<'tex> !Sync for TextureRef<'tex>

§

impl<'tex> Unpin for TextureRef<'tex>

§

impl<'tex> UnsafeUnpin for TextureRef<'tex>

§

impl<'tex> !UnwindSafe for TextureRef<'tex>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

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

Source§

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>,

Source§

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>,

Source§

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more