Crate imgui_rs_vulkan_renderer[−][src]
imgui-rs-vulkan-renderer
A Vulkan renderer for imgui-rs using Ash.
How it works
The renderer records drawing command to a command buffer supplied by the application. Here is a little breakdown of the features of this crate and how they work.
- Vertex/Index buffers
The renderer creates a vertex buffer and a index buffer that will be updated every time
Renderer::cmd_draw is called. If the vertex/index count is more than what the buffers can
actually hold then the buffers are resized (actually destroyed then re-created).
- Frames in flight
The renderer support having multiple frames in flight. You need to specify the number of frames during initialization of the renderer. The renderer manages one vertex and index buffer per frame.
- No draw call execution
The Renderer::cmd_draw only record commands to a command buffer supplied by the application. It does not submit anything to the gpu.
- Custom textures
The renderer supports custom textures. See Renderer::textures for details.
- Custom Vulkan allocators
Custom Vulkan allocators are not supported for the moment.
Integration
You can find an example of integration in the common module of the examples.
The RendererVkContext trait
You need to implement that trait that will be used to access Vulkan resources such as the instance and device.
Examples
You can run a set of examples by running the following command:
# If you want to enable validation layers
export VK_LAYER_PATH=$VULKAN_SDK/Bin
export VK_INSTANCE_LAYERS=VK_LAYER_KHRONOS_validation
# If you changed the shader code (you'll need glslangValidator on you PATH)
# There is also a PowerShell version (compile_shaders.ps1)
./compile_shaders.sh
# Run an example
cargo run --example <example>
# Example can be one of the following value:
# - color_button
# - custom_textures
# - hello_world
# - progress_bar
# - radio_button
# - test_drawing_channels_split
# - test_window_impl
# - test_window
Modules
| vulkan | Vulkan helpers. |
Structs
| Renderer | Vulkan renderer for imgui. |
Enums
| RendererError | Crates error type. |
Traits
| RendererVkContext | Trait providing access to the application's Vulkan context. |
Type Definitions
| RendererResult | Convenient return type for function that can return a |