Represents the set of parameters that will be used to create a compute shader texture on the device when it will be added to a pipeline using vtkWebGPUComputePipeline::AddTexture() More...

#include <vtkWebGPUComputeTexture.h>

Inheritance diagram for vtkWebGPUComputeTexture:

[legend]

Collaboration diagram for vtkWebGPUComputeTexture:

[legend]

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkWebGPUTexture
enum	TextureFormat { RGBA8_UNORM = 0 , BGRA8_UNORM , R32_FLOAT , DEPTH_24_PLUS , DEPTH_24_PLUS_8_STENCIL }
	RGBA8_UNORM: Uses RGB + alpha. More...

enum	TextureDimension { DIMENSION_1D = 0 , DIMENSION_2D , DIMENSION_3D }
	How the texture data is arranged. More...

enum	TextureMode { UNDEFINED = 0 , READ_ONLY , WRITE_ONLY_STORAGE , READ_WRITE_STORAGE }
	How will the texture be used by the shader. More...

enum	TextureSampleType { FLOAT = 0 , UNFILTERABLE_FLOAT , DEPTH , SIGNED_INT , UNSIGNED_INT }
	Determines what kind of value is returned when reading from the texture in the compute shader. More...

enum	TextureDataType { VTK_DATA_ARRAY = 0 , STD_VECTOR }
	Because the compute texture 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.

vtkWebGPUComputeTexture *	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 texture.

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

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)


virtual vtkIdType	GetByteSize ()
	Get/set the size in bytes of the texture.

virtual void	SetByteSize (vtkIdType)
	Get/set the size in bytes of the texture.


virtual TextureDataType	GetDataType ()
	Get/set what data type to use for the texture.

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


const std::string &	GetLabel () const
	Get/set the label used for debugging in case of errors.

virtual std::string &	GetLabel ()
	Get/set the label used for debugging in case of errors.

virtual void	SetLabel (std::string)
	Get/set the label used for debugging in case of errors.

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

vtkWebGPUTexture *	NewInstance () const

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

virtual unsigned int	GetBytesPerPixel () const
	Number of bytes used per pixel.

unsigned int	GetPixelComponentsCount () const
	Returns the number of components per pixel for the format of this texture.

unsigned int	GetWidth () const
	Get/set the width in pixels of the texture.

void	SetWidth (unsigned int width)
	Get/set the width in pixels of the texture.

unsigned int	GetHeight () const
	Get/set the height in pixels of the texture.

void	SetHeight (unsigned int height)
	Get/set the height in pixels of the texture.

unsigned int	GetDepth () const
	Get/set the depth in pixels of the texture.

void	SetDepth (unsigned int depth)
	Get/set the depth in pixels of the texture.

void	GetSize (unsigned int &x, unsigned int &y, unsigned int &z) const
	Get/set the size of the texture.

void	GetSize (unsigned int &x, unsigned int &y) const
	Get/set the size of the texture.

void	GetSize (unsigned int *xyz)
	Get/set the size of the texture.

unsigned int *	GetSize ()
	Get/set the size of the texture.

virtual void	SetSize (unsigned int x, unsigned int y, unsigned int z=1)
	Get/set the size of the texture.

virtual void	SetSize (unsigned int *xyz)
	Get/set the size of the texture.

	vtkGetEnumMacro (Dimension, TextureDimension)
	Get/set the texture dimension.

	vtkSetEnumMacro (Dimension, TextureDimension)
	Get/set the texture dimension.

	vtkGetEnumMacro (Format, TextureFormat)
	Get/set the texture format.

	vtkSetEnumMacro (Format, TextureFormat)
	Get/set the texture format.

	vtkGetEnumMacro (Mode, TextureMode)
	Get/set the texture format.

	vtkSetEnumMacro (Mode, TextureMode)
	Get/set the texture format.

	vtkGetEnumMacro (SampleType, TextureSampleType)
	Get/set the texture sample type.

	vtkSetEnumMacro (SampleType, TextureSampleType)
	Get/set the texture sample type.

virtual unsigned int	GetMipLevelCount ()
	Get/set the maximum mipmap levels used by the texture.

virtual void	SetMipLevelCount (unsigned int)
	Get/set the maximum mipmap levels used by the texture.

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 vtkWebGPUComputeTexture *	SafeDownCast (vtkObjectBase *o)

static vtkWebGPUComputeTexture *	New ()

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

static vtkWebGPUTexture *	SafeDownCast (vtkObjectBase *o)

static vtkWebGPUTexture *	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

	vtkWebGPUComputeTexture ()

	~vtkWebGPUComputeTexture () override

Protected Member Functions inherited from vtkWebGPUTexture
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWebGPUTexture ()

	~vtkWebGPUTexture () 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 &)

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 texture on the device when it will be added to a pipeline using vtkWebGPUComputePipeline::AddTexture()

Some parameters have defaults for convenience:

Format defaults to RGBA
Dimension defaults to 2D
The depth of the texture (extents/size in the Z coordinate) defaults to 1
The maximum number of mip levels defaults to 0

Definition at line 28 of file vtkWebGPUComputeTexture.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWebGPUComputeTexture::Superclass

Definition at line 31 of file vtkWebGPUComputeTexture.h.

Constructor & Destructor Documentation

◆ vtkWebGPUComputeTexture()

vtkWebGPUComputeTexture::vtkWebGPUComputeTexture ( )

protected

◆ ~vtkWebGPUComputeTexture()

vtkWebGPUComputeTexture::~vtkWebGPUComputeTexture ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkWebGPUComputeTexture::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 vtkWebGPUTexture.

Reimplemented in vtkWebGPUComputeRenderTexture.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUComputeTexture::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWebGPUTexture.

Reimplemented in vtkWebGPUComputeRenderTexture.

◆ NewInstance()

vtkWebGPUComputeTexture * vtkWebGPUComputeTexture::NewInstance ( ) const

◆ New()

static vtkWebGPUComputeTexture * vtkWebGPUComputeTexture::New ( )

static

◆ PrintSelf()

void vtkWebGPUComputeTexture::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.

◆ GetByteSize()

virtual vtkIdType vtkWebGPUComputeTexture::GetByteSize ( )

virtual

Get/set the size in bytes of the texture.

◆ SetByteSize()

virtual void vtkWebGPUComputeTexture::SetByteSize ( vtkIdType )

virtual

Get/set the size in bytes of the texture.

◆ SetData() [1/2]

template<typename T >

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

inline

Sets the data that will be used by the texture.

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

Definition at line 52 of file vtkWebGPUComputeTexture.h.

◆ SetData() [2/2]

void vtkWebGPUComputeTexture::SetData ( vtkDataArray * data )

Sets the data that will be used by the texture.

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

◆ GetDataType()

virtual TextureDataType vtkWebGPUComputeTexture::GetDataType ( )

virtual

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

◆ SetDataType()

virtual void vtkWebGPUComputeTexture::SetDataType ( TextureDataType )

virtual

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

◆ GetDataPointer()

const void * vtkWebGPUComputeTexture::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 81 of file vtkWebGPUComputeTexture.h.

◆ GetDataArray()

vtkDataArray * vtkWebGPUComputeTexture::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 89 of file vtkWebGPUComputeTexture.h.

◆ GetLabel() [1/2]

const std::string & vtkWebGPUComputeTexture::GetLabel ( ) const

inline

Get/set the label used for debugging in case of errors.

Definition at line 95 of file vtkWebGPUComputeTexture.h.

◆ GetLabel() [2/2]

virtual std::string & vtkWebGPUComputeTexture::GetLabel ( )

virtual

Get/set the label used for debugging in case of errors.

◆ SetLabel()

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

virtual

Get/set the label used for debugging in case of errors.

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

Rendering/WebGPU/vtkWebGPUComputeTexture.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkWebGPUComputeTexture()

◆ ~vtkWebGPUComputeTexture()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ PrintSelf()

◆ GetByteSize()

◆ SetByteSize()

◆ SetData() [1/2]

◆ SetData() [2/2]

◆ GetDataType()

◆ SetDataType()

◆ GetDataPointer()

◆ GetDataArray()

◆ GetLabel() [1/2]

◆ GetLabel() [2/2]

◆ SetLabel()