Struct openxr::Swapchain

pub struct Swapchain<G: Graphics> { /* fields omitted */ }

A set of images to be rendered to using a particular graphics API G

Methods

impl<G: Graphics> Swapchain<G>

pub unsafe fn from_raw(session: Session<G>, handle: Swapchain) -> Self

Take ownership of an existing swapchain handle

Safety

handle must be a valid swapchain handle associated with session and created with flags.

pub fn as_raw(&self) -> Swapchain

Access the raw swapchain handle

pub fn instance(&self) -> &Instance

Access the Instance self is descended from

pub fn set_name(&mut self, name: &str) -> Result<()>

Set the debug name of this Swapchain, if XR_EXT_debug_utils is loaded

pub fn enumerate_images(&self) -> Result<Vec<G::SwapchainImage>>

pub fn acquire_image(&mut self) -> Result<u32>

Determine the index of the next image to render to in the swapchain image array

pub fn wait_image(&mut self, timeout: Duration) -> Result<()>

Wait for the compositor to finish reading from the oldest unwaited acquired image

pub fn release_image(&mut self) -> Result<()>

Release the oldest acquired image

Trait Implementations

impl<G: Graphics> Drop for Swapchain<G>

fn drop(&mut self)

Executes the destructor for this type.