VTK  9.3.20240224
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOpenGLBufferObject Class Reference

OpenGL buffer object. More...

#include <vtkOpenGLBufferObject.h>

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

Public Types

enum  ObjectType { ArrayBuffer , ElementArrayBuffer , TextureBuffer }
 
enum  ObjectUsage {
  StreamDraw , StreamRead , StreamCopy , StaticDraw ,
  StaticRead , StaticCopy , DynamicDraw , DynamicRead ,
  DynamicCopy
}
 
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. More...
 
vtkOpenGLBufferObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
ObjectType GetType () const
 Get the type of the buffer object. More...
 
void SetType (ObjectType value)
 Set the type of the buffer object. More...
 
ObjectUsage GetUsage () const
 Get the usage of the buffer object. More...
 
void SetUsage (ObjectUsage value)
 Set the usage of the buffer object. More...
 
int GetHandle () const
 Get the handle of the buffer object. More...
 
bool IsReady () const
 Determine if the buffer object is ready to be used. More...
 
void FlagBufferAsDirty ()
 Indicate that the buffer object needs to be re-uploaded. More...
 
bool GenerateBuffer (ObjectType type)
 Generate the opengl buffer for this Handle. More...
 
template<class T >
bool Upload (const T &array, ObjectType type)
 Upload data to the buffer object. More...
 
template<class T >
bool UploadRange (const T &array, ptrdiff_t offset, ObjectType type)
 
template<class T >
bool Upload (const T *array, size_t numElements, ObjectType type)
 
template<class T >
bool UploadRange (const T *array, ptrdiff_t offset, size_t numElements, ObjectType type)
 
bool Allocate (size_t size, ObjectType type, ObjectUsage usage)
 Allocates a buffer of type with size bytes. More...
 
size_t GetSize ()
 Get size of the buffer in bytes. More...
 
template<class T >
bool Download (T *array, size_t numElements)
 Download data from the buffer object. More...
 
template<class T >
bool DownloadRange (T *array, ptrdiff_t offset, size_t numElements)
 
bool Bind ()
 Bind the buffer object ready for rendering. More...
 
bool BindShaderStorage (int index)
 Bind the buffer to a shader storage point. More...
 
bool Release ()
 Release the buffer. More...
 
void ReleaseGraphicsResources ()
 
std::string GetError () const
 Return a string describing errors. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkOpenGLBufferObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLBufferObjectSafeDownCast (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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLBufferObject ()
 
 ~vtkOpenGLBufferObject () override
 
bool UploadInternal (const void *buffer, size_t size, ObjectType objectType)
 
bool UploadRangeInternal (const void *buffer, ptrdiff_t offset, ptrdiff_t size, ObjectType objectType)
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool Dirty
 
std::string Error
 
- 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

OpenGL buffer object.

OpenGL buffer object to store index, geometry and/or attribute data on the GPU.

Definition at line 24 of file vtkOpenGLBufferObject.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkOpenGLBufferObject.h.

Member Enumeration Documentation

◆ ObjectType

Enumerator
ArrayBuffer 
ElementArrayBuffer 
TextureBuffer 

Definition at line 31 of file vtkOpenGLBufferObject.h.

◆ ObjectUsage

Enumerator
StreamDraw 
StreamRead 
StreamCopy 
StaticDraw 
StaticRead 
StaticCopy 
DynamicDraw 
DynamicRead 
DynamicCopy 

Definition at line 37 of file vtkOpenGLBufferObject.h.

Constructor & Destructor Documentation

◆ vtkOpenGLBufferObject()

vtkOpenGLBufferObject::vtkOpenGLBufferObject ( )
protected

◆ ~vtkOpenGLBufferObject()

vtkOpenGLBufferObject::~vtkOpenGLBufferObject ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLBufferObject* vtkOpenGLBufferObject::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOpenGLBufferObject::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 vtkOpenGLVertexBufferObject, and vtkOpenGLIndexBufferObject.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOpenGLBufferObject::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOpenGLBufferObject* vtkOpenGLBufferObject::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkOpenGLVertexBufferObject, and vtkOpenGLIndexBufferObject.

◆ GetType()

ObjectType vtkOpenGLBufferObject::GetType ( ) const

Get the type of the buffer object.

◆ SetType()

void vtkOpenGLBufferObject::SetType ( ObjectType  value)

Set the type of the buffer object.

◆ GetUsage()

ObjectUsage vtkOpenGLBufferObject::GetUsage ( ) const

Get the usage of the buffer object.

◆ SetUsage()

void vtkOpenGLBufferObject::SetUsage ( ObjectUsage  value)

Set the usage of the buffer object.

◆ GetHandle()

int vtkOpenGLBufferObject::GetHandle ( ) const

Get the handle of the buffer object.

◆ IsReady()

bool vtkOpenGLBufferObject::IsReady ( ) const
inline

Determine if the buffer object is ready to be used.

Definition at line 65 of file vtkOpenGLBufferObject.h.

◆ FlagBufferAsDirty()

void vtkOpenGLBufferObject::FlagBufferAsDirty ( )
inline

Indicate that the buffer object needs to be re-uploaded.

Definition at line 68 of file vtkOpenGLBufferObject.h.

◆ GenerateBuffer()

bool vtkOpenGLBufferObject::GenerateBuffer ( ObjectType  type)

Generate the opengl buffer for this Handle.

◆ Upload() [1/2]

template<class T >
bool vtkOpenGLBufferObject::Upload ( const T &  array,
vtkOpenGLBufferObject::ObjectType  objectType 
)
inline

Upload data to the buffer object.

The BufferObject::type() must match type or be uninitialized.

The T type must have tightly packed values of T::value_type accessible by reference via T::operator[]. Additionally, the standard size() and empty() methods must be implemented. The std::vector class is an example of such a supported containers.

Definition at line 155 of file vtkOpenGLBufferObject.h.

◆ UploadRange() [1/2]

template<class T >
bool vtkOpenGLBufferObject::UploadRange ( const T &  array,
ptrdiff_t  offset,
vtkOpenGLBufferObject::ObjectType  objectType 
)
inline

Definition at line 180 of file vtkOpenGLBufferObject.h.

◆ Upload() [2/2]

template<class T >
bool vtkOpenGLBufferObject::Upload ( const T *  array,
size_t  numElements,
vtkOpenGLBufferObject::ObjectType  objectType 
)
inline

Definition at line 168 of file vtkOpenGLBufferObject.h.

◆ UploadRange() [2/2]

template<class T >
bool vtkOpenGLBufferObject::UploadRange ( const T *  array,
ptrdiff_t  offset,
size_t  numElements,
vtkOpenGLBufferObject::ObjectType  objectType 
)
inline

Definition at line 193 of file vtkOpenGLBufferObject.h.

◆ Allocate()

bool vtkOpenGLBufferObject::Allocate ( size_t  size,
ObjectType  type,
ObjectUsage  usage 
)

Allocates a buffer of type with size bytes.

◆ GetSize()

size_t vtkOpenGLBufferObject::GetSize ( )

Get size of the buffer in bytes.

◆ Download()

template<class T >
bool vtkOpenGLBufferObject::Download ( T *  array,
size_t  numElements 
)
inline

Download data from the buffer object.

Definition at line 205 of file vtkOpenGLBufferObject.h.

◆ DownloadRange()

template<class T >
bool vtkOpenGLBufferObject::DownloadRange ( T *  array,
ptrdiff_t  offset,
size_t  numElements 
)
inline

Definition at line 211 of file vtkOpenGLBufferObject.h.

◆ Bind()

bool vtkOpenGLBufferObject::Bind ( )

Bind the buffer object ready for rendering.

Note
Only one ARRAY_BUFFER and one ELEMENT_ARRAY_BUFFER may be bound at any time.

◆ BindShaderStorage()

bool vtkOpenGLBufferObject::BindShaderStorage ( int  index)

Bind the buffer to a shader storage point.

◆ Release()

bool vtkOpenGLBufferObject::Release ( )

Release the buffer.

This should be done after rendering is complete.

◆ ReleaseGraphicsResources()

void vtkOpenGLBufferObject::ReleaseGraphicsResources ( )

◆ GetError()

std::string vtkOpenGLBufferObject::GetError ( ) const
inline

Return a string describing errors.

Definition at line 133 of file vtkOpenGLBufferObject.h.

◆ UploadInternal()

bool vtkOpenGLBufferObject::UploadInternal ( const void *  buffer,
size_t  size,
ObjectType  objectType 
)
protected

◆ UploadRangeInternal()

bool vtkOpenGLBufferObject::UploadRangeInternal ( const void *  buffer,
ptrdiff_t  offset,
ptrdiff_t  size,
ObjectType  objectType 
)
protected

Member Data Documentation

◆ Dirty

bool vtkOpenGLBufferObject::Dirty
protected

Definition at line 138 of file vtkOpenGLBufferObject.h.

◆ Error

std::string vtkOpenGLBufferObject::Error
protected

Definition at line 139 of file vtkOpenGLBufferObject.h.


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