Open CASCADE Technology  7.4.1.dev
Public Member Functions | Static Public Attributes | Protected Attributes
OpenGl_TextureBufferArb Class Reference

Texture Buffer Object. This is a special 1D texture that VBO-style initialized. The main differences from general 1D texture: More...

#include <OpenGl_TextureBufferArb.hxx>

Inheritance diagram for OpenGl_TextureBufferArb:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_TextureBufferArb ()
 Create uninitialized TBO. More...
 
virtual ~OpenGl_TextureBufferArb ()
 Destroy object, will throw exception if GPU memory not released with Release() before. More...
 
virtual GLenum GetTarget () const override
 Override VBO target. More...
 
bool IsValid () const
 Returns true if TBO is valid. Notice that no any real GL call is performed! More...
 
virtual void Release (OpenGl_Context *theGlCtx) override
 Destroy object - will release GPU memory if any. More...
 
bool Create (const Handle< OpenGl_Context > &theGlCtx) override
 Creates VBO and Texture names (ids) if not yet generated. Data should be initialized by another method. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLfloat *theData)
 Perform TBO initialization with specified data. Existing data will be deleted. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLuint *theData)
 Perform TBO initialization with specified data. Existing data will be deleted. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLushort *theData)
 Perform TBO initialization with specified data. Existing data will be deleted. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLubyte *theData)
 Perform TBO initialization with specified data. Existing data will be deleted. More...
 
void BindTexture (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_TextureUnit theTextureUnit) const
 Bind TBO to specified Texture Unit. More...
 
void UnbindTexture (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_TextureUnit theTextureUnit) const
 Unbind TBO. More...
 
GLuint TextureId () const
 Returns name of TBO. More...
 
GLenum TextureFormat () const
 Returns internal texture format. More...
 
- Public Member Functions inherited from OpenGl_VertexBuffer
 OpenGl_VertexBuffer ()
 Create uninitialized VBO. More...
 
virtual ~OpenGl_VertexBuffer ()
 Destroy object. More...
 
virtual bool IsVirtual () const
 Return TRUE if this is a virtual (for backward compatibility) VBO object. More...
 
bool IsValid () const
 
GLuint GetComponentsNb () const
 
GLsizei GetElemsNb () const
 
void SetElemsNb (GLsizei theNbElems)
 Overrides the number of vertex attributes / number of vertexes. It is up to user specifying this number correct (e.g. below initial value)! More...
 
GLenum GetDataType () const
 
GLubyte * GetDataOffset () const
 
virtual void Bind (const Handle< OpenGl_Context > &theGlCtx) const
 Bind this VBO. More...
 
virtual void Unbind (const Handle< OpenGl_Context > &theGlCtx) const
 Unbind this VBO. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLfloat *theData)
 Notice that VBO will be unbound after this call. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLuint *theData)
 Notice that VBO will be unbound after this call. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLushort *theData)
 Notice that VBO will be unbound after this call. More...
 
bool Init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const GLubyte *theData)
 Notice that VBO will be unbound after this call. More...
 
bool SubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, const GLfloat *theData)
 Notice that VBO will be unbound after this call. Function replaces portion of data within this VBO using glBufferSubData(). The VBO should be initialized before call. More...
 
bool GetSubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, GLfloat *theData)
 Read back buffer sub-range. Notice that VBO will be unbound after this call. Function reads portion of data from this VBO using glGetBufferSubData(). More...
 
bool SubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, const GLuint *theData)
 Notice that VBO will be unbound after this call. Function replaces portion of data within this VBO using glBufferSubData(). The VBO should be initialized before call. More...
 
bool GetSubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, GLuint *theData)
 Read back buffer sub-range. Notice that VBO will be unbound after this call. Function reads portion of data from this VBO using glGetBufferSubData(). More...
 
bool SubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, const GLushort *theData)
 Notice that VBO will be unbound after this call. Function replaces portion of data within this VBO using glBufferSubData(). The VBO should be initialized before call. More...
 
bool GetSubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, GLushort *theData)
 Read back buffer sub-range. Notice that VBO will be unbound after this call. Function reads portion of data from this VBO using glGetBufferSubData(). More...
 
bool SubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, const GLubyte *theData)
 Notice that VBO will be unbound after this call. Function replaces portion of data within this VBO using glBufferSubData(). The VBO should be initialized before call. More...
 
bool GetSubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, GLubyte *theData)
 Read back buffer sub-range. Notice that VBO will be unbound after this call. Function reads portion of data from this VBO using glGetBufferSubData(). More...
 
void BindVertexAttrib (const Handle< OpenGl_Context > &theGlCtx, const GLuint theAttribLoc) const
 Bind this VBO to active GLSL program. More...
 
void UnbindVertexAttrib (const Handle< OpenGl_Context > &theGlCtx, const GLuint theAttribLoc) const
 Unbind any VBO from active GLSL program. More...
 
void BindAttribute (const Handle< OpenGl_Context > &theCtx, const Graphic3d_TypeOfAttribute theMode) const
 Bind this VBO and enable specified attribute in OpenGl_Context::ActiveProgram() or FFP. More...
 
void UnbindAttribute (const Handle< OpenGl_Context > &theCtx, const Graphic3d_TypeOfAttribute theMode) const
 Unbind this VBO and disable specified attribute in OpenGl_Context::ActiveProgram() or FFP. More...
 
virtual bool HasColorAttribute () const
 
virtual bool HasNormalAttribute () const
 
virtual void BindAllAttributes (const Handle< OpenGl_Context > &theGlCtx) const
 Bind all vertex attributes to active program OpenGl_Context::ActiveProgram() or for FFP. Default implementation does nothing. More...
 
virtual void BindPositionAttribute (const Handle< OpenGl_Context > &theGlCtx) const
 Bind vertex position attribute only. Default implementation does nothing. More...
 
virtual void UnbindAllAttributes (const Handle< OpenGl_Context > &theGlCtx) const
 Unbind all vertex attributes. Default implementation does nothing. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
virtual Standard_Size EstimatedDataSize () const override
 Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules. More...
 
virtual bool init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const void *theData, const GLenum theDataType, const GLsizei theStride)
 Initialize buffer with new data. More...
 
bool init (const Handle< OpenGl_Context > &theGlCtx, const GLuint theComponentsNb, const GLsizei theElemsNb, const void *theData, const GLenum theDataType)
 Initialize buffer with new data. More...
 
virtual bool subData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, const void *theData, const GLenum theDataType)
 Update part of the buffer with new data. More...
 
virtual bool getSubData (const Handle< OpenGl_Context > &theGlCtx, const GLsizei theElemFrom, const GLsizei theElemsNb, void *theData, const GLenum theDataType)
 Read back buffer sub-range. More...
 
- Public Member Functions inherited from OpenGl_Resource
 OpenGl_Resource ()
 Empty constructor. More...
 
virtual ~OpenGl_Resource ()
 Destructor. Inheritors should call Clean (NULL) within it. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Attributes

static const GLuint NO_TEXTURE = 0
 Helpful constants. More...
 
- Static Public Attributes inherited from OpenGl_VertexBuffer
static const GLuint NO_BUFFER = 0
 Helpful constants. More...
 

Protected Attributes

GLuint myTextureId
 texture id More...
 
GLenum myTexFormat
 internal texture format More...
 
- Protected Attributes inherited from OpenGl_VertexBuffer
GLubyte * myOffset
 offset to data More...
 
GLuint myBufferId
 VBO name (index) More...
 
GLuint myComponentsNb
 Number of components per generic vertex attribute, must be 1, 2, 3, or 4. More...
 
GLsizei myElemsNb
 Number of vertex attributes / number of vertices. More...
 
GLenum myDataType
 Data type (GL_FLOAT, GL_UNSIGNED_INT, GL_UNSIGNED_BYTE etc.) More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from OpenGl_VertexBuffer
static size_t sizeOfGlType (const GLenum theType)
 
static void bindAttribute (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_TypeOfAttribute theMode, const GLint theNbComp, const GLenum theDataType, const GLsizei theStride, const GLvoid *theOffset)
 Setup array pointer - either for active GLSL program OpenGl_Context::ActiveProgram() or for FFP using bindFixed() when no program bound. More...
 
static void unbindAttribute (const Handle< OpenGl_Context > &theGlCtx, const Graphic3d_TypeOfAttribute theMode)
 Disable GLSL array pointer - either for active GLSL program OpenGl_Context::ActiveProgram() or for FFP using unbindFixed() when no program bound. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

Texture Buffer Object. This is a special 1D texture that VBO-style initialized. The main differences from general 1D texture:

Notice that though TBO is inherited from VBO this is to unify design user shouldn't cast it to base class and all really useful methods are declared in this class.

Constructor & Destructor Documentation

◆ OpenGl_TextureBufferArb()

OpenGl_TextureBufferArb::OpenGl_TextureBufferArb ( )

Create uninitialized TBO.

◆ ~OpenGl_TextureBufferArb()

virtual OpenGl_TextureBufferArb::~OpenGl_TextureBufferArb ( )
virtual

Destroy object, will throw exception if GPU memory not released with Release() before.

Member Function Documentation

◆ BindTexture()

void OpenGl_TextureBufferArb::BindTexture ( const Handle< OpenGl_Context > &  theGlCtx,
const Graphic3d_TextureUnit  theTextureUnit 
) const

Bind TBO to specified Texture Unit.

◆ Create()

bool OpenGl_TextureBufferArb::Create ( const Handle< OpenGl_Context > &  theGlCtx)
overridevirtual

Creates VBO and Texture names (ids) if not yet generated. Data should be initialized by another method.

Reimplemented from OpenGl_VertexBuffer.

◆ GetTarget()

virtual GLenum OpenGl_TextureBufferArb::GetTarget ( ) const
overridevirtual

Override VBO target.

Reimplemented from OpenGl_VertexBuffer.

◆ Init() [1/4]

bool OpenGl_TextureBufferArb::Init ( const Handle< OpenGl_Context > &  theGlCtx,
const GLuint  theComponentsNb,
const GLsizei  theElemsNb,
const GLfloat *  theData 
)

Perform TBO initialization with specified data. Existing data will be deleted.

◆ Init() [2/4]

bool OpenGl_TextureBufferArb::Init ( const Handle< OpenGl_Context > &  theGlCtx,
const GLuint  theComponentsNb,
const GLsizei  theElemsNb,
const GLuint *  theData 
)

Perform TBO initialization with specified data. Existing data will be deleted.

◆ Init() [3/4]

bool OpenGl_TextureBufferArb::Init ( const Handle< OpenGl_Context > &  theGlCtx,
const GLuint  theComponentsNb,
const GLsizei  theElemsNb,
const GLushort *  theData 
)

Perform TBO initialization with specified data. Existing data will be deleted.

◆ Init() [4/4]

bool OpenGl_TextureBufferArb::Init ( const Handle< OpenGl_Context > &  theGlCtx,
const GLuint  theComponentsNb,
const GLsizei  theElemsNb,
const GLubyte *  theData 
)

Perform TBO initialization with specified data. Existing data will be deleted.

◆ IsValid()

bool OpenGl_TextureBufferArb::IsValid ( ) const
inline

Returns true if TBO is valid. Notice that no any real GL call is performed!

◆ Release()

virtual void OpenGl_TextureBufferArb::Release ( OpenGl_Context theGlCtx)
overridevirtual

Destroy object - will release GPU memory if any.

Reimplemented from OpenGl_VertexBuffer.

◆ TextureFormat()

GLenum OpenGl_TextureBufferArb::TextureFormat ( ) const
inline

Returns internal texture format.

◆ TextureId()

GLuint OpenGl_TextureBufferArb::TextureId ( ) const
inline

Returns name of TBO.

◆ UnbindTexture()

void OpenGl_TextureBufferArb::UnbindTexture ( const Handle< OpenGl_Context > &  theGlCtx,
const Graphic3d_TextureUnit  theTextureUnit 
) const

Unbind TBO.

Field Documentation

◆ myTexFormat

GLenum OpenGl_TextureBufferArb::myTexFormat
protected

internal texture format

◆ myTextureId

GLuint OpenGl_TextureBufferArb::myTextureId
protected

texture id

◆ NO_TEXTURE

const GLuint OpenGl_TextureBufferArb::NO_TEXTURE = 0
static

Helpful constants.


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