Struct openxr::Session

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

A rendering session using a particular graphics API G

Methods

impl<G: Graphics> Session<G>

pub unsafe fn from_raw(instance: Instance, handle: Session) -> Self

Take ownership of an existing session handle

Safety

handle must be a valid session handle associated with instance.

pub fn as_raw(&self) -> Session

Access the raw session handle

pub fn instance(&self) -> &Instance

Access the Instance self is descended from

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

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

pub fn begin(&self, ty: ViewConfigurationType) -> Result<Result>

Request that the runtime show the application's rendered output to the user

pub fn end(&self) -> Result<Result>

Signals that the application no longer wishes to display rendered output, read input state, or control haptic events

pub fn reference_space_bounds_rect(
    &self,
    ty: ReferenceSpaceType
) -> Result<Option<Extent2Df>>

pub fn enumerate_reference_spaces(&self) -> Result<Vec<ReferenceSpaceType>>

Enumerates the set of reference space types supported for this session

Constant for the lifetime of the session.

pub fn create_reference_space(
    &self,
    reference_space_type: ReferenceSpaceType,
    pose_in_reference_space: Posef
) -> Result<Space>

Creates a Space based on a chosen reference space

pub fn enumerate_swapchain_formats(&self) -> Result<Vec<G::Format>>

Enumerate texture formats supported by the current session

The type of formats returned are dependent on the graphics API for which the session was created.

pub fn create_swapchain(
    &self,
    info: &SwapchainCreateInfo<G>
) -> Result<Swapchain<G>>

pub fn locate_views(
    &self,
    display_time: Time,
    space: &Space
) -> Result<(ViewStateFlags, Vec<View>)>

Returns the view and projection info for a particular display time

pub unsafe fn wait_frame(&self) -> Result<FrameState>

Block until rendering should begin

Safety

Must be externally synchronized, and must not be called on Headless sessions.

pub unsafe fn begin_frame(&self) -> Result<Result>

Indicate that graphics device work is beginning

Safety

Must be externally synchronized with respect to both itself and end_frame.

pub unsafe fn end_frame(
    &self,
    display_time: Time,
    environment_blend_mode: EnvironmentBlendMode,
    layers: &[&CompositionLayerBase<G>]
) -> Result<()>

Indicate that all graphics work for the frame has been submitted

Safety

Must only be called after a successful call to begin_frame, and be externally synchronized with respect to both itself andbegin_frame`.

pub fn create_action_set(
    &self,
    name: &str,
    localized_name: &str,
    priority: u32
) -> Result<ActionSet>

Allocate a new ActionSet

pub fn set_interaction_profile_suggested_bindings(
    &self,
    interaction_profile: Path,
    bindings: &[Binding]
) -> Result<()>

pub fn current_interaction_profile(
    &self,
    top_level_user_path: Path
) -> Result<Path>

Get the suggested interaction profile in use for a top level user path

May be NULL.

pub fn sync_action_data(&self, action_sets: &[ActiveActionSet]) -> Result<()>

Designate active input actions and update their states

pub fn input_source_localized_name(
    &self,
    source: Path,
    flags: InputSourceLocalizedNameFlags
) -> Result<String>

Returns a string for the input source in the current system locale

Trait Implementations

impl<G: Graphics> Clone for Session<G>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.