Struct vulkano::swapchain::SwapchainPresentInfo

pub struct SwapchainPresentInfo {
    pub swapchain: Arc<Swapchain>,
    pub image_index: u32,
    pub present_id: Option<NonZeroU64>,
    pub present_mode: Option<PresentMode>,
    pub present_regions: Vec<RectangleLayer>,
    pub _ne: NonExhaustive,
}

Parameters for a single present operation on a swapchain.

Fields

swapchain: Arc<Swapchain>

The swapchain to present to.

There is no default value.

image_index: u32

The index of the swapchain image to present to.

The image must have been acquired first; this is the index that acquire_next_image returns.

There is no default value.

present_id: Option<NonZeroU64>

An id used to identify this present operation.

If present_id is Some, the present_id feature must be enabled on the device. The id must be greater than any id previously used for swapchain. If a swapchain is recreated, this resets.

The default value is None.

present_mode: Option<PresentMode>

The new present mode to use for presenting. This mode will be used for the current present, and any future presents where this value is None.

If this is not None, then the provided present mode must be one of the present modes specified with present_modes when creating the swapchain.

The default value is None.

present_regions: Vec<RectangleLayer>

An optimization hint to the implementation, that only some parts of the swapchain image are going to be updated by the present operation.

If present_regions is not empty, then the khr_incremental_present extension must be enabled on the device. The implementation will update the provided regions of the swapchain image, and may ignore the other areas. However, as this is just a hint, the Vulkan implementation is free to ignore the regions altogether and update everything.

If present_regions is empty, that means that all of the swapchain image must be updated.

The default value is empty.

_ne: NonExhaustive

Implementations

impl SwapchainPresentInfo

pub fn swapchain_image_index( swapchain: Arc<Swapchain>, image_index: u32 ) -> Self

Returns a SwapchainPresentInfo with the specified swapchain and image_index.

Trait Implementations

impl Clone for SwapchainPresentInfo

fn clone(&self) -> SwapchainPresentInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SwapchainPresentInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.