Struct VulkanoWindowRenderer

pub struct VulkanoWindowRenderer { /* private fields */ }

A window renderer struct holding the winit window surface and functionality for organizing your render between frames.

Begin rendering with VulkanoWindowRenderer::acquire and finish with VulkanoWindowRenderer::present. Between those, you should execute your command buffers.

The intended usage of this struct is through crate::window::VulkanoWindows.

Implementations

impl VulkanoWindowRenderer

pub fn new( vulkano_context: &VulkanoContext, window: Window, descriptor: &WindowDescriptor, swapchain_create_info_modify: fn(&mut SwapchainCreateInfo), ) -> VulkanoWindowRenderer

Creates a new VulkanoWindowRenderer which is used to orchestrate your rendering with Vulkano. Pass WindowDescriptor and optionally a function modifying the SwapchainCreateInfo parameters.

pub fn set_present_mode(&mut self, present_mode: PresentMode)

Set window renderer present mode. This triggers a swapchain recreation.

pub fn swapchain_format(&self) -> Format

Return swapchain image format.

pub fn image_index(&self) -> u32

Returns the index of last swapchain image that is the next render target.

pub fn graphics_queue(&self) -> Arc<Queue>

Graphics queue of this window. You also can access this through VulkanoContext.

pub fn compute_queue(&self) -> Arc<Queue>

Compute queue of this window. You can also access this through VulkanoContext.

pub fn surface(&self) -> Arc<Surface>

Render target surface.

pub fn window(&self) -> &Window

Winit window (you can manipulate the window through this).

pub fn window_size(&self) -> [f32; 2]

Size of the physical window.

pub fn swapchain_image_size(&self) -> [u32; 2]

Size of the final swapchain image (surface).

pub fn swapchain_image_view(&self) -> Arc<ImageView>

Return the current swapchain image view.

pub fn resolution(&self) -> [f32; 2]

Return scale factor accounted window size.

pub fn aspect_ratio(&self) -> f32

pub fn swapchain_image_views(&self) -> &[Arc<ImageView>]

Returns a reference to the swapchain image views.

pub fn resize(&mut self)

Resize swapchain and camera view images at the beginning of next frame based on window size.

pub fn add_additional_image_view( &mut self, key: usize, format: Format, usage: ImageUsage, )

Add interim image view that resizes with window.

pub fn get_additional_image_view(&mut self, key: usize) -> Arc<ImageView>

Get additional image view by key.

pub fn remove_additional_image_view(&mut self, key: usize)

Remove additional image by key.

pub fn acquire( &mut self, timeout: Option<Duration>, on_recreate_swapchain: impl FnOnce(&[Arc<ImageView>]), ) -> Result<Box<dyn GpuFuture>, VulkanError>

Begin your rendering by calling acquire. ‘on_recreate_swapchain’ is called when the swapchain gets recreated, due to being resized, suboptimal, or changing the present mode. Returns a GpuFuture representing the time after which the swapchain image has been acquired and previous frame ended. Execute your command buffers after calling this function and finish rendering by calling VulkanoWindowRenderer::present.

pub fn present(&mut self, after_future: Box<dyn GpuFuture>, wait_future: bool)

Finishes rendering by presenting the swapchain. Pass your last future as an input to this function.

Depending on your implementation, you may want to wait on your future. For example, a compute shader dispatch using an image that’s being later drawn should probably be waited on.