Struct egui_winit_ash_integration::Integration

pub struct Integration<A: AllocatorTrait> { /* private fields */ }

egui integration with winit and ash.

Implementations

impl<A: AllocatorTrait> Integration<A>

pub fn new<T>(
    event_loop: &EventLoop<T>,
    physical_width: u32,
    physical_height: u32,
    scale_factor: f64,
    font_definitions: FontDefinitions,
    style: Style,
    device: Device,
    allocator: A,
    qfi: u32,
    queue: Queue,
    swapchain_loader: Swapchain,
    swapchain: SwapchainKHR,
    surface_format: SurfaceFormatKHR
) -> Self

Create an instance of the integration.

pub fn handle_event(&mut self, winit_event: &WindowEvent<'_>) -> EventResponse

handling winit event.

pub fn begin_frame(&mut self, window: &Window)

begin frame.

pub fn end_frame(&mut self, window: &Window) -> FullOutput

end frame.

pub fn context(&self) -> Context

Get egui::Context.

pub fn paint(
    &mut self,
    command_buffer: CommandBuffer,
    swapchain_image_index: usize,
    clipped_meshes: Vec<ClippedPrimitive>,
    textures_delta: TexturesDelta
)

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.