script/dom/webgpu/
gpu.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::rc::Rc;
6
7use dom_struct::dom_struct;
8use js::jsapi::HandleObject;
9use script_bindings::reflector::{Reflector, reflect_dom_object};
10use servo_constellation_traits::ScriptToConstellationMessage;
11use webgpu_traits::WebGPUAdapterResponse;
12use wgpu_types::PowerPreference;
13
14use super::wgsllanguagefeatures::WGSLLanguageFeatures;
15use crate::dom::bindings::codegen::Bindings::WebGPUBinding::{
16    GPUMethods, GPUPowerPreference, GPURequestAdapterOptions, GPUTextureFormat,
17};
18use crate::dom::bindings::error::Error;
19use crate::dom::bindings::reflector::DomGlobal;
20use crate::dom::bindings::root::{DomRoot, MutNullableDom};
21use crate::dom::bindings::str::DOMString;
22use crate::dom::globalscope::GlobalScope;
23use crate::dom::promise::Promise;
24use crate::dom::webgpu::gpuadapter::GPUAdapter;
25use crate::realms::InRealm;
26use crate::routed_promise::{RoutedPromiseListener, callback_promise};
27use crate::script_runtime::CanGc;
28
29#[dom_struct]
30#[expect(clippy::upper_case_acronyms)]
31pub(crate) struct GPU {
32    reflector_: Reflector,
33    /// Same object for <https://www.w3.org/TR/webgpu/#dom-gpu-wgsllanguagefeatures>
34    wgsl_language_features: MutNullableDom<WGSLLanguageFeatures>,
35}
36
37impl GPU {
38    pub(crate) fn new_inherited() -> GPU {
39        GPU {
40            reflector_: Reflector::new(),
41            wgsl_language_features: MutNullableDom::default(),
42        }
43    }
44
45    pub(crate) fn new(global: &GlobalScope, can_gc: CanGc) -> DomRoot<GPU> {
46        reflect_dom_object(Box::new(GPU::new_inherited()), global, can_gc)
47    }
48}
49
50impl GPUMethods<crate::DomTypeHolder> for GPU {
51    /// <https://gpuweb.github.io/gpuweb/#dom-gpu-requestadapter>
52    fn RequestAdapter(
53        &self,
54        options: &GPURequestAdapterOptions,
55        comp: InRealm,
56        can_gc: CanGc,
57    ) -> Rc<Promise> {
58        let global = &self.global();
59        let promise = Promise::new_in_current_realm(comp, can_gc);
60        let task_source = global.task_manager().dom_manipulation_task_source();
61        let callback = callback_promise(&promise, self, task_source);
62
63        let power_preference = match options.powerPreference {
64            Some(GPUPowerPreference::Low_power) => PowerPreference::LowPower,
65            Some(GPUPowerPreference::High_performance) => PowerPreference::HighPerformance,
66            None => PowerPreference::default(),
67        };
68        let ids = global.wgpu_id_hub().create_adapter_id();
69
70        let script_to_constellation_chan = global.script_to_constellation_chan();
71        if script_to_constellation_chan
72            .send(ScriptToConstellationMessage::RequestAdapter(
73                callback,
74                wgpu_core::instance::RequestAdapterOptions {
75                    power_preference,
76                    compatible_surface: None,
77                    force_fallback_adapter: options.forceFallbackAdapter,
78                },
79                ids,
80            ))
81            .is_err()
82        {
83            promise.reject_error(Error::Operation(None), can_gc);
84        }
85        promise
86    }
87
88    /// <https://gpuweb.github.io/gpuweb/#dom-gpu-getpreferredcanvasformat>
89    fn GetPreferredCanvasFormat(&self) -> GPUTextureFormat {
90        // From https://github.com/mozilla-firefox/firefox/blob/24d49101ce17b78c3ba1217d00297fe2891be6b3/dom/webgpu/Instance.h#L68
91        if cfg!(target_os = "android") {
92            GPUTextureFormat::Rgba8unorm
93        } else {
94            GPUTextureFormat::Bgra8unorm
95        }
96    }
97
98    /// <https://www.w3.org/TR/webgpu/#dom-gpu-wgsllanguagefeatures>
99    fn WgslLanguageFeatures(&self, can_gc: CanGc) -> DomRoot<WGSLLanguageFeatures> {
100        self.wgsl_language_features
101            .or_init(|| WGSLLanguageFeatures::new(&self.global(), None, can_gc))
102    }
103}
104
105impl RoutedPromiseListener<WebGPUAdapterResponse> for GPU {
106    fn handle_response(
107        &self,
108        cx: &mut js::context::JSContext,
109        response: WebGPUAdapterResponse,
110        promise: &Rc<Promise>,
111    ) {
112        match response {
113            Some(Ok(adapter)) => {
114                let adapter = GPUAdapter::new(
115                    &self.global(),
116                    adapter.channel,
117                    DOMString::from(format!(
118                        "{} ({:?})",
119                        adapter.adapter_info.name, adapter.adapter_id.0
120                    )),
121                    HandleObject::null(),
122                    adapter.features,
123                    adapter.limits,
124                    adapter.adapter_info,
125                    adapter.adapter_id,
126                    CanGc::from_cx(cx),
127                );
128                promise.resolve_native(&adapter, CanGc::from_cx(cx));
129            },
130            Some(Err(e)) => {
131                warn!("Could not get GPUAdapter ({:?})", e);
132                promise.resolve_native(&None::<GPUAdapter>, CanGc::from_cx(cx));
133            },
134            None => {
135                warn!("Couldn't get a response, because WebGPU is disabled");
136                promise.resolve_native(&None::<GPUAdapter>, CanGc::from_cx(cx));
137            },
138        }
139    }
140}
script/dom/webgpu/gpu.rs

script/dom/webgpu/
gpu.rs
