VTK  9.4.20250209
vtkWebGPURenderer.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
3#ifndef vtkWebGPURenderer_h
4#define vtkWebGPURenderer_h
5
6#include "vtkRenderer.h"
7
8#include "vtkRenderingWebGPUModule.h" // for export macro
9#include "vtkSmartPointer.h" // for ivar
10#include "vtkWebGPUComputePipeline.h" // for the compute pipelines used by this renderer
11#include "vtk_wgpu.h" // for webgpu
12
13#include <unordered_set> // for the set of actors rendered last frame
14
16class vtkRenderState;
18
19VTK_ABI_NAMESPACE_BEGIN
20
22
23class VTKRENDERINGWEBGPU_EXPORT vtkWebGPURenderer : public vtkRenderer
24{
25public:
28 void PrintSelf(ostream& os, vtkIndent indent) override;
29
31 {
33 wgpu::RenderPipeline Pipeline;
34 };
35
36 // get the complexity of the current lights as a int
37 // 0 = no lighting
38 // 1 = headlight
39 // 2 = directional lights
40 // 3 = positional lights
42 {
43 NoLighting = 0,
44 Headlight = 1,
45 Directional = 2,
46 Positional = 3
47 };
48 vtkGetMacro(LightingComplexity, int);
49
51 {
56 RenderPostRasterization
57 };
58
62 void Clear() override;
63
67 void DeviceRender() override;
68
75
81 int UpdateGeometry(vtkFrameBufferObjectBase* fbo = nullptr) override;
82
91
97
99
103 const std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>>& GetSetupPreRenderComputePipelines();
104 const std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>>&
107
108 int UpdateLights() override;
109
110 void SetEnvironmentTexture(vtkTexture* texture, bool isSRGB = false) override;
111
113
114 inline wgpu::RenderPassEncoder GetRenderPassEncoder() { return this->WGPURenderEncoder; }
115 inline wgpu::RenderBundleEncoder GetRenderBundleEncoder() { return this->WGPUBundleEncoder; }
116 inline wgpu::BindGroup GetSceneBindGroup() { return this->SceneBindGroup; }
117
118 inline void PopulateBindgroupLayouts(std::vector<wgpu::BindGroupLayout>& layouts)
119 {
120 layouts.emplace_back(this->SceneBindGroupLayout);
121 }
122
124
131
135 std::unordered_set<vtkProp*> GetPropsRendered() { return this->PropsRendered; }
136
138
145
147
153 vtkSetMacro(UseRenderBundles, bool);
154 vtkBooleanMacro(UseRenderBundles, bool);
155 vtkGetMacro(UseRenderBundles, bool);
157
168
175 inline void InvalidateBundle() { this->RebuildRenderBundle = true; }
176
180 vtkGetMacro(RebuildRenderBundle, bool);
181
182protected:
185
194
195 // Setup scene and actor bindgroups. Actor has dynamic offsets.
197 // Create buffers for the bind groups.
199 // Create scene bind group.
201
202 // Start, finish recording commands with render pass encoder
205
206 std::size_t WriteLightsBuffer(std::size_t offset = 0);
207 std::size_t WriteSceneTransformsBuffer(std::size_t offset = 0);
208
209 wgpu::RenderPassEncoder WGPURenderEncoder;
210 wgpu::RenderBundleEncoder WGPUBundleEncoder;
212 wgpu::Buffer SceneLightsBuffer;
213 std::size_t LastActorBufferSize = 0;
214 wgpu::BindGroup SceneBindGroup;
215 wgpu::BindGroupLayout SceneBindGroupLayout;
216
217#ifdef __EMSCRIPTEN__
218 bool UseRenderBundles = true;
219#else
220 bool UseRenderBundles = false;
221#endif
222 bool RebuildRenderBundle = false;
223 // the commands in bundle get reused every frame.
224 wgpu::RenderBundle Bundle;
225
226 int LightingComplexity = 0;
227 std::size_t NumberOfLightsUsed = 0;
228 std::vector<std::size_t> LightIDs;
229
232
237
238private:
240 // For the mapper to access 'AddPostRasterizationActor'
242 // For render window accessing PostRenderComputePipelines()
244
245 vtkWebGPURenderer(const vtkWebGPURenderer&) = delete;
246 void operator=(const vtkWebGPURenderer&) = delete;
247
251 void InitComputePipeline(vtkSmartPointer<vtkWebGPUComputePipeline> pipeline);
252
254
261 void PreRenderComputePipelines();
262 void PostRenderComputePipelines();
264
275 void PostRasterizationRender();
276
280 void AddPostRasterizationActor(vtkActor* actor);
281
286 std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>> SetupPreRenderComputePipelines;
287 std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>> SetupPostRenderComputePipelines;
288
292 std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>> NotSetupPreRenderComputePipelines;
293 std::vector<vtkSmartPointer<vtkWebGPUComputePipeline>> NotSetupPostRenderComputePipelines;
294
302 std::vector<vtkActor*> PostRasterizationActors;
303
307 wgpu::CommandBuffer EncodePropListRenderCommand(vtkProp** propList, int listLength);
308
313 bool ComputeBuffersInitialized = false;
314
319 RenderStageEnum RenderStage = RenderStageEnum::AwaitingPreparation;
320
324 bool DoClearPass = true;
325
332 std::unordered_set<vtkProp*> PropsRendered;
333};
334
335VTK_ABI_NAMESPACE_END
336#endif
abstract class specifies interface to map data
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:151
abstract interface to OpenGL FBOs
a simple class to control print indentation
Definition vtkIndent.h:108
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:66
Context in which a vtkRenderPass will render.
abstract specification for renderers
Hold a reference to a vtkObjectBase instance.
handles properties associated with a texture map
Definition vtkTexture.h:168
record modification and/or execution time
describes linear transformations via a 4x4 matrix
This culler does both frustum culling and occlusion culling.
The point cloud renderer uses WebGPU compute shaders to render the point cells of a polydata onto the...
WebGPU rendering window.
void ConfigureComputeRenderBuffers(vtkSmartPointer< vtkWebGPUComputePipeline > computePipeline)
Set up the buffers of a given vtkWebGPUComputePass.
void SetupSceneBindGroup()
void ReleaseGraphicsResources(vtkWindow *w) override
static vtkWebGPURenderer * New()
wgpu::Buffer SceneTransformBuffer
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ConfigureComputePipelines()
Sets the adapter and the device of the render window of this renderer to the compute pipelines of thi...
vtkTimeStamp LightingUploadTimestamp
void AddPostRenderComputePipeline(vtkSmartPointer< vtkWebGPUComputePipeline > pipeline)
Adds a compute pipeline to the renderer that will be executed each frame before/after the rendering p...
wgpu::RenderBundle Bundle
wgpu::BindGroup GetSceneBindGroup()
std::size_t WriteSceneTransformsBuffer(std::size_t offset=0)
int UpdateOpaquePolygonalGeometry() override
Request mappers to run the vtkAlgorithm pipeline (if needed) and consequently update device buffers c...
std::size_t WriteLightsBuffer(std::size_t offset=0)
int UpdateTranslucentPolygonalGeometry() override
Ask all props to update and draw any translucent polygonal geometry.
int UpdateGeometry(vtkFrameBufferObjectBase *fbo=nullptr) override
Ask all props to update and draw any opaque and translucent geometry.
int UpdateLights() override
Ask all lights to load themselves into rendering pipeline.
void SetUserLightTransform(vtkTransform *transform)
Set the user light transform applied after the camera transform.
wgpu::RenderPassEncoder WGPURenderEncoder
void PopulateBindgroupLayouts(std::vector< wgpu::BindGroupLayout > &layouts)
wgpu::Buffer SceneLightsBuffer
std::unordered_set< vtkProp * > GetPropsRendered()
Returns the list of the actors that were rendered last frame.
void Clear() override
Clear the image to the background color.
wgpu::RenderBundleEncoder WGPUBundleEncoder
vtkTransform * GetUserLightTransform()
Set the user light transform applied after the camera transform.
void DeviceRender() override
Create an image.
wgpu::BindGroup SceneBindGroup
void InvalidateBundle()
Forces the renderer to re-record draw commands into a render bundle.
vtkSmartPointer< vtkTransform > UserLightTransform
Optional user transform for lights.
void AddPreRenderComputePipeline(vtkSmartPointer< vtkWebGPUComputePipeline > pipeline)
Adds a compute pipeline to the renderer that will be executed each frame before/after the rendering p...
wgpu::RenderBundleEncoder GetRenderBundleEncoder()
~vtkWebGPURenderer() override
std::vector< std::size_t > LightIDs
wgpu::RenderPassEncoder GetRenderPassEncoder()
void UpdateBuffers()
Updates / creates the various buffer necessary for the rendering of the props.
const std::vector< vtkSmartPointer< vtkWebGPUComputePipeline > > & GetSetupPostRenderComputePipelines()
Returns the list of compute pipelines of this renderer that have been setup for execution before/afte...
vtkGetEnumMacro(RenderStage, RenderStageEnum)
Query the stage in the rendering process.
const std::vector< vtkSmartPointer< vtkWebGPUComputePipeline > > & GetSetupPreRenderComputePipelines()
Returns the list of compute pipelines of this renderer that have been setup for execution before/afte...
wgpu::BindGroupLayout SceneBindGroupLayout
void SetEnvironmentTexture(vtkTexture *texture, bool isSRGB=false) override
Set/Get the environment texture used for image based lighting.
vtkMTimeType LightingUpdateTime
void SetupBindGroupLayouts()
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
vtkSmartPointer< vtkPropCollection > Props
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270