Struct script::dom::webxr::xrsession::XRSession

#[repr(C)]
pub struct XRSession {

    eventtarget: EventTarget,
    blend_mode: XREnvironmentBlendMode,
    mode: XRSessionMode,
    visibility_state: Cell<XRVisibilityState>,
    viewer_space: MutNullableDom<XRSpace>,
    session: DomRefCell<Session>,
    frame_requested: Cell<bool>,
    pending_render_state: MutNullableDom<XRRenderState>,
    active_render_state: MutDom<XRRenderState>,
    inline_projection_matrix: DomRefCell<Transform3D<f32, Viewer, Display>>,
    next_raf_id: Cell<i32>,
    raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>,
    current_raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>,
    input_sources: Dom<XRInputSourceArray>,
    end_promises: DomRefCell<Vec<Rc<Promise>>>,
    ended: Cell<bool>,
    next_hit_test_id: Cell<HitTestId>,
    pending_hit_test_promises: DomRefCell<HashMapTracedValues<HitTestId, Rc<Promise>>>,
    outside_raf: Cell<bool>,
    input_frames: DomRefCell<HashMap<InputId, InputFrame>>,
    framerate: Cell<f32>,
    update_framerate_promise: DomRefCell<Option<Rc<Promise>>>,
    reference_spaces: DomRefCell<Vec<Dom<XRReferenceSpace>>>,
}

Fields

eventtarget: EventTarget

blend_mode: XREnvironmentBlendMode

mode: XRSessionMode

visibility_state: Cell<XRVisibilityState>

viewer_space: MutNullableDom<XRSpace>

session: DomRefCell<Session>

frame_requested: Cell<bool>

pending_render_state: MutNullableDom<XRRenderState>

active_render_state: MutDom<XRRenderState>

inline_projection_matrix: DomRefCell<Transform3D<f32, Viewer, Display>>

Cached projection matrix for inline sessions

next_raf_id: Cell<i32>

raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>

current_raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>

input_sources: Dom<XRInputSourceArray>

end_promises: DomRefCell<Vec<Rc<Promise>>>

ended: Cell<bool>

https://immersive-web.github.io/webxr/#ended

next_hit_test_id: Cell<HitTestId>

pending_hit_test_promises: DomRefCell<HashMapTracedValues<HitTestId, Rc<Promise>>>

outside_raf: Cell<bool>

Opaque framebuffers need to know the session is “outside of a requestAnimationFrame” https://immersive-web.github.io/webxr/#opaque-framebuffer

input_frames: DomRefCell<HashMap<InputId, InputFrame>>

framerate: Cell<f32>

update_framerate_promise: DomRefCell<Option<Rc<Promise>>>

reference_spaces: DomRefCell<Vec<Dom<XRReferenceSpace>>>

Implementations

impl XRSession

fn __assert_parent_type(&self)

impl XRSession

fn new_inherited( session: Session, render_state: &XRRenderState, input_sources: &XRInputSourceArray, mode: XRSessionMode, ) -> XRSession

pub fn new( global: &GlobalScope, session: Session, mode: XRSessionMode, frame_receiver: IpcReceiver<Frame>, ) -> Root<Dom<XRSession>>

pub fn with_session<R, F: FnOnce(&Session) -> R>(&self, with: F) -> R

pub fn is_ended(&self) -> bool

pub fn is_immersive(&self) -> bool

pub fn has_layers_feature(&self) -> bool

fn setup_raf_loop(&self, frame_receiver: IpcReceiver<Frame>)

pub fn is_outside_raf(&self) -> bool

fn attach_event_handler(&self)

pub fn setup_initial_inputs(&self)

fn event_callback(&self, event: XREvent, can_gc: CanGc)

fn raf_callback(&self, frame: Frame, time: CrossProcessInstant)

https://immersive-web.github.io/webxr/#xr-animation-frame

fn update_inline_projection_matrix(&self)

pub fn inline_view(&self) -> View<Viewer>

Constructs a View suitable for inline sessions using the inlineVerticalFieldOfView and canvas size

pub fn session_id(&self) -> SessionId

pub fn dirty_layers(&self)

fn layers_begin_frame(&self, frame: &XRFrame)

fn layers_end_frame(&self, frame: &XRFrame)

fn apply_frame_updates(&self, _frame: &XRFrame)

https://immersive-web.github.io/webxr/#xrframe-apply-frame-updates

fn handle_frame_event(&self, event: FrameUpdateEvent)

fn apply_nominal_framerate(&self, rate: f32, can_gc: CanGc)

https://www.w3.org/TR/webxr/#apply-the-nominal-frame-rate

Trait Implementations

impl Castable for XRSession

fn is<T>(&self) -> bool

where T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &T

where T: Castable, Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>

where T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for XRSession

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for XRSession

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::XRSessionBinding::XRSession_Binding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::webxr::xrsession::XRSession>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::webxr::xrsession::XRSession>>}

Function pointer to the general wrap function type

impl HasParent for XRSession

fn as_parent(&self) -> &EventTarget

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = EventTarget

impl IDLInterface for XRSession

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for XRSession

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for XRSession

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for XRSession

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJSValConvertible for XRSession

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for XRSession

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl XRSessionMethods<DomTypeHolder> for XRSession

fn UpdateRenderState( &self, init: &XRRenderStateInit, _: InRealm<'_>, ) -> Result<(), Error>

https://immersive-web.github.io/webxr/#dom-xrsession-updaterenderstate

fn RequestAnimationFrame(&self, callback: Rc<XRFrameRequestCallback>) -> i32

https://immersive-web.github.io/webxr/#dom-xrsession-requestanimationframe

fn CancelAnimationFrame(&self, frame: i32)

https://immersive-web.github.io/webxr/#dom-xrsession-cancelanimationframe

fn EnvironmentBlendMode(&self) -> XREnvironmentBlendMode

https://immersive-web.github.io/webxr/#dom-xrsession-environmentblendmode

fn VisibilityState(&self) -> XRVisibilityState

https://immersive-web.github.io/webxr/#dom-xrsession-visibilitystate

fn RequestReferenceSpace( &self, ty: XRReferenceSpaceType, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://immersive-web.github.io/webxr/#dom-xrsession-requestreferencespace

fn InputSources(&self) -> Root<Dom<XRInputSourceArray>>

https://immersive-web.github.io/webxr/#dom-xrsession-inputsources

fn End(&self, can_gc: CanGc) -> Rc<Promise>

https://immersive-web.github.io/webxr/#dom-xrsession-end

fn InteractionMode(&self) -> XRInteractionMode

https://www.w3.org/TR/webxr-ar-module-1/#dom-xrsession-interactionmode

fn GetFrameRate(&self) -> Option<Finite<f32>>

https://www.w3.org/TR/webxr/#dom-xrsession-framerate

fn GetSupportedFrameRates(&self, cx: JSContext) -> Option<Float32Array>

https://www.w3.org/TR/webxr/#dom-xrsession-supportedframerates

fn EnabledFeatures(&self, cx: JSContext, retval: MutableHandleValue<'_>)

https://www.w3.org/TR/webxr/#dom-xrsession-enabledfeatures

fn IsSystemKeyboardSupported(&self) -> bool

https://www.w3.org/TR/webxr/#dom-xrsession-issystemkeyboardsupported

fn UpdateTargetFrameRate( &self, rate: Finite<f32>, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://www.w3.org/TR/webxr/#dom-xrsession-updatetargetframerate

fn GetOnend(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnend(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnselect(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnselect(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnselectstart(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnselectstart(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnselectend(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnselectend(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnsqueeze(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnsqueeze(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnsqueezestart(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnsqueezestart(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnsqueezeend(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnsqueezeend(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnvisibilitychange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnvisibilitychange(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOninputsourceschange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOninputsourceschange(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnframeratechange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnframeratechange(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn RenderState(&self) -> Root<Dom<XRRenderState>>

fn RequestHitTestSource( &self, options: &XRHitTestOptionsInit, can_gc: CanGc, ) -> Rc<Promise>

impl DerivedFrom<EventTarget> for XRSession

impl Eq for XRSession