VTK  9.4.20250206
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkWebGPUComputeRenderTexture Class Reference

Render textures are returned by calls to vtkWebGPUPolyDataMapper::AcquireXXXXRenderTexture() and represent a buffer that is used by the rendering pipeline and that can also be added to a compute pipeline. More...

#include <vtkWebGPUComputeRenderTexture.h>

Inheritance diagram for vtkWebGPUComputeRenderTexture:
[legend]
Collaboration diagram for vtkWebGPUComputeRenderTexture:
[legend]

Public Types

enum  RenderTextureType { UNDEFINED = 0 , DEPTH_BUFFER , COLOR_BUFFER }
 What type of texture of the vtk render pipeline is this ComputeRenderTexture refering to. More...
 
typedef vtkWebGPUComputeTexture Superclass
 
- Public Types inherited from vtkWebGPUComputeTexture
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.
 
vtkWebGPUComputeRenderTextureNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
 vtkGetEnumMacro (Type, RenderTextureType)
 Get/set the render texture type.
 
 vtkSetEnumMacro (Type, RenderTextureType)
 Get/set the render texture type.
 
 vtkGetEnumMacro (Aspect, vtkWebGPUComputeTextureView::TextureViewAspect)
 Get/set the texture aspect that is going to be passed to the texture view created for this render texture in the compute pass.
 
 vtkSetEnumMacro (Aspect, vtkWebGPUComputeTextureView::TextureViewAspect)
 Get/set the texture aspect that is going to be passed to the texture view created for this render texture in the compute pass.
 
void SetWebGPUTexture (wgpu::Texture texture)
 Get/set the WebGPU texture (used when this ComputeTexture points to an already existing device buffer)
 
wgpu::Texture GetWebGPUTexture ()
 Get/set the WebGPU texture (used when this ComputeTexture points to an already existing device buffer)
 
vtkWeakPointer< vtkWebGPUComputePassGetAssociatedComputePass ()
 Get/set the associated compute pass.
 
void SetAssociatedComputePass (vtkWeakPointer< vtkWebGPUComputePass > computePass)
 Get/set the associated compute pass.
 
- Public Member Functions inherited from vtkWebGPUComputeTexture
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkWebGPUComputeTextureNewInstance () 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)
 
vtkDataArrayGetDataArray ()
 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.
 
vtkWebGPUTextureNewInstance () 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.
 
vtkCommandGetCommand (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 vtkWebGPUComputeRenderTextureSafeDownCast (vtkObjectBase *o)
 
static vtkWebGPUComputeRenderTextureNew ()
 
- Static Public Member Functions inherited from vtkWebGPUComputeTexture
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGPUComputeTextureSafeDownCast (vtkObjectBase *o)
 
static vtkWebGPUComputeTextureNew ()
 
- Static Public Member Functions inherited from vtkWebGPUTexture
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGPUTextureSafeDownCast (vtkObjectBase *o)
 
static vtkWebGPUTextureNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGPUComputeRenderTexture ()
 
 ~vtkWebGPUComputeRenderTexture () override
 
- Protected Member Functions inherited from vtkWebGPUComputeTexture
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGPUComputeTexture ()
 
 ~vtkWebGPUComputeTexture () override
 
- Protected Member Functions inherited from vtkWebGPUTexture
virtual vtkObjectBaseNewInstanceInternal () 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

Render textures are returned by calls to vtkWebGPUPolyDataMapper::AcquireXXXXRenderTexture() and represent a buffer that is used by the rendering pipeline and that can also be added to a compute pipeline.

Definition at line 20 of file vtkWebGPUComputeRenderTexture.h.

Member Typedef Documentation

◆ Superclass

Definition at line 23 of file vtkWebGPUComputeRenderTexture.h.

Member Enumeration Documentation

◆ RenderTextureType

What type of texture of the vtk render pipeline is this ComputeRenderTexture refering to.

UNDEFINED: Undefined. Default. DEPTH_BUFFER: When this ComputeRenderTexture refers to the depth buffer of a vtkWebGPURenderWindow

Enumerator
UNDEFINED 
DEPTH_BUFFER 
COLOR_BUFFER 

Definition at line 35 of file vtkWebGPUComputeRenderTexture.h.

Constructor & Destructor Documentation

◆ vtkWebGPUComputeRenderTexture()

vtkWebGPUComputeRenderTexture::vtkWebGPUComputeRenderTexture ( )
protected

◆ ~vtkWebGPUComputeRenderTexture()

vtkWebGPUComputeRenderTexture::~vtkWebGPUComputeRenderTexture ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUComputeRenderTexture::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWebGPUComputeTexture.

◆ NewInstance()

vtkWebGPUComputeRenderTexture * vtkWebGPUComputeRenderTexture::NewInstance ( ) const

◆ New()

static vtkWebGPUComputeRenderTexture * vtkWebGPUComputeRenderTexture::New ( )
static

◆ PrintSelf()

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

◆ vtkGetEnumMacro() [1/2]

vtkWebGPUComputeRenderTexture::vtkGetEnumMacro ( Type  ,
RenderTextureType   
)

Get/set the render texture type.

◆ vtkSetEnumMacro() [1/2]

vtkWebGPUComputeRenderTexture::vtkSetEnumMacro ( Type  ,
RenderTextureType   
)

Get/set the render texture type.

◆ vtkGetEnumMacro() [2/2]

vtkWebGPUComputeRenderTexture::vtkGetEnumMacro ( Aspect  ,
vtkWebGPUComputeTextureView::TextureViewAspect   
)

Get/set the texture aspect that is going to be passed to the texture view created for this render texture in the compute pass.

◆ vtkSetEnumMacro() [2/2]

vtkWebGPUComputeRenderTexture::vtkSetEnumMacro ( Aspect  ,
vtkWebGPUComputeTextureView::TextureViewAspect   
)

Get/set the texture aspect that is going to be passed to the texture view created for this render texture in the compute pass.

◆ SetWebGPUTexture()

void vtkWebGPUComputeRenderTexture::SetWebGPUTexture ( wgpu::Texture  texture)
inline

Get/set the WebGPU texture (used when this ComputeTexture points to an already existing device buffer)

Definition at line 64 of file vtkWebGPUComputeRenderTexture.h.

◆ GetWebGPUTexture()

wgpu::Texture vtkWebGPUComputeRenderTexture::GetWebGPUTexture ( )
inline

Get/set the WebGPU texture (used when this ComputeTexture points to an already existing device buffer)

Definition at line 65 of file vtkWebGPUComputeRenderTexture.h.

◆ GetAssociatedComputePass()

vtkWeakPointer< vtkWebGPUComputePass > vtkWebGPUComputeRenderTexture::GetAssociatedComputePass ( )

Get/set the associated compute pass.

The associated compute pass is going to be needed if we want to resize the render texture after a render window resize (for example). This is because after a resize, we'll have to recreate the texture views which means that we'll need access to the compute pass.

◆ SetAssociatedComputePass()

void vtkWebGPUComputeRenderTexture::SetAssociatedComputePass ( vtkWeakPointer< vtkWebGPUComputePass computePass)

Get/set the associated compute pass.

The associated compute pass is going to be needed if we want to resize the render texture after a render window resize (for example). This is because after a resize, we'll have to recreate the texture views which means that we'll need access to the compute pass.


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