Represents the set of parameters that will be used to create a compute shader buffer on the device when it will be added to a compute pass using vtkWebGPUComputePass::AddBuffer() More...

#include <vtkWebGPUComputeBuffer.h>

Inheritance diagram for vtkWebGPUComputeBuffer:

[legend]

Collaboration diagram for vtkWebGPUComputeBuffer:

[legend]

Public Types
enum	BufferMode { UNDEFINED = 0 , READ_ONLY_COMPUTE_STORAGE , READ_WRITE_COMPUTE_STORAGE , READ_WRITE_MAP_COMPUTE_STORAGE , UNIFORM_BUFFER }

enum	BufferDataType { VTK_DATA_ARRAY = 0 , STD_VECTOR }
	Because the compute buffer can accept multiple data types as input (std::vector, vtkDataArray) but will ultimately only use one, it has to be determined which data to use thanks to this enum. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkWebGPUComputeBuffer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

template<typename T >
void	SetData (const std::vector< T > &data)
	Sets the data that will be used by the buffer.

void	SetData (vtkDataArray *data)
	Sets the data that will be used by the buffer.

const void *	GetDataPointer ()
	The pointer to the std::vector<> data passed with SetData(std::vector)

vtkDataArray *	GetDataArray ()
	The pointer to the vtkDataArray passed with SetData(vtkDataArray)


	vtkGetEnumMacro (Mode, BufferMode)
	Get/set the buffer mode.

	vtkSetEnumMacro (Mode, BufferMode)
	Get/set the buffer mode.


uint32_t	GetGroup () const
	Get/set the group of the buffer in the compute shader.

virtual vtkIdType	GetGroup ()
	Get/set the group of the buffer in the compute shader.

virtual void	SetGroup (vtkIdType)
	Get/set the group of the buffer in the compute shader.


uint32_t	GetBinding () const
	Get/set the binding of the buffer in the compute shader.

virtual vtkIdType	GetBinding ()
	Get/set the binding of the buffer in the compute shader.

virtual void	SetBinding (vtkIdType)
	Get/set the binding of the buffer in the compute shader.


virtual std::string	GetLabel ()
	Get/set the label of the buffer.

virtual void	SetLabel (std::string)
	Get/set the label of the buffer.


virtual BufferDataType	GetDataType ()
	Get/set what data type to use for the buffer.

virtual void	SetDataType (BufferDataType)
	Get/set what data type to use for the buffer.


virtual vtkIdType	GetByteSize ()
	Get/set the size in bytes of the data passed in via SetData().

virtual void	SetByteSize (vtkIdType)
	Get/set the size in bytes of the data passed in via SetData().

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWebGPUComputeBuffer *	SafeDownCast (vtkObjectBase *o)

static vtkWebGPUComputeBuffer *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWebGPUComputeBuffer ()

	~vtkWebGPUComputeBuffer () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Friends
class	vtkWebGPUComputePass

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Represents the set of parameters that will be used to create a compute shader buffer on the device when it will be added to a compute pass using vtkWebGPUComputePass::AddBuffer()

Definition at line 26 of file vtkWebGPUComputeBuffer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWebGPUComputeBuffer::Superclass

Definition at line 29 of file vtkWebGPUComputeBuffer.h.

Member Enumeration Documentation

◆ BufferMode

enum vtkWebGPUComputeBuffer::BufferMode

UNDEFINED = Buffer mode not set
READ_ONLY_COMPUTE_STORAGE = The GPU can only read from this buffer. A buffer with this mode is declared with <read, storage> in WGSL
READ_WRITE_COMPUTE_STORAGE = The GPU can read from and write to this buffer from the compute shader. A buffer with this mode is declared with <read_write, storage> in WGSL
READ_WRITE_MAP_COMPUTE_STORAGE = The GPU can read from and write to this buffer from the compute shader. With this mode, the buffer can also be mapped so that the CPU can read from it (typically to read back the results from the compute shader). A buffer using this mode is declared with <read_write, storage> in WGSL
UNIFORM_BUFFER = Uniform buffer, read only by the GPU. A buffer with this mode is declared with var<uniform> in WGSL

Enumerator
UNDEFINED
READ_ONLY_COMPUTE_STORAGE
READ_WRITE_COMPUTE_STORAGE
READ_WRITE_MAP_COMPUTE_STORAGE
UNIFORM_BUFFER

Definition at line 52 of file vtkWebGPUComputeBuffer.h.

◆ BufferDataType

enum vtkWebGPUComputeBuffer::BufferDataType

Because the compute buffer can accept multiple data types as input (std::vector, vtkDataArray) but will ultimately only use one, it has to be determined which data to use thanks to this enum.

STD_VECTOR = Use the data given to the buffer in the form of an std::vector. Default VTK_DATA_ARRAY = Use the data given to the buffer in the form of a vtkDataArray

Enumerator
VTK_DATA_ARRAY
STD_VECTOR

Definition at line 69 of file vtkWebGPUComputeBuffer.h.

Constructor & Destructor Documentation

◆ vtkWebGPUComputeBuffer()

vtkWebGPUComputeBuffer::vtkWebGPUComputeBuffer ( )

protected

◆ ~vtkWebGPUComputeBuffer()

vtkWebGPUComputeBuffer::~vtkWebGPUComputeBuffer ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkWebGPUComputeBuffer::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkWebGPUComputeBuffer::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

Reimplemented in vtkWebGPUComputeRenderBuffer.

◆ SafeDownCast()

static vtkWebGPUComputeBuffer * vtkWebGPUComputeBuffer::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUComputeBuffer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkWebGPUComputeRenderBuffer.

◆ NewInstance()

vtkWebGPUComputeBuffer * vtkWebGPUComputeBuffer::NewInstance ( ) const

◆ New()

static vtkWebGPUComputeBuffer * vtkWebGPUComputeBuffer::New ( )

static

◆ PrintSelf()

void vtkWebGPUComputeBuffer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkWebGPUComputeRenderBuffer.

◆ vtkGetEnumMacro()

vtkWebGPUComputeBuffer::vtkGetEnumMacro	(	Mode	,
		BufferMode
	)

Get/set the buffer mode.

◆ vtkSetEnumMacro()

vtkWebGPUComputeBuffer::vtkSetEnumMacro	(	Mode	,
		BufferMode
	)

Get/set the buffer mode.

◆ GetGroup() [1/2]

uint32_t vtkWebGPUComputeBuffer::GetGroup ( ) const

inline

Get/set the group of the buffer in the compute shader.

This refers to @group(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

Definition at line 91 of file vtkWebGPUComputeBuffer.h.

◆ GetGroup() [2/2]

virtual vtkIdType vtkWebGPUComputeBuffer::GetGroup ( )

virtual

Get/set the group of the buffer in the compute shader.

This refers to @group(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

◆ SetGroup()

virtual void vtkWebGPUComputeBuffer::SetGroup ( vtkIdType )

virtual

Get/set the group of the buffer in the compute shader.

This refers to @group(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

◆ GetBinding() [1/2]

uint32_t vtkWebGPUComputeBuffer::GetBinding ( ) const

inline

Get/set the binding of the buffer in the compute shader.

This refers to @binding(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

Definition at line 104 of file vtkWebGPUComputeBuffer.h.

◆ GetBinding() [2/2]

virtual vtkIdType vtkWebGPUComputeBuffer::GetBinding ( )

virtual

Get/set the binding of the buffer in the compute shader.

This refers to @binding(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

◆ SetBinding()

virtual void vtkWebGPUComputeBuffer::SetBinding ( vtkIdType )

virtual

Get/set the binding of the buffer in the compute shader.

This refers to @binding(X) in the WGSL shader code.

Note: : All buffers must have a unique combination of binding / group. No buffers can have the same binding / group as another buffer

◆ GetLabel()

virtual std::string vtkWebGPUComputeBuffer::GetLabel ( )

virtual

Get/set the label of the buffer.

Useful for debugging errors that may come up in the terminal since these errors will include the given label

◆ SetLabel()

virtual void vtkWebGPUComputeBuffer::SetLabel ( std::string )

virtual

Get/set the label of the buffer.

Useful for debugging errors that may come up in the terminal since these errors will include the given label

◆ SetData() [1/2]

template<typename T >

void vtkWebGPUComputeBuffer::SetData ( const std::vector< T > & data )

inline

Sets the data that will be used by the buffer.

Passing an empty vector to this method clears any previously given std::vector data, allowing for the use of a vtkDataArray instead.

Warning: : This does not copy the data so the data given to this buffer needs to stay valid (i.e. not freed) until the buffer is added to a compute pass using vtkWebGPUComputePass::AddBuffer().

Definition at line 128 of file vtkWebGPUComputeBuffer.h.

◆ SetData() [2/2]

void vtkWebGPUComputeBuffer::SetData ( vtkDataArray * data )

Sets the data that will be used by the buffer.

Passing a nullptr vtkDataArray clears any previously given vtkDataArray data allowing the use of std::vector data instead.

NOTE: This does not copy the data so the data given to this buffer needs to stay valid (i.e. not freed) until the buffer is added to a compute pass using vtkWebGPUComputePass::AddBuffer().

◆ GetDataType()

virtual BufferDataType vtkWebGPUComputeBuffer::GetDataType ( )

virtual

Get/set what data type to use for the buffer.

◆ SetDataType()

virtual void vtkWebGPUComputeBuffer::SetDataType ( BufferDataType )

virtual

Get/set what data type to use for the buffer.

◆ GetDataPointer()

const void * vtkWebGPUComputeBuffer::GetDataPointer ( )

inline

The pointer to the std::vector<> data passed with SetData(std::vector)

Warning: : This pointer only points to a valid location as long as the std::vector given with SetData() is alive.

Definition at line 159 of file vtkWebGPUComputeBuffer.h.

◆ GetDataArray()

vtkDataArray * vtkWebGPUComputeBuffer::GetDataArray ( )

inline

The pointer to the vtkDataArray passed with SetData(vtkDataArray)

Warning: : This pointer to the array is only valid as long as the vtkDataArray given with SetData() is alive.

Definition at line 167 of file vtkWebGPUComputeBuffer.h.

◆ GetByteSize()

virtual vtkIdType vtkWebGPUComputeBuffer::GetByteSize ( )

virtual

Get/set the size in bytes of the data passed in via SetData().

◆ SetByteSize()

virtual void vtkWebGPUComputeBuffer::SetByteSize ( vtkIdType )

virtual

Get/set the size in bytes of the data passed in via SetData().

Friends And Related Symbol Documentation

◆ vtkWebGPUComputePass

friend class vtkWebGPUComputePass

friend

Definition at line 182 of file vtkWebGPUComputeBuffer.h.

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

Rendering/WebGPU/vtkWebGPUComputeBuffer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ BufferMode

◆ BufferDataType

Constructor & Destructor Documentation

◆ vtkWebGPUComputeBuffer()

◆ ~vtkWebGPUComputeBuffer()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ PrintSelf()

◆ vtkGetEnumMacro()

◆ vtkSetEnumMacro()

◆ GetGroup() [1/2]

◆ GetGroup() [2/2]

◆ SetGroup()

◆ GetBinding() [1/2]

◆ GetBinding() [2/2]

◆ SetBinding()

◆ GetLabel()

◆ SetLabel()

◆ SetData() [1/2]

◆ SetData() [2/2]

◆ GetDataType()

◆ SetDataType()

◆ GetDataPointer()

◆ GetDataArray()

◆ GetByteSize()

◆ SetByteSize()

Friends And Related Symbol Documentation

◆ vtkWebGPUComputePass