[][src]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>[src]

pub unsafe fn from_raw(
    session: Session<G>,
    handle: Swapchain,
    flags: SwapchainCreateFlags
) -> Self
[src]

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[src]

Access the raw swapchain handle

pub fn instance(&self) -> &Instance[src]

Access the Instance self is descended from

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

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

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

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

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

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

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

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

Release the oldest acquired image

Safety

The swapchain image must have been successfully waited on before it is released.

Trait Implementations

impl<G: Graphics> Drop for Swapchain<G>[src]

Auto Trait Implementations

impl<G> Send for Swapchain<G> where
    G: Send

impl<G> Sync for Swapchain<G> where
    G: Sync

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf for SP where
    SS: SubsetOf<SP>,