OpenGL vertex buffer object. More...

#include <vtkOpenGLIndexBufferObject.h>

Inheritance diagram for vtkOpenGLIndexBufferObject:

Collaboration diagram for vtkOpenGLIndexBufferObject:

Public Types
typedef vtkOpenGLBufferObject	Superclass

Public Types inherited from vtkOpenGLBufferObject
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.

vtkOpenGLIndexBufferObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

size_t	CreateTriangleIndexBuffer (vtkCellArray cells, vtkPoints points, std::vector< unsigned char > edgeArray, vtkDataArray edgeFlags)

size_t	CreateTriangleLineIndexBuffer (vtkCellArray *cells)

size_t	CreateLineIndexBuffer (vtkCellArray *cells)

size_t	CreatePointIndexBuffer (vtkCellArray *cells)

size_t	CreateStripIndexBuffer (vtkCellArray *cells, bool wireframeTriStrips)

size_t	CreateEdgeFlagIndexBuffer (vtkCellArray cells, vtkDataArray edgeflags)

size_t	CreateVertexIndexBuffer (vtkCellArray **cells)

Public Member Functions inherited from vtkOpenGLBufferObject
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.

ObjectUsage	GetUsage () const
	Get the usage of the buffer object.

void	SetUsage (ObjectUsage value)
	Set the usage 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.

void	FlagBufferAsDirty ()
	Indicate that the buffer object needs to be re-uploaded.

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	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.

size_t	GetSize ()
	Get size of the buffer in bytes.

template<class T >
bool	Download (T *array, size_t numElements)
	Download data from the buffer object.

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

bool	Bind ()
	Bind the buffer object ready for rendering.

bool	BindShaderStorage (int index)
	Bind the buffer to a shader storage point.

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)

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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.

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 vtkOpenGLIndexBufferObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLIndexBufferObject *	SafeDownCast (vtkObjectBase *o)

static void	AppendTriangleIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray cells, vtkPoints points, vtkIdType vertexOffset, std::vector< unsigned char > edgeArray, vtkDataArray edgeFlags)

static void	AppendLineIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray *cells, vtkIdType vertexOffset)

static void	AppendTriangleLineIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray *cells, vtkIdType vertexOffset)

static void	AppendPointIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray *cells, vtkIdType vertexOffset)

static void	AppendStripIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray *cells, vtkIdType vertexOffset, bool wireframeTriStrips)

static void	AppendEdgeFlagIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray cells, vtkIdType vertexOffset, vtkDataArray edgeflags)

static void	AppendVertexIndexBuffer (std::vector< unsigned int > &indexArray, vtkCellArray **cells, vtkIdType vertexOffset)

Static Public Member Functions inherited from vtkOpenGLBufferObject
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 (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.

Public Attributes
size_t	IndexCount

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLIndexBufferObject ()

	~vtkOpenGLIndexBufferObject () override

Protected Member Functions inherited from vtkOpenGLBufferObject
virtual vtkObjectBase *	NewInstanceInternal () 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.

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 *)

virtual void	ObjectFinalize ()

	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 vtkOpenGLBufferObject
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

Detailed Description

OpenGL vertex buffer object.

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

Definition at line 17 of file vtkOpenGLIndexBufferObject.h.

Member Typedef Documentation

◆ Superclass

typedef vtkOpenGLBufferObject vtkOpenGLIndexBufferObject::Superclass

Definition at line 21 of file vtkOpenGLIndexBufferObject.h.

Constructor & Destructor Documentation

◆ vtkOpenGLIndexBufferObject()

vtkOpenGLIndexBufferObject::vtkOpenGLIndexBufferObject ( )

protected

◆ ~vtkOpenGLIndexBufferObject()

vtkOpenGLIndexBufferObject::~vtkOpenGLIndexBufferObject ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLIndexBufferObject * vtkOpenGLIndexBufferObject::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLIndexBufferObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLBufferObject.

◆ NewInstance()

vtkOpenGLIndexBufferObject * vtkOpenGLIndexBufferObject::NewInstance ( ) const

◆ PrintSelf()

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

◆ CreateTriangleIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateTriangleIndexBuffer	(	vtkCellArray *	cells,
		vtkPoints *	points,
		std::vector< unsigned char > *	edgeArray,
		vtkDataArray *	edgeFlags
	)

◆ AppendTriangleIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendTriangleIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkPoints *	points,
		vtkIdType	vertexOffset,
		std::vector< unsigned char > *	edgeArray,
		vtkDataArray *	edgeFlags
	)

static

◆ CreateTriangleLineIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateTriangleLineIndexBuffer ( vtkCellArray * cells )

◆ AppendLineIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendLineIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkIdType	vertexOffset
	)

static

◆ CreateLineIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateLineIndexBuffer ( vtkCellArray * cells )

◆ AppendTriangleLineIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendTriangleLineIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkIdType	vertexOffset
	)

static

◆ CreatePointIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreatePointIndexBuffer ( vtkCellArray * cells )

◆ AppendPointIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendPointIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkIdType	vertexOffset
	)

static

◆ CreateStripIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateStripIndexBuffer	(	vtkCellArray *	cells,
		bool	wireframeTriStrips
	)

◆ AppendStripIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendStripIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkIdType	vertexOffset,
		bool	wireframeTriStrips
	)

static

◆ AppendEdgeFlagIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendEdgeFlagIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray *	cells,
		vtkIdType	vertexOffset,
		vtkDataArray *	edgeflags
	)

static

◆ CreateEdgeFlagIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateEdgeFlagIndexBuffer	(	vtkCellArray *	cells,
		vtkDataArray *	edgeflags
	)

◆ CreateVertexIndexBuffer()

size_t vtkOpenGLIndexBufferObject::CreateVertexIndexBuffer ( vtkCellArray ** cells )

◆ AppendVertexIndexBuffer()

static void vtkOpenGLIndexBufferObject::AppendVertexIndexBuffer	(	std::vector< unsigned int > &	indexArray,
		vtkCellArray **	cells,
		vtkIdType	vertexOffset
	)

static

Member Data Documentation

◆ IndexCount

size_t vtkOpenGLIndexBufferObject::IndexCount

Definition at line 25 of file vtkOpenGLIndexBufferObject.h.

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

Rendering/OpenGL2/vtkOpenGLIndexBufferObject.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenGLIndexBufferObject()

◆ ~vtkOpenGLIndexBufferObject()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ CreateTriangleIndexBuffer()

◆ AppendTriangleIndexBuffer()

◆ CreateTriangleLineIndexBuffer()

◆ AppendLineIndexBuffer()

◆ CreateLineIndexBuffer()

◆ AppendTriangleLineIndexBuffer()

◆ CreatePointIndexBuffer()

◆ AppendPointIndexBuffer()

◆ CreateStripIndexBuffer()

◆ AppendStripIndexBuffer()

◆ AppendEdgeFlagIndexBuffer()

◆ CreateEdgeFlagIndexBuffer()

◆ CreateVertexIndexBuffer()

◆ AppendVertexIndexBuffer()

Member Data Documentation

◆ IndexCount