VTK  9.4.20241016
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkWebGPUTextureView Class Reference

Abstraction class for WebGPU texture views. More...

#include <vtkWebGPUTextureView.h>

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

Public Types

enum  TextureViewAspect { ASPECT_ALL = 0 , ASPECT_DEPTH , ASPECT_STENCIL }
 What will the shader sample from the texture when calling a sampling function. More...
 
enum  TextureViewMode {
  UNDEFINED = 0 , READ_ONLY , READ_ONLY_STORAGE , WRITE_ONLY_STORAGE ,
  READ_WRITE_STORAGE
}
 The mode of the texture view to define what operations will be doable on the texture in the shader. 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.
 
vtkWebGPUTextureViewNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int GetBaseMipLevel ()
 Get/set mipmap level that this texture view represents.
 
virtual void SetBaseMipLevel (int)
 Get/set mipmap level that this texture view represents.
 
virtual int GetMipLevelCount ()
 Get/set the number of mipmaps that this texture view represents.
 
virtual void SetMipLevelCount (int)
 Get/set the number of mipmaps that this texture view represents.
 
virtual vtkIdType GetGroup ()
 Get/set the bind group index of the texture view.
 
virtual void SetGroup (vtkIdType)
 Get/set the bind group index of the texture view.
 
virtual vtkIdType GetBinding ()
 Get/set the binding index of the texture view.
 
virtual void SetBinding (vtkIdType)
 Get/set the binding index of the texture view.
 
virtual vtkWebGPUTextureView::TextureViewAspect GetAspect ()
 Get/set the aspect of the texture view.
 
virtual void SetAspect (vtkWebGPUTextureView::TextureViewAspect)
 Get/set the aspect of the texture view.
 
virtual vtkWebGPUTexture::TextureDimension GetDimension ()
 Get/set the dimension of the texture view.
 
virtual void SetDimension (vtkWebGPUTexture::TextureDimension)
 Get/set the dimension of the texture view.
 
virtual vtkWebGPUTexture::TextureFormat GetFormat ()
 Get/set the format of the texture view.
 
virtual void SetFormat (vtkWebGPUTexture::TextureFormat)
 Get/set the format of the texture view.
 
virtual vtkWebGPUTextureView::TextureViewMode GetMode ()
 Get/set the mode of the texture view.
 
virtual void SetMode (vtkWebGPUTextureView::TextureViewMode)
 Get/set the mode of the texture view.
 
virtual std::string & GetLabel ()
 Get/set the label of the texture view.
 
virtual void SetLabel (std::string)
 Get/set the label of the texture view.
 
- 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 vtkWebGPUTextureViewSafeDownCast (vtkObjectBase *o)
 
static vtkWebGPUTextureViewNew ()
 
- 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
 
 vtkWebGPUTextureView ()
 
 ~vtkWebGPUTextureView () override
 
 vtkWebGPUTextureView (const vtkWebGPUTextureView &)=delete
 
void operator= (const vtkWebGPUTextureView &)=delete
 
- 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 texture views.

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

Definition at line 17 of file vtkWebGPUTextureView.h.

Member Typedef Documentation

◆ Superclass

Definition at line 20 of file vtkWebGPUTextureView.h.

Member Enumeration Documentation

◆ TextureViewAspect

What will the shader sample from the texture when calling a sampling function.

This may be useful for example when your texture has the DEPTH24_STENCIL8 format but you're only interested in the depth in the shader. For this example, you will use TextureAspect::DEPTH so that the shader samplers only sample the depth.

ASPECT_ALL: Sample everything. Default. ASPECT_DEPTH: Only sample the depth part ASPECT_STENCIL: Only sample the stencil part

Enumerator
ASPECT_ALL 
ASPECT_DEPTH 
ASPECT_STENCIL 

Definition at line 36 of file vtkWebGPUTextureView.h.

◆ TextureViewMode

The mode of the texture view to define what operations will be doable on the texture in the shader.

UNDEFINED: Texture view mode not set. Default. READ_ONLY: The compute shader can only read from the texture and a sampler can be usedc READ_ONLY_STORAGE: The compute shader can only read from the texture and a sampler cannot 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 
READ_ONLY_STORAGE 
WRITE_ONLY_STORAGE 
READ_WRITE_STORAGE 

Definition at line 55 of file vtkWebGPUTextureView.h.

Constructor & Destructor Documentation

◆ vtkWebGPUTextureView() [1/2]

vtkWebGPUTextureView::vtkWebGPUTextureView ( )
protected

◆ ~vtkWebGPUTextureView()

vtkWebGPUTextureView::~vtkWebGPUTextureView ( )
overrideprotected

◆ vtkWebGPUTextureView() [2/2]

vtkWebGPUTextureView::vtkWebGPUTextureView ( const vtkWebGPUTextureView )
protecteddelete

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkWebGPUTextureView::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 vtkWebGPUComputeTextureView.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUTextureView::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkWebGPUComputeTextureView.

◆ NewInstance()

vtkWebGPUTextureView * vtkWebGPUTextureView::NewInstance ( ) const

◆ New()

static vtkWebGPUTextureView * vtkWebGPUTextureView::New ( )
static

◆ PrintSelf()

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

◆ GetBaseMipLevel()

virtual int vtkWebGPUTextureView::GetBaseMipLevel ( )
virtual

Get/set mipmap level that this texture view represents.

◆ SetBaseMipLevel()

virtual void vtkWebGPUTextureView::SetBaseMipLevel ( int  )
virtual

Get/set mipmap level that this texture view represents.

◆ GetMipLevelCount()

virtual int vtkWebGPUTextureView::GetMipLevelCount ( )
virtual

Get/set the number of mipmaps that this texture view represents.

Can only be 1 for storage textures.

◆ SetMipLevelCount()

virtual void vtkWebGPUTextureView::SetMipLevelCount ( int  )
virtual

Get/set the number of mipmaps that this texture view represents.

Can only be 1 for storage textures.

◆ GetGroup()

virtual vtkIdType vtkWebGPUTextureView::GetGroup ( )
virtual

Get/set the bind group index of the texture view.

◆ SetGroup()

virtual void vtkWebGPUTextureView::SetGroup ( vtkIdType  )
virtual

Get/set the bind group index of the texture view.

◆ GetBinding()

virtual vtkIdType vtkWebGPUTextureView::GetBinding ( )
virtual

Get/set the binding index of the texture view.

◆ SetBinding()

virtual void vtkWebGPUTextureView::SetBinding ( vtkIdType  )
virtual

Get/set the binding index of the texture view.

◆ GetAspect()

virtual vtkWebGPUTextureView::TextureViewAspect vtkWebGPUTextureView::GetAspect ( )
virtual

Get/set the aspect of the texture view.

◆ SetAspect()

virtual void vtkWebGPUTextureView::SetAspect ( vtkWebGPUTextureView::TextureViewAspect  )
virtual

Get/set the aspect of the texture view.

◆ GetDimension()

virtual vtkWebGPUTexture::TextureDimension vtkWebGPUTextureView::GetDimension ( )
virtual

Get/set the dimension of the texture view.

◆ SetDimension()

virtual void vtkWebGPUTextureView::SetDimension ( vtkWebGPUTexture::TextureDimension  )
virtual

Get/set the dimension of the texture view.

◆ GetFormat()

virtual vtkWebGPUTexture::TextureFormat vtkWebGPUTextureView::GetFormat ( )
virtual

Get/set the format of the texture view.

◆ SetFormat()

virtual void vtkWebGPUTextureView::SetFormat ( vtkWebGPUTexture::TextureFormat  )
virtual

Get/set the format of the texture view.

◆ GetMode()

virtual vtkWebGPUTextureView::TextureViewMode vtkWebGPUTextureView::GetMode ( )
virtual

Get/set the mode of the texture view.

◆ SetMode()

virtual void vtkWebGPUTextureView::SetMode ( vtkWebGPUTextureView::TextureViewMode  )
virtual

Get/set the mode of the texture view.

◆ GetLabel()

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

Get/set the label of the texture view.

This attribute is used for debugging is something goes wrong

◆ SetLabel()

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

Get/set the label of the texture view.

This attribute is used for debugging is something goes wrong

◆ operator=()

void vtkWebGPUTextureView::operator= ( const vtkWebGPUTextureView )
protecteddelete

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