[−][src]Struct openxr::FrameStream
Handle for managing frame presentation
This is a secondary interface to a Session
object that exposes only the frame wait/begin/end
operations. These are separated so that &mut self
receivers can be used to statically
guarantee that calls are synchronized as required by OpenXR, enabling a safe interface.
Example
A typical presentation loop body should look roughly as follows:
let state = frame_waiter.wait().unwrap(); let image = swapchain.acquire_image().unwrap(); swapchain.wait_image(openxr::Duration::INFINITE).unwrap(); frame_stream.begin().unwrap(); if state.should_render { // draw scene... } let (view_flags, views) = session .locate_views( openxr::ViewConfigurationType::PRIMARY_STEREO, state.predicted_display_time, world_space, ) .unwrap(); // set view matrices and submit to GPU... swapchain.release_image().unwrap(); frame_stream .end( state.predicted_display_time, openxr::EnvironmentBlendMode::OPAQUE, &[&openxr::CompositionLayerProjection::new() .space(world_space) .views(&[ openxr::CompositionLayerProjectionView::new() .pose(views[0].pose) .fov(views[0].fov) .sub_image( openxr::SwapchainSubImage::new() .swapchain(swapchain) .image_array_index(0) .image_rect(openxr::Rect2Di { offset: openxr::Offset2Di { x: 0, y: 0 }, extent: view_resolution[0], }), ), openxr::CompositionLayerProjectionView::new() .pose(views[1].pose) .fov(views[1].fov) .sub_image( openxr::SwapchainSubImage::new() .swapchain(swapchain) .image_array_index(1) .image_rect(openxr::Rect2Di { offset: openxr::Offset2Di { x: 0, y: 0 }, extent: view_resolution[1], }), ), ])], ) .unwrap();
Methods
impl<G: Graphics> FrameStream<G>
[src]
pub fn begin(&mut self) -> Result<()>
[src]
Indicate that graphics device work is beginning
pub fn end(
&mut self,
display_time: Time,
environment_blend_mode: EnvironmentBlendMode,
layers: &[&CompositionLayerBase<G>]
) -> Result<()>
[src]
&mut self,
display_time: Time,
environment_blend_mode: EnvironmentBlendMode,
layers: &[&CompositionLayerBase<G>]
) -> Result<()>
Indicate that all graphics work for the frame has been submitted
layers
is an array of references to any type of composition layer,
e.g. CompositionLayerProjection
.
Auto Trait Implementations
impl<G> Send for FrameStream<G> where
G: Send,
G: Send,
impl<G> Sync for FrameStream<G> where
G: Sync,
G: Sync,
impl<G> Unpin for FrameStream<G> where
G: Unpin,
G: Unpin,
impl<G> UnwindSafe for FrameStream<G> where
G: UnwindSafe,
G: UnwindSafe,
impl<G> RefUnwindSafe for FrameStream<G> where
G: RefUnwindSafe,
G: RefUnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,