Struct webxr_api::session::Session

pub struct Session {
    floor_transform: Option<RigidTransform3D<f32, Native, Floor>>,
    viewports: Viewports,
    sender: Sender<SessionMsg>,
    environment_blend_mode: EnvironmentBlendMode,
    initial_inputs: Vec<InputSource>,
    granted_features: Vec<String>,
    id: SessionId,
    supported_frame_rates: Vec<f32>,
}

An object that represents an XR session. This is owned by the content thread. https://www.w3.org/TR/webxr/#xrsession-interface

Fields

floor_transform: Option<RigidTransform3D<f32, Native, Floor>>

viewports: Viewports

sender: Sender<SessionMsg>

environment_blend_mode: EnvironmentBlendMode

initial_inputs: Vec<InputSource>

granted_features: Vec<String>

id: SessionId

supported_frame_rates: Vec<f32>

Implementations

impl Session

pub fn id(&self) -> SessionId

pub fn floor_transform(&self) -> Option<RigidTransform3D<f32, Native, Floor>>

pub fn reference_space_bounds(&self) -> Option<Vec<Point2D<f32, Floor>>>

pub fn initial_inputs(&self) -> &[InputSource]

pub fn environment_blend_mode(&self) -> EnvironmentBlendMode

pub fn viewports(&self) -> &[Rect<i32, Viewport>]

pub fn recommended_framebuffer_resolution( &self, ) -> Option<Size2D<i32, Viewport>>

A resolution large enough to contain all the viewports. https://immersive-web.github.io/webxr/#recommended-webgl-framebuffer-resolution

Returns None if the session is inline

pub fn create_layer( &self, context_id: ContextId, init: LayerInit, ) -> Result<LayerId, Error>

pub fn destroy_layer(&self, context_id: ContextId, layer_id: LayerId)

Destroy a layer

pub fn set_layers(&self, layers: Vec<(ContextId, LayerId)>)

pub fn start_render_loop(&mut self)

pub fn update_clip_planes(&mut self, near: f32, far: f32)

pub fn set_event_dest(&mut self, dest: Sender<Event>)

pub fn render_animation_frame(&mut self)

pub fn end_session(&mut self)

pub fn apply_event(&mut self, event: FrameUpdateEvent)

pub fn granted_features(&self) -> &[String]

pub fn request_hit_test(&self, source: HitTestSource)

pub fn cancel_hit_test(&self, id: HitTestId)

pub fn update_frame_rate(&mut self, rate: f32, sender: Sender<f32>)

pub fn supported_frame_rates(&self) -> &[f32]

Trait Implementations

impl<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Session

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.