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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkOpenGLBufferObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

ObjectType	GetType () const
	Get the type of the buffer object. More...

void	SetType (ObjectType value)
	Set the type 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...

template<class T >
bool	Upload (const T &array, ObjectType type)
	Upload data to the buffer object. More...

template<class T >
bool	Upload (const T *array, size_t numElements, ObjectType type)

bool	Bind ()
	Bind the buffer object ready for rendering. 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
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkOpenGLBufferObject *	New ()

static int	IsTypeOf (const char *type)

static vtkOpenGLBufferObject *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLBufferObject ()

	~vtkOpenGLBufferObject ()

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

OpenGL buffer object.

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

Definition at line 32 of file vtkOpenGLBufferObject.h.

Member Typedef Documentation

typedef vtkObject vtkOpenGLBufferObject::Superclass

Definition at line 36 of file vtkOpenGLBufferObject.h.

Member Enumeration Documentation

enum vtkOpenGLBufferObject::ObjectType

Enumerator
ArrayBuffer
ElementArrayBuffer
TextureBuffer

Definition at line 39 of file vtkOpenGLBufferObject.h.

Constructor & Destructor Documentation

vtkOpenGLBufferObject::vtkOpenGLBufferObject ( )

protected

vtkOpenGLBufferObject::~vtkOpenGLBufferObject ( )

protected

Member Function Documentation

static vtkOpenGLBufferObject* vtkOpenGLBufferObject::New ( )

static

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

static

virtual int 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 vtkObject.

Reimplemented in vtkOpenGLVertexBufferObject, and vtkOpenGLIndexBufferObject.

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

static

virtual vtkObjectBase* vtkOpenGLBufferObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkOpenGLVertexBufferObject, and vtkOpenGLIndexBufferObject.

vtkOpenGLBufferObject* vtkOpenGLBufferObject::NewInstance ( ) const

void vtkOpenGLBufferObject::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

ObjectType vtkOpenGLBufferObject::GetType ( ) const

Get the type of the buffer object.

void vtkOpenGLBufferObject::SetType ( ObjectType value )

Set the type of the buffer object.

int vtkOpenGLBufferObject::GetHandle ( ) const

Get the handle of the buffer object.

bool vtkOpenGLBufferObject::IsReady ( ) const

inline

Determine if the buffer object is ready to be used.

Definition at line 56 of file vtkOpenGLBufferObject.h.

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

template<class T >

bool vtkOpenGLBufferObject::Upload	(	const T *	array,
		size_t	numElements,
		vtkOpenGLBufferObject::ObjectType	objectType
	)

inline

Definition at line 128 of file vtkOpenGLBufferObject.h.

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.

bool vtkOpenGLBufferObject::Release ( )

Release the buffer.

This should be done after rendering is complete.

void vtkOpenGLBufferObject::ReleaseGraphicsResources ( )

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

inline

Return a string describing errors.

Definition at line 94 of file vtkOpenGLBufferObject.h.

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

protected

Member Data Documentation

bool vtkOpenGLBufferObject::Dirty

protected

Definition at line 99 of file vtkOpenGLBufferObject.h.

std::string vtkOpenGLBufferObject::Error

protected

Definition at line 100 of file vtkOpenGLBufferObject.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkOpenGLBufferObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation