src/OpenGl/OpenGl_TextureBuffer.hxx

   1 // Created by: Kirill GAVRILOV
   2 // Copyright (c) 2013-2014 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 #ifndef _OpenGl_TextureBuffer_H__
  16 #define _OpenGl_TextureBuffer_H__
  17
  18 #include <Graphic3d_TextureUnit.hxx>
  19 #include <OpenGl_Buffer.hxx>
  20
  21 //! Texture Buffer Object.
  22 //! This is a special 1D texture that VBO-style initialized.
  23 //! The main differences from general 1D texture:
  24 //!  - no interpolation between field;
  25 //!  - greater sizes;
  26 //!  - special sampler object in GLSL shader to access data by index.
  27 //!
  28 //! Notice that though TBO is inherited from VBO this is to unify design
  29 //! user shouldn't cast it to base class and all really useful methods
  30 //! are declared in this class.
  31 class OpenGl_TextureBuffer : public OpenGl_Buffer
  32 {
  33   DEFINE_STANDARD_RTTIEXT(OpenGl_TextureBuffer, OpenGl_Buffer)
  34 public:
  35
  36   //! Helpful constants
  37   static const unsigned int NO_TEXTURE = 0;
  38
  39 public:
  40
  41   //! Create uninitialized TBO.
  42   Standard_EXPORT OpenGl_TextureBuffer();
  43
  44   //! Destroy object, will throw exception if GPU memory not released with Release() before.
  45   Standard_EXPORT virtual ~OpenGl_TextureBuffer();
  46
  47   //! Override VBO target
  48   Standard_EXPORT virtual unsigned int GetTarget() const Standard_OVERRIDE;
  49
  50   //! Returns true if TBO is valid.
  51   //! Notice that no any real GL call is performed!
  52   bool IsValid() const
  53   {
  54     return OpenGl_Buffer::IsValid()
  55         && myTextureId != NO_TEXTURE;
  56   }
  57
  58   //! Destroy object - will release GPU memory if any.
  59   Standard_EXPORT virtual void Release (OpenGl_Context* theGlCtx) Standard_OVERRIDE;
  60
  61   //! Creates VBO and Texture names (ids) if not yet generated.
  62   //! Data should be initialized by another method.
  63   Standard_EXPORT bool Create (const Handle(OpenGl_Context)& theGlCtx) Standard_OVERRIDE;
  64
  65   //! Perform TBO initialization with specified data.
  66   //! Existing data will be deleted.
  67   Standard_EXPORT bool Init (const Handle(OpenGl_Context)& theGlCtx,
  68                              const unsigned int     theComponentsNb,
  69                              const Standard_Integer theElemsNb,
  70                              const float* theData);
  71
  72   //! Perform TBO initialization with specified data.
  73   //! Existing data will be deleted.
  74   Standard_EXPORT bool Init (const Handle(OpenGl_Context)& theGlCtx,
  75                              const unsigned int     theComponentsNb,
  76                              const Standard_Integer theElemsNb,
  77                              const unsigned int*    theData);
  78
  79   //! Perform TBO initialization with specified data.
  80   //! Existing data will be deleted.
  81   Standard_EXPORT bool Init (const Handle(OpenGl_Context)& theGlCtx,
  82                              const unsigned int     theComponentsNb,
  83                              const Standard_Integer theElemsNb,
  84                              const unsigned short*  theData);
  85
  86   //! Perform TBO initialization with specified data.
  87   //! Existing data will be deleted.
  88   Standard_EXPORT bool Init (const Handle(OpenGl_Context)& theGlCtx,
  89                              const unsigned int     theComponentsNb,
  90                              const Standard_Integer theElemsNb,
  91                              const Standard_Byte*   theData);
  92
  93   //! Bind TBO to specified Texture Unit.
  94   Standard_EXPORT void BindTexture (const Handle(OpenGl_Context)& theGlCtx,
  95                                     const Graphic3d_TextureUnit   theTextureUnit) const;
  96
  97   //! Unbind TBO.
  98   Standard_EXPORT void UnbindTexture (const Handle(OpenGl_Context)& theGlCtx,
  99                                       const Graphic3d_TextureUnit   theTextureUnit) const;
 100
 101   //! Returns name of TBO.
 102   unsigned int TextureId() const { return myTextureId; }
 103
 104   //! Returns internal texture format.
 105   unsigned int TextureFormat() const { return myTexFormat; }
 106
 107 protected:
 108
 109   unsigned int myTextureId; //!< texture id
 110   unsigned int myTexFormat; //!< internal texture format
 111
 112 };
 113
 114 DEFINE_STANDARD_HANDLE(OpenGl_TextureBuffer, OpenGl_Buffer)
 115
 116 #endif // _OpenGl_TextureBuffer_H__