Enum rafx_api::RafxSwapchain

pub enum RafxSwapchain {
    Empty(RafxSwapchainEmpty),
}

A set of images that act as a "backbuffer" of a window.

Variants

Empty(RafxSwapchainEmpty)

Implementations

impl RafxSwapchain

pub fn image_count(&self) -> usize

Get the number of images in the swapchain. This is important to know because it indicates how many frames may be "in-flight" at a time - which affects how long a resource may be "in-use" after a command buffere referencing it has been submitted

pub fn format(&self) -> RafxFormat

Get the format of the images used in the swapchain

pub fn swapchain_def(&self) -> &RafxSwapchainDef

Return the metadata used to create the swapchain

pub fn acquire_next_image_fence(
    &mut self,
    fence: &RafxFence
) -> RafxResult<RafxSwapchainImage>

Acquire the next image. The given fence will be signaled when it is available

This is the same as acquire_next_image_semaphore except that it signals a fence.

pub fn acquire_next_image_semaphore(
    &mut self,
    semaphore: &RafxSemaphore
) -> RafxResult<RafxSwapchainImage>

Acquire the next image. The given semaphore will be signaled when it is available

This is the same as acquire_next_image_fence except that it signals a semaphore.

pub fn rebuild(&mut self, swapchain_def: &RafxSwapchainDef) -> RafxResult<()>

Rebuild the swapchain. This is most commonly called when a window is resized.

pub fn empty_swapchain(&self) -> Option<&RafxSwapchainEmpty>

Get the underlying metal API object. This provides access to any internally created metal objects.