Struct DrawData

#[repr(C)]
pub struct DrawData {
    pub total_idx_count: i32,
    pub total_vtx_count: i32,
    pub display_pos: [f32; 2],
    pub display_size: [f32; 2],
    pub framebuffer_scale: [f32; 2],
    /* private fields */
}

All draw data to render a Dear ImGui frame.

Fields

total_idx_count: i32

For convenience, sum of all draw list index buffer sizes.

total_vtx_count: i32

For convenience, sum of all draw list vertex buffer sizes.

display_pos: [f32; 2]

Upper-left position of the viewport to render.

(= upper-left corner of the orthogonal projection matrix to use)

display_size: [f32; 2]

Size of the viewport to render.

(= display_pos + display_size == lower-right corner of the orthogonal matrix to use)

framebuffer_scale: [f32; 2]

Amount of pixels for each unit of display_size.

Based on io.display_frame_buffer_scale. Typically [1.0, 1.0] on normal displays, and [2.0, 2.0] on Retina displays, but fractional values are also possible.

Implementations

impl DrawData

pub fn draw_lists(&self) -> DrawListIterator<'_>

Returns an iterator over the draw lists included in the draw data.

pub fn draw_lists_count(&self) -> usize

Returns the number of draw lists included in the draw data.

pub fn deindex_all_buffers(&mut self)

Converts all buffers from indexed to non-indexed, in case you cannot render indexed buffers.

This is slow and most likely a waste of resources. Always prefer indexed rendering!

pub fn scale_clip_rects(&mut self, fb_scale: Vector2<f32>)

Scales the clip rect of each draw command.

Can be used if your final output buffer is at a different scale than imgui-rs expects, or if there is a difference between your window resolution and framebuffer resolution.

Trait Implementations

impl From<&DrawData> for OwnedDrawData

fn from(value: &DrawData) -> OwnedDrawData

Construct OwnedDrawData from DrawData by creating a heap-allocated deep copy of the given DrawData

impl RawCast<ImDrawData> for DrawData

unsafe fn from_raw(raw: &T) -> &Self

Casts an immutable reference from the raw type

unsafe fn from_raw_mut(raw: &mut T) -> &mut Self

Casts a mutable reference from the raw type

unsafe fn raw(&self) -> &T

Casts an immutable reference to the raw type

unsafe fn raw_mut(&mut self) -> &mut T

Casts a mutable reference to the raw type