script/dom/webxr/
xrsession.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::cell::Cell;
6use std::collections::HashMap;
7use std::f64::consts::{FRAC_PI_2, PI};
8use std::rc::Rc;
9use std::{mem, ptr};
10
11use script_bindings::reflector::reflect_weak_referenceable_dom_object;
12use servo_base::cross_process_instant::CrossProcessInstant;
13use dom_struct::dom_struct;
14use js::context::JSContext;
15use js::realm::CurrentRealm;
16use euclid::{RigidTransform3D, Transform3D, Vector3D};
17use ipc_channel::ipc::IpcReceiver;
18use ipc_channel::router::ROUTER;
19use js::jsapi::JSObject;
20use js::rust::MutableHandleValue;
21use js::typedarray::HeapFloat32Array;
22use profile_traits::generic_callback::GenericCallback as ProfileGenericCallback;
23use rustc_hash::FxBuildHasher;
24use script_bindings::trace::RootedTraceableBox;
25use stylo_atoms::Atom;
26use webxr_api::{
27    self, ApiSpace, ContextId as WebXRContextId, Display, EntityTypes, EnvironmentBlendMode,
28    Event as XREvent, Frame, FrameUpdateEvent, HitTestId, HitTestSource, InputFrame, InputId, Ray,
29    SelectEvent, SelectKind, Session, SessionId, View, Viewer, Visibility, util,
30};
31
32use crate::conversions::Convert;
33use crate::canvas_context::CanvasContext;
34use crate::dom::bindings::trace::HashMapTracedValues;
35use crate::dom::bindings::buffer_source::create_buffer_source;
36use crate::dom::bindings::callback::ExceptionHandling;
37use script_bindings::cell::DomRefCell;
38use crate::dom::bindings::codegen::Bindings::NavigatorBinding::Navigator_Binding::NavigatorMethods;
39use crate::dom::bindings::codegen::Bindings::WindowBinding::Window_Binding::WindowMethods;
40use crate::dom::bindings::codegen::Bindings::XRHitTestSourceBinding::{
41    XRHitTestOptionsInit, XRHitTestTrackableType,
42};
43use crate::dom::bindings::codegen::Bindings::XRInputSourceArrayBinding::XRInputSourceArray_Binding::XRInputSourceArrayMethods;
44use crate::dom::bindings::codegen::Bindings::XRReferenceSpaceBinding::XRReferenceSpaceType;
45use crate::dom::bindings::codegen::Bindings::XRRenderStateBinding::{
46    XRRenderStateInit, XRRenderStateMethods,
47};
48use crate::dom::bindings::codegen::Bindings::XRSessionBinding::{
49    XREnvironmentBlendMode, XRFrameRequestCallback, XRInteractionMode, XRSessionMethods,
50    XRVisibilityState,
51};
52use crate::dom::bindings::codegen::Bindings::XRSystemBinding::XRSessionMode;
53use crate::dom::bindings::error::{Error, ErrorResult};
54use crate::dom::bindings::inheritance::Castable;
55use crate::dom::bindings::num::Finite;
56use crate::dom::bindings::refcounted::Trusted;
57use crate::dom::bindings::reflector::{DomGlobal};
58use crate::dom::bindings::root::{Dom, DomRoot, MutDom, MutNullableDom};
59use crate::dom::bindings::utils::to_frozen_array;
60use crate::dom::event::Event;
61use crate::dom::eventtarget::EventTarget;
62use crate::dom::promise::Promise;
63use crate::dom::window::Window;
64use crate::dom::xrboundedreferencespace::XRBoundedReferenceSpace;
65use crate::dom::xrframe::XRFrame;
66use crate::dom::xrhittestsource::XRHitTestSource;
67use crate::dom::xrinputsourcearray::XRInputSourceArray;
68use crate::dom::xrinputsourceevent::XRInputSourceEvent;
69use crate::dom::xrreferencespace::XRReferenceSpace;
70use crate::dom::xrreferencespaceevent::XRReferenceSpaceEvent;
71use crate::dom::xrrenderstate::XRRenderState;
72use crate::dom::xrrigidtransform::XRRigidTransform;
73use crate::dom::xrsessionevent::XRSessionEvent;
74use crate::dom::xrspace::XRSpace;
75
76#[dom_struct]
77pub(crate) struct XRSession {
78    eventtarget: EventTarget,
79    blend_mode: XREnvironmentBlendMode,
80    mode: XRSessionMode,
81    visibility_state: Cell<XRVisibilityState>,
82    viewer_space: MutNullableDom<XRSpace>,
83    #[no_trace]
84    session: DomRefCell<Session>,
85    frame_requested: Cell<bool>,
86    pending_render_state: MutNullableDom<XRRenderState>,
87    active_render_state: MutDom<XRRenderState>,
88    /// Cached projection matrix for inline sessions
89    #[no_trace]
90    inline_projection_matrix: DomRefCell<Transform3D<f32, Viewer, Display>>,
91
92    next_raf_id: Cell<i32>,
93    #[ignore_malloc_size_of = "closures are hard"]
94    raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>,
95    #[ignore_malloc_size_of = "closures are hard"]
96    current_raf_callback_list: DomRefCell<Vec<(i32, Option<Rc<XRFrameRequestCallback>>)>>,
97    input_sources: Dom<XRInputSourceArray>,
98    // Any promises from calling end()
99    #[conditional_malloc_size_of]
100    end_promises: DomRefCell<Vec<Rc<Promise>>>,
101    /// <https://immersive-web.github.io/webxr/#ended>
102    ended: Cell<bool>,
103    #[no_trace]
104    next_hit_test_id: Cell<HitTestId>,
105    #[ignore_malloc_size_of = "Promise"]
106    pending_hit_test_promises:
107        DomRefCell<HashMapTracedValues<HitTestId, Rc<Promise>, FxBuildHasher>>,
108    /// Opaque framebuffers need to know the session is "outside of a requestAnimationFrame"
109    /// <https://immersive-web.github.io/webxr/#opaque-framebuffer>
110    outside_raf: Cell<bool>,
111    #[no_trace]
112    input_frames: DomRefCell<HashMap<InputId, InputFrame>>,
113    framerate: Cell<f32>,
114    #[conditional_malloc_size_of]
115    update_framerate_promise: DomRefCell<Option<Rc<Promise>>>,
116    reference_spaces: DomRefCell<Vec<Dom<XRReferenceSpace>>>,
117}
118
119impl XRSession {
120    fn new_inherited(
121        session: Session,
122        render_state: &XRRenderState,
123        input_sources: &XRInputSourceArray,
124        mode: XRSessionMode,
125    ) -> XRSession {
126        XRSession {
127            eventtarget: EventTarget::new_inherited(),
128            blend_mode: session.environment_blend_mode().convert(),
129            mode,
130            visibility_state: Cell::new(XRVisibilityState::Visible),
131            viewer_space: Default::default(),
132            session: DomRefCell::new(session),
133            frame_requested: Cell::new(false),
134            pending_render_state: MutNullableDom::new(None),
135            active_render_state: MutDom::new(render_state),
136            inline_projection_matrix: Default::default(),
137
138            next_raf_id: Cell::new(0),
139            raf_callback_list: DomRefCell::new(vec![]),
140            current_raf_callback_list: DomRefCell::new(vec![]),
141            input_sources: Dom::from_ref(input_sources),
142            end_promises: DomRefCell::new(vec![]),
143            ended: Cell::new(false),
144            next_hit_test_id: Cell::new(HitTestId(0)),
145            pending_hit_test_promises: DomRefCell::new(HashMapTracedValues::new_fx()),
146            outside_raf: Cell::new(true),
147            input_frames: DomRefCell::new(HashMap::new()),
148            framerate: Cell::new(0.0),
149            update_framerate_promise: DomRefCell::new(None),
150            reference_spaces: DomRefCell::new(Vec::new()),
151        }
152    }
153
154    pub(crate) fn new(
155        cx: &mut JSContext,
156        window: &Window,
157        session: Session,
158        mode: XRSessionMode,
159        frame_receiver: IpcReceiver<Frame>,
160    ) -> DomRoot<XRSession> {
161        let ivfov = if mode == XRSessionMode::Inline {
162            Some(FRAC_PI_2)
163        } else {
164            None
165        };
166        let render_state = XRRenderState::new(cx, window, 0.1, 1000.0, ivfov, None, Vec::new());
167        let input_sources = XRInputSourceArray::new(cx, window);
168        let ret = reflect_weak_referenceable_dom_object(
169            cx,
170            Rc::new(XRSession::new_inherited(
171                session,
172                &render_state,
173                &input_sources,
174                mode,
175            )),
176            window,
177        );
178        ret.attach_event_handler();
179        ret.setup_raf_loop(frame_receiver);
180        ret
181    }
182
183    pub(crate) fn with_session<R, F: FnOnce(&Session) -> R>(&self, with: F) -> R {
184        let session = self.session.borrow();
185        with(&session)
186    }
187
188    pub(crate) fn is_ended(&self) -> bool {
189        self.ended.get()
190    }
191
192    pub(crate) fn is_immersive(&self) -> bool {
193        self.mode != XRSessionMode::Inline
194    }
195
196    // https://immersive-web.github.io/layers/#feature-descriptor-layers
197    pub(crate) fn has_layers_feature(&self) -> bool {
198        // We do not support creating layers other than projection layers
199        // https://github.com/servo/servo/issues/27493
200        false
201    }
202
203    fn setup_raf_loop(&self, frame_receiver: IpcReceiver<Frame>) {
204        let this = Trusted::new(self);
205        let global = self.global();
206        let task_source = global
207            .task_manager()
208            .dom_manipulation_task_source()
209            .to_sendable();
210        ROUTER.add_typed_route(
211            frame_receiver,
212            Box::new(move |message| {
213                let frame: Frame = message.unwrap();
214                let time = CrossProcessInstant::now();
215                let this = this.clone();
216                task_source.queue(task!(xr_raf_callback: move |cx| {
217                    this.root().raf_callback(cx, frame, time);
218                }));
219            }),
220        );
221
222        self.session.borrow_mut().start_render_loop();
223    }
224
225    pub(crate) fn is_outside_raf(&self) -> bool {
226        self.outside_raf.get()
227    }
228
229    fn attach_event_handler(&self) {
230        let this = Trusted::new(self);
231        let global = self.global();
232        let task_source = global
233            .task_manager()
234            .dom_manipulation_task_source()
235            .to_sendable();
236        let callback =
237            ProfileGenericCallback::new(global.time_profiler_chan().clone(), move |message| {
238                let this = this.clone();
239                task_source.queue(task!(xr_event_callback: move |cx| {
240                    this.root().event_callback(cx, message.unwrap());
241                }))
242            })
243            .expect("Could not create callback");
244
245        // request animation frame
246        self.session.borrow_mut().set_event_dest(callback);
247    }
248
249    // Must be called after the promise for session creation is resolved
250    // https://github.com/immersive-web/webxr/issues/961
251    //
252    // This enables content that assumes all input sources are accompanied
253    // by an inputsourceschange event to work properly. Without
254    pub(crate) fn setup_initial_inputs(&self) {
255        let initial_inputs = self.session.borrow().initial_inputs().to_owned();
256
257        if initial_inputs.is_empty() {
258            // do not fire an empty event
259            return;
260        }
261
262        let this = Trusted::new(self);
263        // Queue a task so that it runs after resolve()'s microtasks complete
264        // so that content has a chance to attach a listener for inputsourceschange
265        self.global()
266            .task_manager()
267            .dom_manipulation_task_source()
268            .queue(task!(session_initial_inputs: move |cx| {
269                let this = this.root();
270                this.input_sources.add_input_sources(cx, &this, &initial_inputs);
271            }));
272    }
273
274    fn event_callback(&self, cx: &mut JSContext, event: XREvent) {
275        match event {
276            XREvent::SessionEnd => {
277                // https://immersive-web.github.io/webxr/#shut-down-the-session
278                // Step 2
279                self.ended.set(true);
280                // Step 3-4
281                self.global()
282                    .as_window()
283                    .Navigator(cx)
284                    .Xr(cx)
285                    .end_session(self);
286                // Step 5: We currently do not have any such promises
287                // Step 6 is happening n the XR session
288                // https://immersive-web.github.io/webxr/#dom-xrsession-end step 3
289                for promise in self.end_promises.borrow_mut().drain(..) {
290                    promise.resolve_native(cx, &());
291                }
292                // Step 7
293                let event = XRSessionEvent::new(
294                    cx,
295                    self.global().as_window(),
296                    atom!("end"),
297                    false,
298                    false,
299                    self,
300                );
301                event.upcast::<Event>().fire(cx, self.upcast());
302            },
303            XREvent::Select(input, kind, ty, frame) => {
304                use stylo_atoms::Atom;
305                const START_ATOMS: [Atom; 2] = [atom!("selectstart"), atom!("squeezestart")];
306                const EVENT_ATOMS: [Atom; 2] = [atom!("select"), atom!("squeeze")];
307                const END_ATOMS: [Atom; 2] = [atom!("selectend"), atom!("squeezeend")];
308
309                // https://immersive-web.github.io/webxr/#primary-action
310                let source = self.input_sources.find(input);
311                let atom_index = if kind == SelectKind::Squeeze { 1 } else { 0 };
312                if let Some(source) = source {
313                    let frame = XRFrame::new(cx, self.global().as_window(), self, frame);
314                    frame.set_active(true);
315                    if ty == SelectEvent::Start {
316                        let event = XRInputSourceEvent::new(
317                            cx,
318                            self.global().as_window(),
319                            START_ATOMS[atom_index].clone(),
320                            false,
321                            false,
322                            &frame,
323                            &source,
324                        );
325                        event.upcast::<Event>().fire(cx, self.upcast());
326                    } else {
327                        if ty == SelectEvent::Select {
328                            let event = XRInputSourceEvent::new(
329                                cx,
330                                self.global().as_window(),
331                                EVENT_ATOMS[atom_index].clone(),
332                                false,
333                                false,
334                                &frame,
335                                &source,
336                            );
337                            event.upcast::<Event>().fire(cx, self.upcast());
338                        }
339                        let event = XRInputSourceEvent::new(
340                            cx,
341                            self.global().as_window(),
342                            END_ATOMS[atom_index].clone(),
343                            false,
344                            false,
345                            &frame,
346                            &source,
347                        );
348                        event.upcast::<Event>().fire(cx, self.upcast());
349                    }
350                    frame.set_active(false);
351                }
352            },
353            XREvent::VisibilityChange(v) => {
354                let v = match v {
355                    Visibility::Visible => XRVisibilityState::Visible,
356                    Visibility::VisibleBlurred => XRVisibilityState::Visible_blurred,
357                    Visibility::Hidden => XRVisibilityState::Hidden,
358                };
359                self.visibility_state.set(v);
360                let event = XRSessionEvent::new(
361                    cx,
362                    self.global().as_window(),
363                    atom!("visibilitychange"),
364                    false,
365                    false,
366                    self,
367                );
368                event.upcast::<Event>().fire(cx, self.upcast());
369                // The page may be visible again, dirty the layers
370                // This also wakes up the event loop if necessary
371                self.dirty_layers();
372            },
373            XREvent::AddInput(info) => {
374                self.input_sources.add_input_sources(cx, self, &[info]);
375            },
376            XREvent::RemoveInput(id) => {
377                self.input_sources.remove_input_source(cx, self, id);
378            },
379            XREvent::UpdateInput(id, source) => {
380                self.input_sources
381                    .add_remove_input_source(cx, self, id, source);
382            },
383            XREvent::InputChanged(id, frame) => {
384                self.input_frames.borrow_mut().insert(id, frame);
385            },
386            XREvent::ReferenceSpaceChanged(base_space, transform) => {
387                self.reference_spaces
388                    .borrow()
389                    .iter()
390                    .filter(|space| {
391                        let base = match space.ty() {
392                            XRReferenceSpaceType::Local => webxr_api::BaseSpace::Local,
393                            XRReferenceSpaceType::Viewer => webxr_api::BaseSpace::Viewer,
394                            XRReferenceSpaceType::Local_floor => webxr_api::BaseSpace::Floor,
395                            XRReferenceSpaceType::Bounded_floor => {
396                                webxr_api::BaseSpace::BoundedFloor
397                            },
398                            _ => panic!("unsupported reference space found"),
399                        };
400                        base == base_space
401                    })
402                    .for_each(|space| {
403                        let offset =
404                            XRRigidTransform::new(cx, self.global().as_window(), transform);
405                        let event = XRReferenceSpaceEvent::new(
406                            cx,
407                            self.global().as_window(),
408                            atom!("reset"),
409                            false,
410                            false,
411                            space,
412                            Some(&*offset),
413                        );
414                        event.upcast::<Event>().fire(cx, space.upcast());
415                    });
416            },
417        }
418    }
419
420    /// <https://immersive-web.github.io/webxr/#xr-animation-frame>
421    fn raf_callback(&self, cx: &mut JSContext, mut frame: Frame, time: CrossProcessInstant) {
422        debug!("WebXR RAF callback {:?}", frame);
423
424        // Step 1-2 happen in the xebxr device thread
425
426        // Step 3
427        if let Some(pending) = self.pending_render_state.take() {
428            // https://immersive-web.github.io/webxr/#apply-the-pending-render-state
429            // (Steps 1-4 are implicit)
430            // Step 5
431            self.active_render_state.set(&pending);
432            // Step 6-7: XXXManishearth handle inlineVerticalFieldOfView
433
434            if !self.is_immersive() {
435                self.update_inline_projection_matrix()
436            }
437        }
438
439        // TODO: how does this fit the webxr spec?
440        for event in frame.events.drain(..) {
441            self.handle_frame_event(cx, event);
442        }
443
444        // Step 4
445        // TODO: what should this check be?
446        // This is checking that the new render state has the same
447        // layers as the frame.
448        // Related to https://github.com/immersive-web/webxr/issues/1051
449        if !self
450            .active_render_state
451            .get()
452            .has_sub_images(&frame.sub_images[..])
453        {
454            // If the frame has different layers than the render state,
455            // we just return early, drawing a blank frame.
456            // This can result in flickering when the render state is changed.
457            // TODO: it would be better to not render anything until the next frame.
458            warn!("Rendering blank XR frame");
459            self.session.borrow_mut().render_animation_frame();
460            return;
461        }
462
463        // Step 5: XXXManishearth handle inline session
464
465        // Step 6-7
466        {
467            let mut current = self.current_raf_callback_list.borrow_mut();
468            assert!(current.is_empty());
469            mem::swap(&mut *self.raf_callback_list.borrow_mut(), &mut current);
470        }
471
472        let time = self
473            .global()
474            .performance(cx)
475            .to_dom_high_res_time_stamp(time);
476        let frame = XRFrame::new(cx, self.global().as_window(), self, frame);
477
478        // Step 8-9
479        frame.set_active(true);
480        frame.set_animation_frame(true);
481
482        // Step 10
483        self.apply_frame_updates(&frame);
484
485        // TODO: how does this fit with the webxr and xr layers specs?
486        self.layers_begin_frame(cx, &frame);
487
488        // Step 11-12
489        self.outside_raf.set(false);
490        let len = self.current_raf_callback_list.borrow().len();
491        for i in 0..len {
492            let callback = self.current_raf_callback_list.borrow()[i].1.clone();
493            if let Some(callback) = callback {
494                let _ = callback.Call__(cx, time, &frame, ExceptionHandling::Report);
495            }
496        }
497        self.outside_raf.set(true);
498        *self.current_raf_callback_list.borrow_mut() = vec![];
499
500        // TODO: how does this fit with the webxr and xr layers specs?
501        self.layers_end_frame(&frame);
502
503        // Step 13
504        frame.set_active(false);
505
506        // TODO: how does this fit the webxr spec?
507        self.session.borrow_mut().render_animation_frame();
508    }
509
510    fn update_inline_projection_matrix(&self) {
511        debug_assert!(!self.is_immersive());
512        let render_state = self.active_render_state.get();
513        let size = if let Some(base) = render_state.GetBaseLayer() {
514            base.size()
515        } else {
516            return;
517        };
518        let mut clip_planes = util::ClipPlanes::default();
519        let near = *render_state.DepthNear() as f32;
520        let far = *render_state.DepthFar() as f32;
521        clip_planes.update(near, far);
522        let top = *render_state
523            .GetInlineVerticalFieldOfView()
524            .expect("IVFOV should be non null for inline sessions") /
525            2.;
526        let top = near * top.tan() as f32;
527        let bottom = top;
528        let left = top * size.width as f32 / size.height as f32;
529        let right = left;
530        let matrix = util::frustum_to_projection_matrix(left, right, top, bottom, clip_planes);
531        *self.inline_projection_matrix.borrow_mut() = matrix;
532    }
533
534    /// Constructs a View suitable for inline sessions using the inlineVerticalFieldOfView and canvas size
535    pub(crate) fn inline_view(&self) -> View<Viewer> {
536        debug_assert!(!self.is_immersive());
537        View {
538            // Inline views have no offset
539            transform: RigidTransform3D::identity(),
540            projection: *self.inline_projection_matrix.borrow(),
541        }
542    }
543
544    pub(crate) fn session_id(&self) -> SessionId {
545        self.session.borrow().id()
546    }
547
548    pub(crate) fn dirty_layers(&self) {
549        if let Some(layer) = self.RenderState().GetBaseLayer() {
550            layer.context().mark_as_dirty();
551        }
552    }
553
554    // TODO: how does this align with the layers spec?
555    fn layers_begin_frame(&self, cx: &mut JSContext, frame: &XRFrame) {
556        if let Some(layer) = self.active_render_state.get().GetBaseLayer() {
557            layer.begin_frame(cx, frame);
558        }
559        self.active_render_state.get().with_layers(|layers| {
560            for layer in layers {
561                layer.begin_frame(cx, frame);
562            }
563        });
564    }
565
566    // TODO: how does this align with the layers spec?
567    fn layers_end_frame(&self, frame: &XRFrame) {
568        if let Some(layer) = self.active_render_state.get().GetBaseLayer() {
569            layer.end_frame(frame);
570        }
571        self.active_render_state.get().with_layers(|layers| {
572            for layer in layers {
573                layer.end_frame(frame);
574            }
575        });
576    }
577
578    /// <https://immersive-web.github.io/webxr/#xrframe-apply-frame-updates>
579    fn apply_frame_updates(&self, _frame: &XRFrame) {
580        // <https://www.w3.org/TR/webxr-gamepads-module-1/#xrframe-apply-gamepad-frame-updates>
581        for (id, frame) in self.input_frames.borrow_mut().drain() {
582            let source = self.input_sources.find(id);
583            if let Some(source) = source {
584                source.update_gamepad_state(frame);
585            }
586        }
587    }
588
589    fn handle_frame_event(&self, cx: &mut JSContext, event: FrameUpdateEvent) {
590        match event {
591            FrameUpdateEvent::HitTestSourceAdded(id) => {
592                if let Some(promise) = self.pending_hit_test_promises.borrow_mut().remove(&id) {
593                    let hit_test_source =
594                        XRHitTestSource::new(cx, self.global().as_window(), id, self);
595                    promise.resolve_native(cx, &hit_test_source);
596                } else {
597                    warn!(
598                        "received hit test add request for unknown hit test {:?}",
599                        id
600                    )
601                }
602            },
603            _ => self.session.borrow_mut().apply_event(event),
604        }
605    }
606
607    /// <https://www.w3.org/TR/webxr/#apply-the-nominal-frame-rate>
608    fn apply_nominal_framerate(&self, cx: &mut JSContext, rate: f32) {
609        if self.framerate.get() == rate || self.ended.get() {
610            return;
611        }
612
613        self.framerate.set(rate);
614
615        let event = XRSessionEvent::new(
616            cx,
617            self.global().as_window(),
618            Atom::from("frameratechange"),
619            false,
620            false,
621            self,
622        );
623        event.upcast::<Event>().fire(cx, self.upcast());
624    }
625}
626
627impl XRSessionMethods<crate::DomTypeHolder> for XRSession {
628    // https://immersive-web.github.io/webxr/#eventdef-xrsession-end
629    event_handler!(end, GetOnend, SetOnend);
630
631    // https://immersive-web.github.io/webxr/#eventdef-xrsession-select
632    event_handler!(select, GetOnselect, SetOnselect);
633
634    // https://immersive-web.github.io/webxr/#eventdef-xrsession-selectstart
635    event_handler!(selectstart, GetOnselectstart, SetOnselectstart);
636
637    // https://immersive-web.github.io/webxr/#eventdef-xrsession-selectend
638    event_handler!(selectend, GetOnselectend, SetOnselectend);
639
640    // https://immersive-web.github.io/webxr/#eventdef-xrsession-squeeze
641    event_handler!(squeeze, GetOnsqueeze, SetOnsqueeze);
642
643    // https://immersive-web.github.io/webxr/#eventdef-xrsession-squeezestart
644    event_handler!(squeezestart, GetOnsqueezestart, SetOnsqueezestart);
645
646    // https://immersive-web.github.io/webxr/#eventdef-xrsession-squeezeend
647    event_handler!(squeezeend, GetOnsqueezeend, SetOnsqueezeend);
648
649    // https://immersive-web.github.io/webxr/#eventdef-xrsession-visibilitychange
650    event_handler!(
651        visibilitychange,
652        GetOnvisibilitychange,
653        SetOnvisibilitychange
654    );
655
656    // https://immersive-web.github.io/webxr/#eventdef-xrsession-inputsourceschange
657    event_handler!(
658        inputsourceschange,
659        GetOninputsourceschange,
660        SetOninputsourceschange
661    );
662
663    // https://www.w3.org/TR/webxr/#dom-xrsession-onframeratechange
664    event_handler!(frameratechange, GetOnframeratechange, SetOnframeratechange);
665
666    /// <https://immersive-web.github.io/webxr/#dom-xrsession-renderstate>
667    fn RenderState(&self) -> DomRoot<XRRenderState> {
668        self.active_render_state.get()
669    }
670
671    /// <https://immersive-web.github.io/webxr/#dom-xrsession-updaterenderstate>
672    fn UpdateRenderState(&self, cx: &mut JSContext, init: &XRRenderStateInit) -> ErrorResult {
673        // Step 2
674        if self.ended.get() {
675            return Err(Error::InvalidState(None));
676        }
677        // Step 3:
678        if let Some(Some(ref layer)) = init.baseLayer &&
679            Dom::from_ref(layer.session()) != Dom::from_ref(self)
680        {
681            return Err(Error::InvalidState(None));
682        }
683
684        // Step 4:
685        if init.inlineVerticalFieldOfView.is_some() && self.is_immersive() {
686            return Err(Error::InvalidState(None));
687        }
688
689        // https://immersive-web.github.io/layers/#updaterenderstatechanges
690        // Step 1.
691        if init.baseLayer.is_some() && (self.has_layers_feature() || init.layers.is_some()) {
692            return Err(Error::NotSupported(None));
693        }
694
695        if let Some(Some(ref layers)) = init.layers {
696            // Step 2
697            for layer in layers {
698                let count = layers
699                    .iter()
700                    .filter(|other| other.layer_id() == layer.layer_id())
701                    .count();
702                if count > 1 {
703                    return Err(Error::Type(c"Duplicate entry in WebXR layers".to_owned()));
704                }
705            }
706
707            // Step 3
708            for layer in layers {
709                if layer.session() != self {
710                    return Err(Error::Type(
711                        c"Layer from different session in WebXR layers".to_owned(),
712                    ));
713                }
714            }
715        }
716
717        // Step 4-5
718        let pending = self
719            .pending_render_state
720            .or_init(|| self.active_render_state.get().clone_object(cx));
721
722        // Step 6
723        if let Some(ref layers) = init.layers {
724            let layers = layers.as_deref().unwrap_or_default();
725            pending.set_base_layer(None);
726            pending.set_layers(layers.iter().map(|x| &**x).collect());
727            let layers = layers
728                .iter()
729                .filter_map(|layer| {
730                    let context_id = WebXRContextId::from(layer.context_id());
731                    let layer_id = layer.layer_id()?;
732                    Some((context_id, layer_id))
733                })
734                .collect();
735            self.session.borrow_mut().set_layers(layers);
736        }
737
738        // End of https://immersive-web.github.io/layers/#updaterenderstatechanges
739
740        if let Some(near) = init.depthNear {
741            let mut near = *near;
742            // Step 8 from #apply-the-pending-render-state
743            // this may need to be changed if backends wish to impose
744            // further constraints
745            if near < 0. {
746                near = 0.;
747            }
748            pending.set_depth_near(near);
749        }
750        if let Some(far) = init.depthFar {
751            let mut far = *far;
752            // Step 9 from #apply-the-pending-render-state
753            // this may need to be changed if backends wish to impose
754            // further constraints
755            // currently the maximum is infinity, so just check that
756            // the value is non-negative
757            if far < 0. {
758                far = 0.;
759            }
760            pending.set_depth_far(far);
761        }
762        if let Some(fov) = init.inlineVerticalFieldOfView {
763            let mut fov = *fov;
764            // Step 10 from #apply-the-pending-render-state
765            // this may need to be changed if backends wish to impose
766            // further constraints
767            if fov < 0. {
768                fov = 0.0001;
769            } else if fov > PI {
770                fov = PI - 0.0001;
771            }
772            pending.set_inline_vertical_fov(fov);
773        }
774        if let Some(ref layer) = init.baseLayer {
775            pending.set_base_layer(layer.as_deref());
776            pending.set_layers(Vec::new());
777            let layers = layer
778                .iter()
779                .filter_map(|layer| {
780                    let context_id = WebXRContextId::from(layer.context_id());
781                    let layer_id = layer.layer_id()?;
782                    Some((context_id, layer_id))
783                })
784                .collect();
785            self.session.borrow_mut().set_layers(layers);
786        }
787
788        if init.depthFar.is_some() || init.depthNear.is_some() {
789            self.session
790                .borrow_mut()
791                .update_clip_planes(*pending.DepthNear() as f32, *pending.DepthFar() as f32);
792        }
793
794        Ok(())
795    }
796
797    /// <https://immersive-web.github.io/webxr/#dom-xrsession-requestanimationframe>
798    fn RequestAnimationFrame(&self, callback: Rc<XRFrameRequestCallback>) -> i32 {
799        // queue up RAF callback, obtain ID
800        let raf_id = self.next_raf_id.get();
801        self.next_raf_id.set(raf_id + 1);
802        self.raf_callback_list
803            .borrow_mut()
804            .push((raf_id, Some(callback)));
805
806        raf_id
807    }
808
809    /// <https://immersive-web.github.io/webxr/#dom-xrsession-cancelanimationframe>
810    fn CancelAnimationFrame(&self, frame: i32) {
811        let mut list = self.raf_callback_list.borrow_mut();
812        if let Some(pair) = list.iter_mut().find(|pair| pair.0 == frame) {
813            pair.1 = None;
814        }
815
816        let mut list = self.current_raf_callback_list.borrow_mut();
817        if let Some(pair) = list.iter_mut().find(|pair| pair.0 == frame) {
818            pair.1 = None;
819        }
820    }
821
822    /// <https://immersive-web.github.io/webxr/#dom-xrsession-environmentblendmode>
823    fn EnvironmentBlendMode(&self) -> XREnvironmentBlendMode {
824        self.blend_mode
825    }
826
827    /// <https://immersive-web.github.io/webxr/#dom-xrsession-visibilitystate>
828    fn VisibilityState(&self) -> XRVisibilityState {
829        self.visibility_state.get()
830    }
831
832    /// <https://immersive-web.github.io/webxr/#dom-xrsession-requestreferencespace>
833    fn RequestReferenceSpace(
834        &self,
835        cx: &mut CurrentRealm,
836        ty: XRReferenceSpaceType,
837    ) -> Rc<Promise> {
838        let p = Promise::new_in_realm(cx);
839
840        // https://immersive-web.github.io/webxr/#create-a-reference-space
841
842        // XXXManishearth reject based on session type
843        // https://github.com/immersive-web/webxr/blob/master/spatial-tracking-explainer.md#practical-usage-guidelines
844
845        if !self.is_immersive() &&
846            (ty == XRReferenceSpaceType::Bounded_floor || ty == XRReferenceSpaceType::Unbounded)
847        {
848            p.reject_error(cx, Error::NotSupported(None));
849            return p;
850        }
851
852        match ty {
853            XRReferenceSpaceType::Unbounded => {
854                // XXXmsub2 figure out how to support this
855                p.reject_error(cx, Error::NotSupported(None))
856            },
857            ty => {
858                if ty != XRReferenceSpaceType::Viewer &&
859                    (!self.is_immersive() || ty != XRReferenceSpaceType::Local)
860                {
861                    let s = ty.as_str();
862                    if !self
863                        .session
864                        .borrow()
865                        .granted_features()
866                        .iter()
867                        .any(|f| *f == s)
868                    {
869                        p.reject_error(cx, Error::NotSupported(None));
870                        return p;
871                    }
872                }
873                if ty == XRReferenceSpaceType::Bounded_floor {
874                    let space = XRBoundedReferenceSpace::new(cx, self.global().as_window(), self);
875                    self.reference_spaces
876                        .borrow_mut()
877                        .push(Dom::from_ref(space.reference_space()));
878                    p.resolve_native(cx, &space);
879                } else {
880                    let space = XRReferenceSpace::new(cx, self.global().as_window(), self, ty);
881                    self.reference_spaces
882                        .borrow_mut()
883                        .push(Dom::from_ref(&*space));
884                    p.resolve_native(cx, &space);
885                }
886            },
887        }
888        p
889    }
890
891    /// <https://immersive-web.github.io/webxr/#dom-xrsession-inputsources>
892    fn InputSources(&self) -> DomRoot<XRInputSourceArray> {
893        DomRoot::from_ref(&*self.input_sources)
894    }
895
896    /// <https://immersive-web.github.io/webxr/#dom-xrsession-end>
897    fn End(&self, cx: &mut CurrentRealm) -> Rc<Promise> {
898        let p = Promise::new_in_realm(cx);
899        if self.ended.get() && self.end_promises.borrow().is_empty() {
900            // If the session has completely ended and all end promises have been resolved,
901            // don't queue up more end promises
902            //
903            // We need to check for end_promises being empty because `ended` is set
904            // before everything has been completely shut down, and we do not want to
905            // prematurely resolve the promise then
906            //
907            // However, if end_promises is empty, then all end() promises have already resolved,
908            // so the session has completely shut down and we should not queue up more promises
909            p.resolve_native(cx, &());
910            return p;
911        }
912        self.end_promises.borrow_mut().push(p.clone());
913        // This is duplicated in event_callback since this should
914        // happen ASAP for end() but can happen later if the device
915        // shuts itself down
916        self.ended.set(true);
917        self.global()
918            .as_window()
919            .Navigator(cx)
920            .Xr(cx)
921            .end_session(self);
922        self.session.borrow_mut().end_session();
923        // Disconnect any still-attached XRInputSources
924        for source in 0..self.input_sources.Length() {
925            self.input_sources
926                .remove_input_source(cx, self, InputId(source));
927        }
928        p
929    }
930
931    /// <https://immersive-web.github.io/hit-test/#dom-xrsession-requesthittestsource>
932    fn RequestHitTestSource(
933        &self,
934        cx: &mut CurrentRealm,
935        options: &XRHitTestOptionsInit,
936    ) -> Rc<Promise> {
937        let p = Promise::new_in_realm(cx);
938
939        if !self
940            .session
941            .borrow()
942            .granted_features()
943            .iter()
944            .any(|f| f == "hit-test")
945        {
946            p.reject_error(cx, Error::NotSupported(None));
947            return p;
948        }
949
950        let id = self.next_hit_test_id.get();
951        self.next_hit_test_id.set(HitTestId(id.0 + 1));
952
953        let space = options.space.space();
954        let ray = if let Some(ref ray) = options.offsetRay {
955            ray.ray()
956        } else {
957            Ray {
958                origin: Vector3D::new(0., 0., 0.),
959                direction: Vector3D::new(0., 0., -1.),
960            }
961        };
962
963        let mut types = EntityTypes::default();
964
965        if let Some(ref tys) = options.entityTypes {
966            for ty in tys {
967                match ty {
968                    XRHitTestTrackableType::Point => types.point = true,
969                    XRHitTestTrackableType::Plane => types.plane = true,
970                    XRHitTestTrackableType::Mesh => types.mesh = true,
971                }
972            }
973        } else {
974            types.plane = true;
975        }
976
977        let source = HitTestSource {
978            id,
979            space,
980            ray,
981            types,
982        };
983        self.pending_hit_test_promises
984            .borrow_mut()
985            .insert(id, p.clone());
986
987        self.session.borrow().request_hit_test(source);
988
989        p
990    }
991
992    /// <https://www.w3.org/TR/webxr-ar-module-1/#dom-xrsession-interactionmode>
993    fn InteractionMode(&self) -> XRInteractionMode {
994        // Until Servo supports WebXR sessions on mobile phones or similar non-XR devices,
995        // this should always be world space
996        XRInteractionMode::World_space
997    }
998
999    /// <https://www.w3.org/TR/webxr/#dom-xrsession-framerate>
1000    fn GetFrameRate(&self) -> Option<Finite<f32>> {
1001        let session = self.session.borrow();
1002        if self.mode == XRSessionMode::Inline || session.supported_frame_rates().is_empty() {
1003            None
1004        } else {
1005            Finite::new(self.framerate.get())
1006        }
1007    }
1008
1009    /// <https://www.w3.org/TR/webxr/#dom-xrsession-supportedframerates>
1010    fn GetSupportedFrameRates(
1011        &self,
1012        cx: &mut JSContext,
1013    ) -> Option<RootedTraceableBox<HeapFloat32Array>> {
1014        let session = self.session.borrow();
1015        if self.mode == XRSessionMode::Inline || session.supported_frame_rates().is_empty() {
1016            None
1017        } else {
1018            let framerates = session.supported_frame_rates();
1019            rooted!(&in(cx) let mut array = ptr::null_mut::<JSObject>());
1020            Some(
1021                create_buffer_source(cx, framerates, array.handle_mut())
1022                    .expect("Failed to construct supported frame rates array"),
1023            )
1024        }
1025    }
1026
1027    /// <https://www.w3.org/TR/webxr/#dom-xrsession-enabledfeatures>
1028    fn EnabledFeatures(&self, cx: &mut JSContext, retval: MutableHandleValue) {
1029        let session = self.session.borrow();
1030        let features = session.granted_features();
1031        to_frozen_array(cx, features, retval)
1032    }
1033
1034    /// <https://www.w3.org/TR/webxr/#dom-xrsession-issystemkeyboardsupported>
1035    fn IsSystemKeyboardSupported(&self) -> bool {
1036        // Support for this only exists on Meta headsets (no desktop support)
1037        // so this will always be false until that changes
1038        false
1039    }
1040
1041    /// <https://www.w3.org/TR/webxr/#dom-xrsession-updatetargetframerate>
1042    fn UpdateTargetFrameRate(&self, cx: &mut CurrentRealm, rate: Finite<f32>) -> Rc<Promise> {
1043        let promise = Promise::new_in_realm(cx);
1044        {
1045            let session = self.session.borrow();
1046            let supported_frame_rates = session.supported_frame_rates();
1047
1048            if self.mode == XRSessionMode::Inline ||
1049                supported_frame_rates.is_empty() ||
1050                self.ended.get()
1051            {
1052                promise.reject_error(cx, Error::InvalidState(None));
1053                return promise;
1054            }
1055
1056            if !supported_frame_rates.contains(&*rate) {
1057                promise.reject_error(cx, Error::Type(c"Provided framerate not supported".into()));
1058                return promise;
1059            }
1060        }
1061
1062        *self.update_framerate_promise.borrow_mut() = Some(promise.clone());
1063
1064        let this = Trusted::new(self);
1065        let global = self.global();
1066        let task_source = global
1067            .task_manager()
1068            .dom_manipulation_task_source()
1069            .to_sendable();
1070
1071        let callback =
1072            ProfileGenericCallback::new(global.time_profiler_chan().clone(), move |message| {
1073                let this = this.clone();
1074                task_source.queue(task!(update_session_framerate: move |cx| {
1075                    let session = this.root();
1076                    session.apply_nominal_framerate(cx, message.unwrap());
1077                    if let Some(promise) = session.update_framerate_promise.borrow_mut().take() {
1078                        promise.resolve_native(cx, &());
1079                    };
1080                }));
1081            })
1082            .expect("Could not create callback");
1083
1084        self.session.borrow_mut().update_frame_rate(*rate, callback);
1085
1086        promise
1087    }
1088}
1089
1090// The pose of an object in native-space. Should never be exposed.
1091pub(crate) type ApiPose = RigidTransform3D<f32, ApiSpace, webxr_api::Native>;
1092// A transform between objects in some API-space
1093pub(crate) type ApiRigidTransform = RigidTransform3D<f32, ApiSpace, ApiSpace>;
1094
1095#[derive(Clone, Copy)]
1096pub(crate) struct BaseSpace;
1097
1098pub(crate) type BaseTransform = RigidTransform3D<f32, webxr_api::Native, BaseSpace>;
1099
1100#[expect(unsafe_code)]
1101pub(crate) fn cast_transform<T, U, V, W>(
1102    transform: RigidTransform3D<f32, T, U>,
1103) -> RigidTransform3D<f32, V, W> {
1104    unsafe { mem::transmute(transform) }
1105}
1106
1107impl Convert<XREnvironmentBlendMode> for EnvironmentBlendMode {
1108    fn convert(self) -> XREnvironmentBlendMode {
1109        match self {
1110            EnvironmentBlendMode::Opaque => XREnvironmentBlendMode::Opaque,
1111            EnvironmentBlendMode::AlphaBlend => XREnvironmentBlendMode::Alpha_blend,
1112            EnvironmentBlendMode::Additive => XREnvironmentBlendMode::Additive,
1113        }
1114    }
1115}
script/dom/webxr/xrsession.rs

script/dom/webxr/
xrsession.rs
