Struct TextureData 

pub struct TextureData { /* private fields */ }

Texture data managed by Dear ImGui

This is a wrapper around ImTextureData that provides safe access to texture information and pixel data. It’s used by renderer backends to create, update, and destroy textures.

Lifecycle & Backend Flow (ImGui 1.92+)

• Create an instance (e.g. via OwnedTextureData::new() + create())
• Mutate pixels, set flags/rects (e.g. call set_data() or directly write Pixels then set UpdateRect), and set status to WantCreate/WantUpdates.
• Register user-created owned textures once via Context::register_user_texture(&mut tex). Dear ImGui builds DrawData::textures() from its internal PlatformIO.Textures[] list (font atlas textures are registered by ImGui itself).
• Your renderer backend iterates DrawData::textures_mut() and performs the requested create/update/destroy operations, then updates status to OK/Destroyed.
• You can also set/get a TexID (e.g., GPU handle) via set_tex_id()/tex_id() after creation.

Lifetime Note: If using the managed path, you must keep the underlying ImTextureData alive at least until the end of the frame where it is referenced by UI calls. If you create textures yourself, use OwnedTextureData to ensure the object is correctly constructed and destroyed by the C++ side.

Implementations

impl TextureData

pub fn new() -> OwnedTextureData

Create a new owned texture data object.

This is kept for convenience. Prefer OwnedTextureData::new() for clarity.

pub fn as_raw(&self) -> *const ImTextureData

Get the raw pointer to the underlying ImTextureData

pub fn as_raw_mut(&mut self) -> *mut ImTextureData

Get the raw mutable pointer to the underlying ImTextureData

pub fn unique_id(&self) -> ManagedTextureId

Get this managed texture’s stable ImGui identity.

pub fn status(&self) -> TextureStatus

Get the current status of this texture

pub fn set_status(&mut self, status: TextureStatus)

Set the status of this texture

This should only be called by renderer backends after handling a request.

pub fn backend_user_data(&self) -> *mut c_void

Get the backend user data

pub fn set_backend_user_data(&mut self, data: *mut c_void)

Set the backend user data

pub fn tex_id(&self) -> TextureId

Get the texture ID

pub fn set_tex_id(&mut self, tex_id: TextureId)

Set the texture ID

This should only be called by renderer backends after creating or destroying the texture.

pub fn texture_ref(&mut self) -> TextureRef<'_>

Get the current texture reference for this managed texture.

pub fn format(&self) -> TextureFormat

Get the texture format

pub fn width(&self) -> u32

Get the texture width

pub fn height(&self) -> u32

Get the texture height

pub fn bytes_per_pixel(&self) -> usize

Get the bytes per pixel

pub fn unused_frames(&self) -> usize

Get the number of unused frames

pub fn ref_count(&self) -> u16

Get the reference count

pub fn use_colors(&self) -> bool

Check if the texture uses colors (rather than just white + alpha)

pub fn want_destroy_next_frame(&self) -> bool

Check if the texture is queued for destruction next frame

pub fn pixels(&self) -> Option<&[u8]>

Get the pixel data

Returns None if no pixel data is available.

pub fn used_rect(&self) -> TextureRect

Get the bounding box of all used pixels in the texture

pub fn update_rect(&self) -> TextureRect

Get the bounding box of all queued updates

pub fn updates(&self) -> impl Iterator<Item = TextureRect> + '_

Iterate over queued update rectangles (copying to safe TextureRect)

pub fn pixels_at(&self, x: u32, y: u32) -> Option<&[u8]>

Get the pixel data at a specific position

Returns None if no pixel data is available or coordinates are out of bounds.

pub fn pitch(&self) -> usize

Get the pitch (bytes per row)

pub fn create(&mut self, format: TextureFormat, width: u32, height: u32)

Create a new texture with the specified format and dimensions

This allocates pixel data and sets the status to WantCreate.

pub fn destroy_pixels(&mut self)

Destroy the pixel data

This frees the CPU-side pixel data but doesn’t affect the GPU texture.

pub fn set_data(&mut self, data: &[u8])

Set the pixel data for the texture

This copies the provided data into the texture’s pixel buffer.

pub fn set_width(&mut self, width: u32)

Set the width of the texture

pub fn set_height(&mut self, height: u32)

Set the height of the texture

pub fn set_format(&mut self, format: TextureFormat)

Set the format of the texture

Trait Implementations

impl AsMut<TextureData> for OwnedTextureData

fn as_mut(&mut self) -> &mut TextureData

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<TextureData> for OwnedTextureData

fn as_ref(&self) -> &TextureData

Converts this type into a shared reference of the (usually inferred) input type.

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

fn from(td: &TextureData) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.