vtkOpenGLBufferObject Class Reference

OpenGL buffer object. More...

#include <vtkOpenGLBufferObject.h>

Inheritance diagram for vtkOpenGLBufferObject:

Collaboration diagram for vtkOpenGLBufferObject:

Public Types
enum	ObjectType { ArrayBuffer , ElementArrayBuffer , TextureBuffer }
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.
vtkOpenGLBufferObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
ObjectType	GetType () const
	Get the type of the buffer object.
void	SetType (ObjectType value)
	Set the type of the buffer object.
int	GetHandle () const
	Get the handle of the buffer object.
bool	IsReady () const
	Determine if the buffer object is ready to be used.
bool	GenerateBuffer (ObjectType type)
	Generate the opengl buffer for this Handle.
template<class T >
bool	Upload (const T &array, ObjectType type)
	Upload data to the buffer object.
template<class T >
bool	Upload (const T *array, size_t numElements, ObjectType type)
bool	Bind ()
	Bind the buffer object ready for rendering.
bool	Release ()
	Release the buffer.
void	ReleaseGraphicsResources ()
std::string	GetError () const
	Return a string describing errors.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
static vtkOpenGLBufferObject *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLBufferObject *	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 (int 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 int	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
	vtkOpenGLBufferObject ()
	~vtkOpenGLBufferObject () override
bool	UploadInternal (const void *buffer, size_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.
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 *)
	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
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 33 of file vtkOpenGLBufferObject.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkOpenGLBufferObject::Superclass

Definition at line 37 of file vtkOpenGLBufferObject.h.

Member Enumeration Documentation

ObjectType

enum vtkOpenGLBufferObject::ObjectType

Enumerator
ArrayBuffer
ElementArrayBuffer
TextureBuffer

Definition at line 40 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 vtkOpenGLIndexBufferObject, and vtkOpenGLVertexBufferObject.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLBufferObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkOpenGLIndexBufferObject, and vtkOpenGLVertexBufferObject.

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 vtkOpenGLIndexBufferObject, and vtkOpenGLVertexBufferObject.

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.

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 57 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 115 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 128 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.

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 97 of file vtkOpenGLBufferObject.h.

UploadInternal()

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

protected

Member Data Documentation

Dirty

bool vtkOpenGLBufferObject::Dirty

protected

Definition at line 102 of file vtkOpenGLBufferObject.h.

Error

std::string vtkOpenGLBufferObject::Error

protected

Definition at line 103 of file vtkOpenGLBufferObject.h.

---

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

• Rendering/OpenGL2/vtkOpenGLBufferObject.h