script/dom/webxr/
xrrenderstate.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;
6
7use dom_struct::dom_struct;
8use js::rust::MutableHandleValue;
9use webxr_api::SubImages;
10
11use crate::dom::bindings::cell::DomRefCell;
12use crate::dom::bindings::codegen::Bindings::XRRenderStateBinding::XRRenderStateMethods;
13use crate::dom::bindings::num::Finite;
14use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object};
15use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom};
16use crate::dom::bindings::utils::to_frozen_array;
17use crate::dom::window::Window;
18use crate::dom::xrlayer::XRLayer;
19use crate::dom::xrwebgllayer::XRWebGLLayer;
20use crate::script_runtime::{CanGc, JSContext};
21
22#[dom_struct]
23pub(crate) struct XRRenderState {
24    reflector_: Reflector,
25    depth_near: Cell<f64>,
26    depth_far: Cell<f64>,
27    inline_vertical_fov: Cell<Option<f64>>,
28    base_layer: MutNullableDom<XRWebGLLayer>,
29    layers: DomRefCell<Vec<Dom<XRLayer>>>,
30}
31
32impl XRRenderState {
33    pub(crate) fn new_inherited(
34        depth_near: f64,
35        depth_far: f64,
36        inline_vertical_fov: Option<f64>,
37        layer: Option<&XRWebGLLayer>,
38        layers: Vec<&XRLayer>,
39    ) -> XRRenderState {
40        debug_assert!(layer.is_none() || layers.is_empty());
41        XRRenderState {
42            reflector_: Reflector::new(),
43            depth_near: Cell::new(depth_near),
44            depth_far: Cell::new(depth_far),
45            inline_vertical_fov: Cell::new(inline_vertical_fov),
46            base_layer: MutNullableDom::new(layer),
47            layers: DomRefCell::new(layers.into_iter().map(Dom::from_ref).collect()),
48        }
49    }
50
51    pub(crate) fn new(
52        window: &Window,
53        depth_near: f64,
54        depth_far: f64,
55        inline_vertical_fov: Option<f64>,
56        layer: Option<&XRWebGLLayer>,
57        layers: Vec<&XRLayer>,
58        can_gc: CanGc,
59    ) -> DomRoot<XRRenderState> {
60        reflect_dom_object(
61            Box::new(XRRenderState::new_inherited(
62                depth_near,
63                depth_far,
64                inline_vertical_fov,
65                layer,
66                layers,
67            )),
68            window,
69            can_gc,
70        )
71    }
72
73    pub(crate) fn clone_object(&self) -> DomRoot<Self> {
74        XRRenderState::new(
75            self.global().as_window(),
76            self.depth_near.get(),
77            self.depth_far.get(),
78            self.inline_vertical_fov.get(),
79            self.base_layer.get().as_deref(),
80            self.layers.borrow().iter().map(|x| &**x).collect(),
81            CanGc::note(),
82        )
83    }
84
85    pub(crate) fn set_depth_near(&self, depth: f64) {
86        self.depth_near.set(depth)
87    }
88    pub(crate) fn set_depth_far(&self, depth: f64) {
89        self.depth_far.set(depth)
90    }
91    pub(crate) fn set_inline_vertical_fov(&self, fov: f64) {
92        debug_assert!(self.inline_vertical_fov.get().is_some());
93        self.inline_vertical_fov.set(Some(fov))
94    }
95    pub(crate) fn set_base_layer(&self, layer: Option<&XRWebGLLayer>) {
96        self.base_layer.set(layer)
97    }
98    pub(crate) fn set_layers(&self, layers: Vec<&XRLayer>) {
99        *self.layers.borrow_mut() = layers.into_iter().map(Dom::from_ref).collect();
100    }
101    pub(crate) fn with_layers<F, R>(&self, f: F) -> R
102    where
103        F: FnOnce(&[Dom<XRLayer>]) -> R,
104    {
105        let layers = self.layers.borrow();
106        f(&layers)
107    }
108    pub(crate) fn has_sub_images(&self, sub_images: &[SubImages]) -> bool {
109        if let Some(base_layer) = self.base_layer.get() {
110            match sub_images.len() {
111                // For inline sessions, there may be a base layer, but it won't have a framebuffer
112                0 => base_layer.layer_id().is_none(),
113                // For immersive sessions, the base layer will have a framebuffer,
114                // so we make sure the layer id's match up
115                1 => base_layer.layer_id() == Some(sub_images[0].layer_id),
116                _ => false,
117            }
118        } else {
119            // The layers API is only for immersive sessions
120            let layers = self.layers.borrow();
121            sub_images.len() == layers.len() &&
122                sub_images
123                    .iter()
124                    .zip(layers.iter())
125                    .all(|(sub_image, layer)| Some(sub_image.layer_id) == layer.layer_id())
126        }
127    }
128}
129
130impl XRRenderStateMethods<crate::DomTypeHolder> for XRRenderState {
131    /// <https://immersive-web.github.io/webxr/#dom-xrrenderstate-depthnear>
132    fn DepthNear(&self) -> Finite<f64> {
133        Finite::wrap(self.depth_near.get())
134    }
135
136    /// <https://immersive-web.github.io/webxr/#dom-xrrenderstate-depthfar>
137    fn DepthFar(&self) -> Finite<f64> {
138        Finite::wrap(self.depth_far.get())
139    }
140
141    /// <https://immersive-web.github.io/webxr/#dom-xrrenderstate-inlineverticalfieldofview>
142    fn GetInlineVerticalFieldOfView(&self) -> Option<Finite<f64>> {
143        self.inline_vertical_fov.get().map(Finite::wrap)
144    }
145
146    /// <https://immersive-web.github.io/webxr/#dom-xrrenderstate-baselayer>
147    fn GetBaseLayer(&self) -> Option<DomRoot<XRWebGLLayer>> {
148        self.base_layer.get()
149    }
150
151    /// <https://immersive-web.github.io/layers/#dom-xrrenderstate-layers>
152    fn Layers(&self, cx: JSContext, can_gc: CanGc, retval: MutableHandleValue) {
153        // TODO: cache this array?
154        let layers = self.layers.borrow();
155        let layers: Vec<&XRLayer> = layers.iter().map(|x| &**x).collect();
156        to_frozen_array(&layers[..], cx, retval, can_gc)
157    }
158}
script/dom/webxr/xrrenderstate.rs

script/dom/webxr/
xrrenderstate.rs
