NCBI C++ ToolKit
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
CGlBuffer< T > Class Template Reference

Search Toolkit Book for CGlBuffer

CGlBuffer Concrete buffers (to store vertices, vertex attributes, or indices to vertex buffers) are derived from this class. More...

#include <gui/opengl/glbuffer.hpp>

+ Inheritance diagram for CGlBuffer< T >:
+ Collaboration diagram for CGlBuffer< T >:

Public Types

typedef T TBufferType
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Public Types inherited from IGlBuffer< T >
typedef T TBufferType
 

Public Member Functions

 CGlBuffer (GLenum target)
 Sets buffer type but does not allocate buffer yet. More...
 
GLsizei GetActiveBufferSize () const
 Get number of elements to be drawn. More...
 
TGetMappedPtr ()
 Get pointer to mapped buffer (NULL if buffer not currently mapped) More...
 
bool IsMapped () const
 Returns true if buffer data has been mapped. More...
 
virtual void BindBuffer ()
 Bind buffer - subclass to implement if needed (2.0 only) More...
 
virtual void ReleaseBuffer ()
 Release buffer - subclass to implement if needed (2.0 only) More...
 
GLsizei GetSize () const
 Get allocated buffer size (# of elements T) More...
 
- Public Member Functions inherited from CGlObject
 CGlObject ()
 
 CGlObject (const string &name)
 
void SetName (const string &name)
 
string GetName () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 
- Public Member Functions inherited from IGlBuffer< T >
 IGlBuffer ()
 
virtual ~IGlBuffer ()
 
virtual void Destroy ()=0
 Do any needed buffer clean-up. More...
 
virtual void BufferData (GLsizei num_elements, const T *data, GLenum usage)=0
 Create and, optionally, initialize the buffer. More...
 
virtual TMapBuffer (GLenum access)=0
 Return a pointer to the beginning of the buffer to allow direct memory reads/writes. More...
 
virtual bool UnmapBuffer ()=0
 Unmap data (pointer may returned by MapBuffer becomes invalid). More...
 
virtual Toperator[] (GLsizei idx)=0
 Return entry in the buffer ONLY if it is mapped (if IsMapped()==true) More...
 
virtual void GetData (vector< T > &data)=0
 Return a copy of the buffer (0..m_ActiveSize). More...
 

Public Attributes

GLsizei m_ActiveSize
 Number of elements to use when drawing (m_BufferSize may be larger) More...
 

Protected Attributes

GLenum m_TargetBuffer
 GL_ARRAY_BUFFER (for vertex attributes) or: GL_ELEMENT_ARRAY_BUFFER (for array indices) More...
 
GLsizei m_BufferSize
 Number of elements of type "T" that can fit in buffer. More...
 
TBufferTypem_BufferData
 Pointer to buffer data in memeory when buffer is mapped into memory via MapBuffer, otherwise NULL. More...
 
- Protected Attributes inherited from CGlObject
string m_Name
 Object name. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

template<typename T>
class CGlBuffer< T >

CGlBuffer Concrete buffers (to store vertices, vertex attributes, or indices to vertex buffers) are derived from this class.

This class implements functions common to both 1.1 and 2.0 implementations, namely the buffer size, buffer pointer (when mapped) and current index.

Definition at line 168 of file glbuffer.hpp.


The documentation for this class was generated from the following file:
Modified on Mon May 20 05:06:03 2024 by modify_doxy.py rev. 669887