Struct imgui_vulkano_renderer::Renderer

pub struct Renderer { /* fields omitted */ }

Implementations

impl Renderer

pub fn init(
    ctx: &mut Context,
    device: Arc<Device>,
    queue: Arc<Queue>,
    format: Format
) -> Result<Renderer, RendererError>

Initialize the renderer object, including vertex buffers, ImGui font textures, and the Vulkan graphics pipeline.

---

ctx: the ImGui Context object

device: the Vulkano Device object for the device you want to render the UI on.

queue: the Vulkano Queue object for the queue the font atlas texture will be created on.

format: the Vulkano Format that the render pass will use when storing the frame in the target image.

pub fn draw_commands<I, P>(
    &mut self,
    cmd_buf_builder: &mut AutoCommandBufferBuilder<P>,
    queue: Arc<Queue>,
    target: I,
    draw_data: &DrawData
) -> Result<(), RendererError> where
    I: ImageViewAccess + Send + Sync + 'static, 

Appends the draw commands for the UI frame to an AutoCommandBufferBuilder.

---

cmd_buf_builder: An AutoCommandBufferBuilder from vulkano to add commands to

device: the Vulkano Device object for the device you want to render the UI on

queue: the Vulkano Queue object for buffer creation

target: the target image to render to

draw_data: the ImGui DrawData that each UI frame creates

pub fn reload_font_texture(
    &mut self,
    ctx: &mut Context,
    device: Arc<Device>,
    queue: Arc<Queue>
) -> Result<(), RendererError>

Update the ImGui font atlas texture.

---

ctx: the ImGui Context object

device: the Vulkano Device object for the device you want to render the UI on.

queue: the Vulkano Queue object for the queue the font atlas texture will be created on.

pub fn textures(&mut self) -> &mut Textures<Texture>

Get the texture library that the renderer uses