script/dom/webgpu/
gpurenderbundleencoder.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::borrow::Cow;
6
7use dom_struct::dom_struct;
8use webgpu_traits::{WebGPU, WebGPURenderBundle, WebGPURequest};
9use wgpu_core::command::{
10    RenderBundleEncoder, RenderBundleEncoderDescriptor, bundle_ffi as wgpu_bundle,
11};
12
13use crate::conversions::Convert;
14use crate::dom::bindings::cell::DomRefCell;
15use crate::dom::bindings::codegen::Bindings::WebGPUBinding::{
16    GPUIndexFormat, GPURenderBundleDescriptor, GPURenderBundleEncoderDescriptor,
17    GPURenderBundleEncoderMethods,
18};
19use crate::dom::bindings::error::Fallible;
20use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object};
21use crate::dom::bindings::root::{Dom, DomRoot};
22use crate::dom::bindings::str::USVString;
23use crate::dom::globalscope::GlobalScope;
24use crate::dom::webgpu::gpubindgroup::GPUBindGroup;
25use crate::dom::webgpu::gpubuffer::GPUBuffer;
26use crate::dom::webgpu::gpudevice::GPUDevice;
27use crate::dom::webgpu::gpurenderbundle::GPURenderBundle;
28use crate::dom::webgpu::gpurenderpipeline::GPURenderPipeline;
29use crate::script_runtime::CanGc;
30
31#[dom_struct]
32pub(crate) struct GPURenderBundleEncoder {
33    reflector_: Reflector,
34    #[ignore_malloc_size_of = "channels are hard"]
35    #[no_trace]
36    channel: WebGPU,
37    device: Dom<GPUDevice>,
38    #[ignore_malloc_size_of = "defined in wgpu-core"]
39    #[no_trace]
40    render_bundle_encoder: DomRefCell<Option<RenderBundleEncoder>>,
41    label: DomRefCell<USVString>,
42}
43
44impl GPURenderBundleEncoder {
45    fn new_inherited(
46        render_bundle_encoder: RenderBundleEncoder,
47        device: &GPUDevice,
48        channel: WebGPU,
49        label: USVString,
50    ) -> Self {
51        Self {
52            reflector_: Reflector::new(),
53            render_bundle_encoder: DomRefCell::new(Some(render_bundle_encoder)),
54            device: Dom::from_ref(device),
55            channel,
56            label: DomRefCell::new(label),
57        }
58    }
59
60    pub(crate) fn new(
61        global: &GlobalScope,
62        render_bundle_encoder: RenderBundleEncoder,
63        device: &GPUDevice,
64        channel: WebGPU,
65        label: USVString,
66        can_gc: CanGc,
67    ) -> DomRoot<Self> {
68        reflect_dom_object(
69            Box::new(GPURenderBundleEncoder::new_inherited(
70                render_bundle_encoder,
71                device,
72                channel,
73                label,
74            )),
75            global,
76            can_gc,
77        )
78    }
79}
80
81impl GPURenderBundleEncoder {
82    /// <https://gpuweb.github.io/gpuweb/#dom-gpudevice-createrenderbundleencoder>
83    pub(crate) fn create(
84        device: &GPUDevice,
85        descriptor: &GPURenderBundleEncoderDescriptor,
86        can_gc: CanGc,
87    ) -> Fallible<DomRoot<GPURenderBundleEncoder>> {
88        let desc = RenderBundleEncoderDescriptor {
89            label: (&descriptor.parent.parent).convert(),
90            color_formats: Cow::Owned(
91                descriptor
92                    .parent
93                    .colorFormats
94                    .iter()
95                    .map(|format| {
96                        device
97                            .validate_texture_format_required_features(format)
98                            .map(Some)
99                    })
100                    .collect::<Fallible<Vec<_>>>()?,
101            ),
102            depth_stencil: descriptor
103                .parent
104                .depthStencilFormat
105                .map(|dsf| {
106                    device
107                        .validate_texture_format_required_features(&dsf)
108                        .map(|format| wgpu_types::RenderBundleDepthStencil {
109                            format,
110                            depth_read_only: descriptor.depthReadOnly,
111                            stencil_read_only: descriptor.stencilReadOnly,
112                        })
113                })
114                .transpose()?,
115            sample_count: descriptor.parent.sampleCount,
116            multiview: None,
117        };
118
119        // Handle error gracefully
120        let render_bundle_encoder = RenderBundleEncoder::new(&desc, device.id().0, None).unwrap();
121
122        Ok(GPURenderBundleEncoder::new(
123            &device.global(),
124            render_bundle_encoder,
125            device,
126            device.channel().clone(),
127            descriptor.parent.parent.label.clone(),
128            can_gc,
129        ))
130    }
131}
132
133impl GPURenderBundleEncoderMethods<crate::DomTypeHolder> for GPURenderBundleEncoder {
134    /// <https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label>
135    fn Label(&self) -> USVString {
136        self.label.borrow().clone()
137    }
138
139    /// <https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label>
140    fn SetLabel(&self, value: USVString) {
141        *self.label.borrow_mut() = value;
142    }
143
144    /// <https://gpuweb.github.io/gpuweb/#dom-gpuprogrammablepassencoder-setbindgroup>
145    #[allow(unsafe_code)]
146    fn SetBindGroup(&self, index: u32, bind_group: &GPUBindGroup, dynamic_offsets: Vec<u32>) {
147        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
148            unsafe {
149                wgpu_bundle::wgpu_render_bundle_set_bind_group(
150                    encoder,
151                    index,
152                    Some(bind_group.id().0),
153                    dynamic_offsets.as_ptr(),
154                    dynamic_offsets.len(),
155                )
156            };
157        }
158    }
159
160    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-setpipeline>
161    fn SetPipeline(&self, pipeline: &GPURenderPipeline) {
162        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
163            wgpu_bundle::wgpu_render_bundle_set_pipeline(encoder, pipeline.id().0);
164        }
165    }
166
167    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-setindexbuffer>
168    fn SetIndexBuffer(
169        &self,
170        buffer: &GPUBuffer,
171        index_format: GPUIndexFormat,
172        offset: u64,
173        size: u64,
174    ) {
175        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
176            wgpu_bundle::wgpu_render_bundle_set_index_buffer(
177                encoder,
178                buffer.id().0,
179                match index_format {
180                    GPUIndexFormat::Uint16 => wgpu_types::IndexFormat::Uint16,
181                    GPUIndexFormat::Uint32 => wgpu_types::IndexFormat::Uint32,
182                },
183                offset,
184                wgpu_types::BufferSize::new(size),
185            );
186        }
187    }
188
189    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-setvertexbuffer>
190    fn SetVertexBuffer(&self, slot: u32, buffer: &GPUBuffer, offset: u64, size: u64) {
191        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
192            wgpu_bundle::wgpu_render_bundle_set_vertex_buffer(
193                encoder,
194                slot,
195                buffer.id().0,
196                offset,
197                wgpu_types::BufferSize::new(size),
198            );
199        }
200    }
201
202    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-draw>
203    fn Draw(&self, vertex_count: u32, instance_count: u32, first_vertex: u32, first_instance: u32) {
204        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
205            wgpu_bundle::wgpu_render_bundle_draw(
206                encoder,
207                vertex_count,
208                instance_count,
209                first_vertex,
210                first_instance,
211            );
212        }
213    }
214
215    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindexed>
216    fn DrawIndexed(
217        &self,
218        index_count: u32,
219        instance_count: u32,
220        first_index: u32,
221        base_vertex: i32,
222        first_instance: u32,
223    ) {
224        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
225            wgpu_bundle::wgpu_render_bundle_draw_indexed(
226                encoder,
227                index_count,
228                instance_count,
229                first_index,
230                base_vertex,
231                first_instance,
232            );
233        }
234    }
235
236    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindirect>
237    fn DrawIndirect(&self, indirect_buffer: &GPUBuffer, indirect_offset: u64) {
238        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
239            wgpu_bundle::wgpu_render_bundle_draw_indirect(
240                encoder,
241                indirect_buffer.id().0,
242                indirect_offset,
243            );
244        }
245    }
246
247    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindexedindirect>
248    fn DrawIndexedIndirect(&self, indirect_buffer: &GPUBuffer, indirect_offset: u64) {
249        if let Some(encoder) = self.render_bundle_encoder.borrow_mut().as_mut() {
250            wgpu_bundle::wgpu_render_bundle_draw_indexed_indirect(
251                encoder,
252                indirect_buffer.id().0,
253                indirect_offset,
254            );
255        }
256    }
257
258    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderbundleencoder-finish>
259    fn Finish(&self, descriptor: &GPURenderBundleDescriptor) -> DomRoot<GPURenderBundle> {
260        let desc = wgpu_types::RenderBundleDescriptor {
261            label: (&descriptor.parent).convert(),
262        };
263        let encoder = self.render_bundle_encoder.borrow_mut().take().unwrap();
264        let render_bundle_id = self.global().wgpu_id_hub().create_render_bundle_id();
265
266        self.channel
267            .0
268            .send(WebGPURequest::RenderBundleEncoderFinish {
269                render_bundle_encoder: encoder,
270                descriptor: desc,
271                render_bundle_id,
272                device_id: self.device.id().0,
273            })
274            .expect("Failed to send RenderBundleEncoderFinish");
275
276        let render_bundle = WebGPURenderBundle(render_bundle_id);
277        GPURenderBundle::new(
278            &self.global(),
279            render_bundle,
280            self.device.id(),
281            self.channel.clone(),
282            descriptor.parent.label.clone(),
283            CanGc::note(),
284        )
285    }
286}
script/dom/webgpu/gpurenderbundleencoder.rs

script/dom/webgpu/
gpurenderbundleencoder.rs
