script/dom/webgpu/
gpurenderpassencoder.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 dom_struct::dom_struct;
6use webgpu_traits::{RenderCommand, WebGPU, WebGPURenderPass, WebGPURequest};
7
8use crate::conversions::TryConvert;
9use crate::dom::bindings::cell::DomRefCell;
10use crate::dom::bindings::codegen::Bindings::WebGPUBinding::{
11    GPUColor, GPUIndexFormat, GPURenderPassEncoderMethods,
12};
13use crate::dom::bindings::error::Fallible;
14use crate::dom::bindings::num::Finite;
15use crate::dom::bindings::reflector::{Reflector, reflect_dom_object};
16use crate::dom::bindings::root::{Dom, DomRoot};
17use crate::dom::bindings::str::USVString;
18use crate::dom::globalscope::GlobalScope;
19use crate::dom::webgpu::gpubindgroup::GPUBindGroup;
20use crate::dom::webgpu::gpubuffer::GPUBuffer;
21use crate::dom::webgpu::gpucommandencoder::GPUCommandEncoder;
22use crate::dom::webgpu::gpurenderbundle::GPURenderBundle;
23use crate::dom::webgpu::gpurenderpipeline::GPURenderPipeline;
24use crate::script_runtime::CanGc;
25
26#[dom_struct]
27pub(crate) struct GPURenderPassEncoder {
28    reflector_: Reflector,
29    #[ignore_malloc_size_of = "defined in webgpu"]
30    #[no_trace]
31    channel: WebGPU,
32    label: DomRefCell<USVString>,
33    #[no_trace]
34    render_pass: WebGPURenderPass,
35    command_encoder: Dom<GPUCommandEncoder>,
36}
37
38impl GPURenderPassEncoder {
39    fn new_inherited(
40        channel: WebGPU,
41        render_pass: WebGPURenderPass,
42        parent: &GPUCommandEncoder,
43        label: USVString,
44    ) -> Self {
45        Self {
46            channel,
47            reflector_: Reflector::new(),
48            label: DomRefCell::new(label),
49            render_pass,
50            command_encoder: Dom::from_ref(parent),
51        }
52    }
53
54    pub(crate) fn new(
55        global: &GlobalScope,
56        channel: WebGPU,
57        render_pass: WebGPURenderPass,
58        parent: &GPUCommandEncoder,
59        label: USVString,
60        can_gc: CanGc,
61    ) -> DomRoot<Self> {
62        reflect_dom_object(
63            Box::new(GPURenderPassEncoder::new_inherited(
64                channel,
65                render_pass,
66                parent,
67                label,
68            )),
69            global,
70            can_gc,
71        )
72    }
73
74    fn send_render_command(&self, render_command: RenderCommand) {
75        if let Err(e) = self.channel.0.send(WebGPURequest::RenderPassCommand {
76            render_pass_id: self.render_pass.0,
77            render_command,
78            device_id: self.command_encoder.device_id().0,
79        }) {
80            warn!("Error sending WebGPURequest::RenderPassCommand: {e:?}")
81        }
82    }
83}
84
85impl GPURenderPassEncoderMethods<crate::DomTypeHolder> for GPURenderPassEncoder {
86    /// <https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label>
87    fn Label(&self) -> USVString {
88        self.label.borrow().clone()
89    }
90
91    /// <https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label>
92    fn SetLabel(&self, value: USVString) {
93        *self.label.borrow_mut() = value;
94    }
95
96    /// <https://gpuweb.github.io/gpuweb/#dom-gpuprogrammablepassencoder-setbindgroup>
97    fn SetBindGroup(&self, index: u32, bind_group: &GPUBindGroup, offsets: Vec<u32>) {
98        self.send_render_command(RenderCommand::SetBindGroup {
99            index,
100            bind_group_id: bind_group.id().0,
101            offsets,
102        })
103    }
104
105    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-setviewport>
106    fn SetViewport(
107        &self,
108        x: Finite<f32>,
109        y: Finite<f32>,
110        width: Finite<f32>,
111        height: Finite<f32>,
112        min_depth: Finite<f32>,
113        max_depth: Finite<f32>,
114    ) {
115        self.send_render_command(RenderCommand::SetViewport {
116            x: *x,
117            y: *y,
118            width: *width,
119            height: *height,
120            min_depth: *min_depth,
121            max_depth: *max_depth,
122        })
123    }
124
125    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-setscissorrect>
126    fn SetScissorRect(&self, x: u32, y: u32, width: u32, height: u32) {
127        self.send_render_command(RenderCommand::SetScissorRect {
128            x,
129            y,
130            width,
131            height,
132        })
133    }
134
135    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-setblendcolor>
136    fn SetBlendConstant(&self, color: GPUColor) -> Fallible<()> {
137        self.send_render_command(RenderCommand::SetBlendConstant((&color).try_convert()?));
138        Ok(())
139    }
140
141    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-setstencilreference>
142    fn SetStencilReference(&self, reference: u32) {
143        self.send_render_command(RenderCommand::SetStencilReference(reference))
144    }
145
146    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-end>
147    fn End(&self) {
148        if let Err(e) = self.channel.0.send(WebGPURequest::EndRenderPass {
149            render_pass_id: self.render_pass.0,
150            device_id: self.command_encoder.device_id().0,
151            command_encoder_id: self.command_encoder.id().0,
152        }) {
153            warn!("Failed to send WebGPURequest::EndRenderPass: {e:?}");
154        }
155    }
156
157    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-setpipeline>
158    fn SetPipeline(&self, pipeline: &GPURenderPipeline) {
159        self.send_render_command(RenderCommand::SetPipeline(pipeline.id().0))
160    }
161
162    /// <https://gpuweb.github.io/gpuweb/#dom-gpurendercommandsmixin-setindexbuffer>
163    fn SetIndexBuffer(
164        &self,
165        buffer: &GPUBuffer,
166        index_format: GPUIndexFormat,
167        offset: u64,
168        size: u64,
169    ) {
170        self.send_render_command(RenderCommand::SetIndexBuffer {
171            buffer_id: buffer.id().0,
172            index_format: match index_format {
173                GPUIndexFormat::Uint16 => wgpu_types::IndexFormat::Uint16,
174                GPUIndexFormat::Uint32 => wgpu_types::IndexFormat::Uint32,
175            },
176            offset,
177            size: wgpu_types::BufferSize::new(size),
178        })
179    }
180
181    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-setvertexbuffer>
182    fn SetVertexBuffer(&self, slot: u32, buffer: &GPUBuffer, offset: u64, size: u64) {
183        self.send_render_command(RenderCommand::SetVertexBuffer {
184            slot,
185            buffer_id: buffer.id().0,
186            offset,
187            size: wgpu_types::BufferSize::new(size),
188        })
189    }
190
191    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-draw>
192    fn Draw(&self, vertex_count: u32, instance_count: u32, first_vertex: u32, first_instance: u32) {
193        self.send_render_command(RenderCommand::Draw {
194            vertex_count,
195            instance_count,
196            first_vertex,
197            first_instance,
198        })
199    }
200
201    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindexed>
202    fn DrawIndexed(
203        &self,
204        index_count: u32,
205        instance_count: u32,
206        first_index: u32,
207        base_vertex: i32,
208        first_instance: u32,
209    ) {
210        self.send_render_command(RenderCommand::DrawIndexed {
211            index_count,
212            instance_count,
213            first_index,
214            base_vertex,
215            first_instance,
216        })
217    }
218
219    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindirect>
220    fn DrawIndirect(&self, buffer: &GPUBuffer, offset: u64) {
221        self.send_render_command(RenderCommand::DrawIndirect {
222            buffer_id: buffer.id().0,
223            offset,
224        })
225    }
226
227    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderencoderbase-drawindexedindirect>
228    fn DrawIndexedIndirect(&self, buffer: &GPUBuffer, offset: u64) {
229        self.send_render_command(RenderCommand::DrawIndexedIndirect {
230            buffer_id: buffer.id().0,
231            offset,
232        })
233    }
234
235    /// <https://gpuweb.github.io/gpuweb/#dom-gpurenderpassencoder-executebundles>
236    #[allow(unsafe_code)]
237    fn ExecuteBundles(&self, bundles: Vec<DomRoot<GPURenderBundle>>) {
238        let bundle_ids: Vec<_> = bundles.iter().map(|b| b.id().0).collect();
239        self.send_render_command(RenderCommand::ExecuteBundles(bundle_ids))
240    }
241}
242
243impl Drop for GPURenderPassEncoder {
244    fn drop(&mut self) {
245        if let Err(e) = self
246            .channel
247            .0
248            .send(WebGPURequest::DropRenderPass(self.render_pass.0))
249        {
250            warn!("Failed to send WebGPURequest::DropRenderPass with {e:?}");
251        }
252    }
253}
script/dom/webgpu/gpurenderpassencoder.rs

script/dom/webgpu/
gpurenderpassencoder.rs
