Struct egui_winit_ash_vk_mem::Integration

pub struct Integration { /* fields omitted */ }

egui integration with winit, ash and vk_mem.

Implementations

impl Integration

pub fn new(
    physical_width: u32,
    physical_height: u32,
    scale_factor: f64,
    font_definitions: FontDefinitions,
    style: Style,
    device: Device,
    allocator: Arc<Allocator>,
    swapchain_loader: Swapchain,
    swapchain: SwapchainKHR,
    surface_format: SurfaceFormatKHR
) -> Self

Create an instance of the integration.

pub fn handle_event<T>(&mut self, winit_event: &Event<'_, T>)

handling winit event.

pub fn begin_frame(&mut self)

begin frame.

pub fn end_frame(&mut self, window: &mut Window) -> (Output, Vec<ClippedShape>)

end frame.

pub fn context(&self) -> CtxRef

Get egui::CtxRef.

pub fn paint(
    &mut self,
    command_buffer: CommandBuffer,
    index: usize,
    clipped_meshes: Vec<ClippedMesh>
)

Record paint commands.

pub fn update_swapchain(
    &mut self,
    physical_width: u32,
    physical_height: u32,
    swapchain: SwapchainKHR,
    surface_format: SurfaceFormatKHR
)

Update swapchain.

pub fn register_user_texture(
    &mut self,
    image_view: ImageView,
    sampler: Sampler
) -> TextureId

Registering user texture.

Pass the Vulkan ImageView and Sampler. image_view’s image layout must be SHADER_READ_ONLY_OPTIMAL.

UserTexture needs to be unregistered when it is no longer needed.

Example

cargo run --example user_texture

The example for user texture is in examples directory

pub fn unregister_user_texture(&mut self, texture_id: TextureId)

Unregister user texture.

The internal texture (egui::TextureId::Egui) cannot be unregistered.

pub unsafe fn destroy(&mut self)

destroy vk objects.

Unsafe

This method release vk objects memory that is not managed by Rust.