Struct egui_vulkano_backend::EguiVulkanoRenderPass

pub struct EguiVulkanoRenderPass { /* fields omitted */ }

egui rendering command builder

Implementations

impl EguiVulkanoRenderPass

pub fn new(
    device: Arc<Device>,
    queue: Arc<Queue>,
    render_target_format: Format
) -> Self

create command builder

if render target format incompatible with SwapChain format may cause color glitch

pub fn create_frame_buffers<Wnd: Send + Sync + 'static>(
    &mut self,
    image_views: &[Arc<SwapchainImage<Wnd>>]
)

you must call when SwapChain or render target resize or before first create_command_buffer call

pub fn present_to_screen<Wnd>(
    &self,
    command: AutoCommandBuffer<StandardCommandPoolAlloc>,
    acquire_future: SwapchainAcquireFuture<Wnd>
)

execute command and present to screen

pub fn create_command_buffer(
    &self,
    color_attachment: Option<Arc<dyn ImageViewAccess + Send + Sync>>,
    image_num: Option<usize>,
    paint_jobs: &[ClippedMesh],
    screen_descriptor: &ScreenDescriptor
) -> AutoCommandBuffer<StandardCommandPoolAlloc>

translate egui rendering request to vulkano AutoCommandBuffer

color attachment is render target.

If color_attachment is none then render to self framebuffer and image num must Some

If color attachment is some then render to any image e.g. AttachmentImage StorageImage

pub fn upload_egui_texture(&mut self, texture: &Texture)

Update egui system texture You must call before every create_command_buffer

pub fn upload_pending_textures(&mut self)

egui use lazy texture allocating so you must call before every create_command_buffer.

pub fn set_user_texture(
    &mut self,
    id: TextureId,
    size: (usize, usize),
    srgba_pixels: &[Color32]
)

pub fn vulkano_texture_as_egui(
    &mut self,
    image_view: Arc<dyn ImageViewAccess + Sync + Send>
) -> TextureId

mark vulkano image view as egui texture id enables fast and easy off-screen rendering

Trait Implementations

impl TextureAllocator for EguiVulkanoRenderPass

fn alloc_srgba_premultiplied(
    &mut self,
    size: (usize, usize),
    srgba_pixels: &[Color32]
) -> TextureId

Allocate a new user texture.

fn free(&mut self, id: TextureId)

Free the given texture.