VTK  9.7.20261013
vtkWebGPUDeepFramebuffer Class Reference

#include <vtkWebGPUDeepFramebuffer.h>

Detailed Description

Per-pixel fragment lists for order independent transparency.

Holds the three storage buffers an A-buffer needs:

  • HeadPointers: one atomic<u32> per pixel, holding the index of that pixel's first fragment, or InvalidIndex when it has none.
  • FragmentNodes: a pool of 28 byte records, { color, depth, cellId, propId, compositeId, processId, next }. All four id channels are carried because a translucent fragment is discarded after being recorded and so never reaches the id attachment on its own; vtkHardwareSelector treats a zero composite id as "nothing was drawn here".
  • FragmentCounter: a single atomic<u32> handing out node indices.

A shader appends with atomicAdd on the counter then atomicExchange on the head pointer, so a list is in reverse insertion order and must be sorted by depth when resolved. The pool is sized for an average number of layers per pixel, so overflow is expected: past the end, fragments are dropped.

Only atomic<u32> in storage is used, which is core WebGPU.

Definition at line 40 of file vtkWebGPUDeepFramebuffer.h.

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

Public Types

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.
vtkWebGPUDeepFramebuffer * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
virtual std::uint32_t GetAverageLayersPerPixel ()
 Average number of transparent layers the node pool is sized for.
virtual void SetAverageLayersPerPixel (std::uint32_t)
void SetWGPUConfiguration (vtkWebGPUConfiguration *config)
 The configuration used to allocate the buffers.
bool Resize (int width, int height)
 Allocate the buffers for a width x height viewport, reallocating only when the size actually changed.
void Clear ()
 Reset the counter to zero and every head pointer to InvalidIndex.
WGPUBuffer GetHeadPointersBuffer ()
 The buffers, for binding into render and compute passes.
WGPUBuffer GetFragmentNodesBuffer ()
WGPUBuffer GetFragmentCounterBuffer ()
virtual int GetWidth ()
 Geometry of the current allocation.
virtual int GetHeight ()
virtual std::uint32_t GetFragmentNodeCapacity ()
void ReleaseGraphicsResources ()
 Release the buffers.
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 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 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 vtkWebGPUDeepFramebuffer * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkWebGPUDeepFramebuffer * SafeDownCast (vtkObjectBase *o)
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
 vtkWebGPUDeepFramebuffer ()
 ~vtkWebGPUDeepFramebuffer () 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 ReportReferences (vtkGarbageCollector *)
 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

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkWebGPUDeepFramebuffer()

vtkWebGPUDeepFramebuffer::vtkWebGPUDeepFramebuffer ( )
protected

◆ ~vtkWebGPUDeepFramebuffer()

vtkWebGPUDeepFramebuffer::~vtkWebGPUDeepFramebuffer ( )
overrideprotected

Member Function Documentation

◆ New()

vtkWebGPUDeepFramebuffer * vtkWebGPUDeepFramebuffer::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUDeepFramebuffer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWebGPUDeepFramebuffer * vtkWebGPUDeepFramebuffer::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetAverageLayersPerPixel()

virtual std::uint32_t vtkWebGPUDeepFramebuffer::GetAverageLayersPerPixel ( )
virtual

Average number of transparent layers the node pool is sized for.

Raising it costs memory proportional to the viewport; lowering it drops more fragments in heavily layered regions.

◆ SetAverageLayersPerPixel()

virtual void vtkWebGPUDeepFramebuffer::SetAverageLayersPerPixel ( std::uint32_t )
virtual

◆ SetWGPUConfiguration()

void vtkWebGPUDeepFramebuffer::SetWGPUConfiguration ( vtkWebGPUConfiguration * config)

The configuration used to allocate the buffers.

Must be set before Resize().

◆ Resize()

bool vtkWebGPUDeepFramebuffer::Resize ( int width,
int height )

Allocate the buffers for a width x height viewport, reallocating only when the size actually changed.

Returns false if allocation failed, in which case the buffers are left released and transparency must fall back.

◆ Clear()

void vtkWebGPUDeepFramebuffer::Clear ( )

Reset the counter to zero and every head pointer to InvalidIndex.

Must run before each frame's fragment collection pass.

◆ GetHeadPointersBuffer()

WGPUBuffer vtkWebGPUDeepFramebuffer::GetHeadPointersBuffer ( )
inline

The buffers, for binding into render and compute passes.

Null until a successful Resize(). These are borrowed; the caller must not release them.

Definition at line 77 of file vtkWebGPUDeepFramebuffer.h.

◆ GetFragmentNodesBuffer()

WGPUBuffer vtkWebGPUDeepFramebuffer::GetFragmentNodesBuffer ( )
inline

Definition at line 78 of file vtkWebGPUDeepFramebuffer.h.

◆ GetFragmentCounterBuffer()

WGPUBuffer vtkWebGPUDeepFramebuffer::GetFragmentCounterBuffer ( )
inline

Definition at line 79 of file vtkWebGPUDeepFramebuffer.h.

◆ GetWidth()

virtual int vtkWebGPUDeepFramebuffer::GetWidth ( )
virtual

Geometry of the current allocation.

◆ GetHeight()

virtual int vtkWebGPUDeepFramebuffer::GetHeight ( )
virtual

◆ GetFragmentNodeCapacity()

virtual std::uint32_t vtkWebGPUDeepFramebuffer::GetFragmentNodeCapacity ( )
virtual

◆ ReleaseGraphicsResources()

void vtkWebGPUDeepFramebuffer::ReleaseGraphicsResources ( )

Release the buffers.


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