Abstraction class for WebGPU textures. More...

#include <vtkWebGPUTexture.h>

Inheritance diagram for vtkWebGPUTexture:

Collaboration diagram for vtkWebGPUTexture:

Public Types
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.

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 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

	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

Abstraction class for WebGPU textures.

This class mainly holds a bunch of parameters needed for the creation of a texture.

Definition at line 16 of file vtkWebGPUTexture.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWebGPUTexture::Superclass

Definition at line 19 of file vtkWebGPUTexture.h.

Member Enumeration Documentation

◆ TextureFormat

enum vtkWebGPUTexture::TextureFormat

RGBA8_UNORM: Uses RGB + alpha.

Default. BGRA8_UNORM: Uses BGR + alpha. Used by the framebuffer of WebGPU render windows R32_FLOAT: Only a 32 bit float red channel DEPTH_24_PLUS: 24 bit depth format DEPTH_24_PLUS_8_STENCIL: 24 bit depth format + 8 bit stencil

Enumerator
RGBA8_UNORM
BGRA8_UNORM
R32_FLOAT
DEPTH_24_PLUS
DEPTH_24_PLUS_8_STENCIL

Definition at line 31 of file vtkWebGPUTexture.h.

◆ TextureDimension

enum vtkWebGPUTexture::TextureDimension

How the texture data is arranged.

Affects the type of sampler used in the compute shader

DIMENSION_1D: 1D texture DIMENSION_2D: 2D texture. Default. DIMENSION_3D: 3D texture

Enumerator
DIMENSION_1D
DIMENSION_2D
DIMENSION_3D

Definition at line 47 of file vtkWebGPUTexture.h.

◆ TextureMode

enum vtkWebGPUTexture::TextureMode

How will the texture be used by the shader.

UNDEFINED: Texture mode not set. Default. READ_ONLY: The compute shader can only read from the texture and a sampler can be used WRITE_ONLY_STORAGE: The compute shader can only write to the texture and a sampler cannot be used READ_WRITE_STORAGE: The compute shader can read and write to the texture and a sampler cannot be used

Enumerator
UNDEFINED
READ_ONLY
WRITE_ONLY_STORAGE
READ_WRITE_STORAGE

Definition at line 64 of file vtkWebGPUTexture.h.

◆ TextureSampleType

enum vtkWebGPUTexture::TextureSampleType

Determines what kind of value is returned when reading from the texture in the compute shader.

FLOAT: Reading from the texture returns float values. Default. UNFILTERABLE_FLOAT: Float but cannot be filtered by a sampler DEPTH: Used for depth textures. The depth is returned as a float in the first channel of the return vec4 SIGNED_INT: Signed integers. Used for textures containing signed integers data UNSIGNED_INT: Unsigned integers. Used for textures containing unsigned integers data

Enumerator
FLOAT
UNFILTERABLE_FLOAT
DEPTH
SIGNED_INT
UNSIGNED_INT

Definition at line 82 of file vtkWebGPUTexture.h.

◆ TextureDataType

enum vtkWebGPUTexture::TextureDataType

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.

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

Enumerator
VTK_DATA_ARRAY
STD_VECTOR

Definition at line 99 of file vtkWebGPUTexture.h.

Constructor & Destructor Documentation

◆ vtkWebGPUTexture()

vtkWebGPUTexture::vtkWebGPUTexture ( )

protected

◆ ~vtkWebGPUTexture()

vtkWebGPUTexture::~vtkWebGPUTexture ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUTexture::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkWebGPUComputeRenderTexture, and vtkWebGPUComputeTexture.

◆ NewInstance()

vtkWebGPUTexture * vtkWebGPUTexture::NewInstance ( ) const

◆ New()

static vtkWebGPUTexture * vtkWebGPUTexture::New ( )

static

◆ PrintSelf()

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

◆ GetBytesPerPixel()

virtual unsigned int vtkWebGPUTexture::GetBytesPerPixel ( ) const

virtual

Number of bytes used per pixel.

◆ GetPixelComponentsCount()

unsigned int vtkWebGPUTexture::GetPixelComponentsCount ( ) const

Returns the number of components per pixel for the format of this texture.

1 for R32_FLOAT or for RGBA8 for example.

◆ GetWidth()

unsigned int vtkWebGPUTexture::GetWidth ( ) const

inline

Get/set the width in pixels of the texture.

Definition at line 120 of file vtkWebGPUTexture.h.

◆ SetWidth()

void vtkWebGPUTexture::SetWidth ( unsigned int width )

inline

Get/set the width in pixels of the texture.

Definition at line 121 of file vtkWebGPUTexture.h.

◆ GetHeight()

unsigned int vtkWebGPUTexture::GetHeight ( ) const

inline

Get/set the height in pixels of the texture.

Definition at line 128 of file vtkWebGPUTexture.h.

◆ SetHeight()

void vtkWebGPUTexture::SetHeight ( unsigned int height )

inline

Get/set the height in pixels of the texture.

Definition at line 129 of file vtkWebGPUTexture.h.

◆ GetDepth()

unsigned int vtkWebGPUTexture::GetDepth ( ) const

inline

Get/set the depth in pixels of the texture.

Definition at line 136 of file vtkWebGPUTexture.h.

◆ SetDepth()

void vtkWebGPUTexture::SetDepth ( unsigned int depth )

inline

Get/set the depth in pixels of the texture.

Definition at line 137 of file vtkWebGPUTexture.h.