vtkWebGPUCommandEncoderDebugGroup Class Reference

Convenient class that inserts annotations around draw commands within a render pass/bundle. More...

#include <vtkWebGPUCommandEncoderDebugGroup.h>

Public Member Functions
	vtkWebGPUCommandEncoderDebugGroup (const wgpu::RenderPassEncoder &passEncoder, const char *groupLabel)
	vtkWebGPUCommandEncoderDebugGroup (const wgpu::RenderBundleEncoder &passEncoder, const char *groupLabel)
	~vtkWebGPUCommandEncoderDebugGroup ()
	vtkWebGPUCommandEncoderDebugGroup ()=delete
	vtkWebGPUCommandEncoderDebugGroup (const vtkWebGPUCommandEncoderDebugGroup &)=delete
void	operator= (const vtkWebGPUCommandEncoderDebugGroup &)=delete
	vtkWebGPUCommandEncoderDebugGroup (vtkWebGPUCommandEncoderDebugGroup &&)=delete
void	operator= (vtkWebGPUCommandEncoderDebugGroup &&)=delete

Detailed Description

Convenient class that inserts annotations around draw commands within a render pass/bundle.

Implementation classes can use the vtkScopedEncoderDebugGroup(encoder, label) macro to automatically push a debug group in the encoder using a label string. Upon leaving scope, this class will take care of popping the debug group. The label string will appear in professional graphics debugging tools like RenderDoc/NSight/apitrace and is very useful to isolate draw commands. You may use indicators like class names, pointer addresses, line numbers, array names to make sense of the draw commands by mapping their origins to VTK C++ code.

Definition at line 27 of file vtkWebGPUCommandEncoderDebugGroup.h.

Constructor & Destructor Documentation

vtkWebGPUCommandEncoderDebugGroup() [1/5]

vtkWebGPUCommandEncoderDebugGroup::vtkWebGPUCommandEncoderDebugGroup	(	const wgpu::RenderPassEncoder &	passEncoder,
		const char *	groupLabel
	)

vtkWebGPUCommandEncoderDebugGroup() [2/5]

vtkWebGPUCommandEncoderDebugGroup::vtkWebGPUCommandEncoderDebugGroup	(	const wgpu::RenderBundleEncoder &	passEncoder,
		const char *	groupLabel
	)

~vtkWebGPUCommandEncoderDebugGroup()

vtkWebGPUCommandEncoderDebugGroup::~vtkWebGPUCommandEncoderDebugGroup

(

)

vtkWebGPUCommandEncoderDebugGroup() [3/5]

vtkWebGPUCommandEncoderDebugGroup::vtkWebGPUCommandEncoderDebugGroup ( )

delete

vtkWebGPUCommandEncoderDebugGroup() [4/5]

vtkWebGPUCommandEncoderDebugGroup::vtkWebGPUCommandEncoderDebugGroup ( const vtkWebGPUCommandEncoderDebugGroup &  )

delete

vtkWebGPUCommandEncoderDebugGroup() [5/5]

vtkWebGPUCommandEncoderDebugGroup::vtkWebGPUCommandEncoderDebugGroup ( vtkWebGPUCommandEncoderDebugGroup &&  )

delete

Member Function Documentation

operator=() [1/2]

void vtkWebGPUCommandEncoderDebugGroup::operator= ( const vtkWebGPUCommandEncoderDebugGroup &  )

delete

operator=() [2/2]

void vtkWebGPUCommandEncoderDebugGroup::operator= ( vtkWebGPUCommandEncoderDebugGroup &&  )

delete

---

The documentation for this class was generated from the following file:

• Rendering/WebGPU/vtkWebGPUCommandEncoderDebugGroup.h