Struct Renderer

pub struct Renderer { /* private fields */ }

The main Renderer type.

Implementations

impl Renderer

pub fn new(gl: GlContext) -> Result<Renderer>

Creates a new renderer object.

You need to provide the OpenGL context yourself.

pub fn with_builder(gl: GlContext, builder: &ContextBuilder) -> Result<Renderer>

Creates a new renderer object.

Just like new() but you can specify context parameters.

pub fn gl_context(&self) -> &GlContext

Gets a reference to the OpenGL context.

pub fn set_background_color(&mut self, color: Option<Color>)

Sets the default background color.

The set color will be used for glClear(GL_COLOR_BUFFER_BIT). Set to None to avoid this, and use easy_imgui::UiBuilder::pre_render to do whatever clearing you need, if anything.

pub fn set_matrix(&mut self, matrix: Option<Matrix3<f32>>)

Sets the 2D (3x3) matrix transformation for the UI display.

If you set this matrix to Some then it is your responsibility to also call the appropriate gl.viewport().

pub fn background_color(&self) -> Option<Color>

Gets the background color.

pub fn imgui(&mut self) -> &mut Context

Gets the stored Dear ImGui context.

pub fn set_size(&mut self, size: Vector2, scale: f32)

Sets the UI size, in logical units, and the scale factor.

pub fn size(&mut self) -> Vector2

Gets the UI size, in logical units.

pub fn do_frame<A: UiBuilder>(&mut self, app: &mut A)

Builds and renders a UI frame, using the app easy_imgui::UiBuilder.

pub fn map_tex(ntex: Texture) -> TextureId

Maps an OpenGL texture to an ImGui texture.

pub fn unmap_tex(tex: TextureId) -> Option<Texture>

Gets an OpenGL texture from an ImGui texture.

pub fn delete_tex(tex: TextureId) -> Option<Texture>

Deletes an OpenGL texture from the texture map.

Returns the native texture, if any.

Trait Implementations

impl Drop for Renderer

fn drop(&mut self)

Executes the destructor for this type.