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 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(
    &mut self,
    render_target: RenderTarget,
    paint_jobs: &[ClippedMesh],
    screen_descriptor: &ScreenDescriptor
) -> AutoCommandBuffer<StandardCommandPoolAlloc>

translate egui rendering request to vulkano AutoCommandBuffer

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

Update egui system texture You must call before every create_command_buffer

pub fn wait_texture_upload(&mut self)

waiting image upload done.

usually you don’t need to call .

this cause blocking but ensure no image glitch.

you must call before create command buffer

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

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

register vulkano image view as egui texture

Usable for render to image rectangle

pub fn init_vulkano_texture_with_dimensions(
    &mut self,
    dimensions: [u32; 2]
) -> Result<(TextureId, Arc<AttachmentImage>), InitRenderAreaError>

init render area with given dimensions.

image format is R8G8B8A8Srgb.

enabled image usage is below.

• sampled
• color_attachment
• transfer_destination

this is shortcut function for register_vulkano_texture

example usage

• model viewer
• video playback

pub fn recreate_vulkano_texture_with_dimensions(
    &mut self,
    texture_id: TextureId,
    dimensions: [u32; 2]
) -> Result<Arc<AttachmentImage>, RecreateErrors>

recreate vulkano texture.

usable for render target resize.

this function create descriptor set for image, so you do not have to call register_vulkano_texture

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.