VTK  9.6.20260624
vtkOpenGLArrayTextureBufferCache Class Reference

manage texture-buffer-backed data arrays shared within a context More...

#include <vtkOpenGLArrayTextureBufferCache.h>

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

Classes

struct  Entry
 A cached texture buffer for one (array, role). More...
 

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.
 
vtkOpenGLArrayTextureBufferCacheNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
std::shared_ptr< EntryGetTextureBuffer (vtkDataArray *array, bool scalarComponents, bool integerTexture)
 Return the shared entry for the given (array, scalarComponents, integerTexture), creating an empty entry if none exists yet.
 
std::size_t GetNumberOfCachedTextureBuffers () const
 Return the number of distinct (array, role) texture buffers currently cached.
 
void ReleaseGraphicsResources (vtkWindow *window)
 Release the GL resources held by every cached entry and forget them.
 
- 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.
 
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 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 vtkOpenGLArrayTextureBufferCacheNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLArrayTextureBufferCacheSafeDownCast (vtkObjectBase *o)
 
- 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 Types

using Key = std::tuple<vtkDataArray*, bool, bool>
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLArrayTextureBufferCache ()
 
 ~vtkOpenGLArrayTextureBufferCache () 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 &)
 

Protected Attributes

std::map< Key, std::shared_ptr< Entry > > Cache
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

manage texture-buffer-backed data arrays shared within a context

This is the texture-buffer analog of vtkOpenGLVertexBufferObjectCache. The vertex-pulling mappers (vtkOpenGLLowMemoryPolyDataMapper via vtkDrawTexturedElements / vtkOpenGLArrayTextureBufferAdapter) reconstruct every vertex in-shader from data bound as samplerBuffer texture objects. Historically each adapter owned its own texture, so the same vtkDataArray (positions, normals, colors, connectivity, ...) rendered through several mappers — composite, glyph, LIC, or simply many actors sharing one polydata — was uploaded once per mapper. This cache lets those mappers share a single uploaded texture buffer.

Entries are keyed on the composite (array, scalarComponents, integerTexture): not the array pointer alone, because the same array may legitimately be uploaded with different layouts (e.g. a 3-component position array bound as RGB tuples versus as scalars). Each entry stamps the array MTime at which it was uploaded so a mutated array is lazily re-uploaded.

The cache is owned by vtkOpenGLState (one per context), reachable via vtkOpenGLRenderWindow::GetArrayTextureBufferCache(), mirroring GetVBOCache().

Definition at line 45 of file vtkOpenGLArrayTextureBufferCache.h.

Member Typedef Documentation

◆ Superclass

◆ Key

using vtkOpenGLArrayTextureBufferCache::Key = std::tuple<vtkDataArray*, bool, bool>
protected

Definition at line 96 of file vtkOpenGLArrayTextureBufferCache.h.

Constructor & Destructor Documentation

◆ vtkOpenGLArrayTextureBufferCache()

vtkOpenGLArrayTextureBufferCache::vtkOpenGLArrayTextureBufferCache ( )
protected

◆ ~vtkOpenGLArrayTextureBufferCache()

vtkOpenGLArrayTextureBufferCache::~vtkOpenGLArrayTextureBufferCache ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLArrayTextureBufferCache * vtkOpenGLArrayTextureBufferCache::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOpenGLArrayTextureBufferCache::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()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLArrayTextureBufferCache::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenGLArrayTextureBufferCache * vtkOpenGLArrayTextureBufferCache::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetTextureBuffer()

std::shared_ptr< Entry > vtkOpenGLArrayTextureBufferCache::GetTextureBuffer ( vtkDataArray * array,
bool scalarComponents,
bool integerTexture )

Return the shared entry for the given (array, scalarComponents, integerTexture), creating an empty entry if none exists yet.

The returned entry is owned by the cache; callers hold it via shared_ptr and fill in / read back its Texture, Buffer and UploadTime. The array is held alive by the entry so its pointer cannot be reused by a different array while cached.

◆ GetNumberOfCachedTextureBuffers()

std::size_t vtkOpenGLArrayTextureBufferCache::GetNumberOfCachedTextureBuffers ( ) const
inline

Return the number of distinct (array, role) texture buffers currently cached.

Mainly useful for tests and diagnostics: rendering the same shared array through several mappers yields a single entry, so this count stays well below the per-mapper total when geometry is shared.

Definition at line 84 of file vtkOpenGLArrayTextureBufferCache.h.

◆ ReleaseGraphicsResources()

void vtkOpenGLArrayTextureBufferCache::ReleaseGraphicsResources ( vtkWindow * window)

Release the GL resources held by every cached entry and forget them.

Called when the owning context is torn down.

Member Data Documentation

◆ Cache

std::map<Key, std::shared_ptr<Entry> > vtkOpenGLArrayTextureBufferCache::Cache
protected

Definition at line 97 of file vtkOpenGLArrayTextureBufferCache.h.


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