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

Point sprite resource. On modern hardware it will be texture with extra parameters. On ancient hardware sprites will be drawn using bitmaps. More...

#include <OpenGl_PointSprite.hxx>

Inheritance diagram for OpenGl_PointSprite:
Inheritance graph
[legend]

Public Member Functions

 OpenGl_PointSprite (const TCollection_AsciiString &theResourceId)
 Create uninitialized resource. More...
 
virtual ~OpenGl_PointSprite ()
 Destroy object. More...
 
virtual void Release (OpenGl_Context *theCtx) override
 Destroy object - will release GPU memory if any. More...
 
virtual bool IsPointSprite () const override
 Returns TRUE for point sprite texture. More...
 
Standard_Boolean IsDisplayList () const
 
void DrawBitmap (const Handle< OpenGl_Context > &theCtx) const
 Draw sprite using glBitmap. Please call glRasterPos3fv() before to setup sprite position. More...
 
void SetDisplayList (const Handle< OpenGl_Context > &theCtx, const GLuint theBitmapList)
 Initialize point sprite as display list. More...
 
- Public Member Functions inherited from OpenGl_Texture
 OpenGl_Texture (const TCollection_AsciiString &theResourceId=TCollection_AsciiString(), const Handle< Graphic3d_TextureParams > &theParams=Handle< Graphic3d_TextureParams >())
 Create uninitialized texture. More...
 
virtual ~OpenGl_Texture ()
 Destroy object. More...
 
bool IsValid () const
 
GLenum GetTarget () const
 
GLsizei SizeX () const
 
GLsizei SizeY () const
 
GLuint TextureId () const
 
GLenum GetFormat () const
 
GLint SizedFormat () const
 
bool IsAlpha () const
 Return true for GL_RED and GL_ALPHA formats. More...
 
void SetAlpha (const bool theValue)
 Setup to interpret the format as Alpha by Shader Manager (should be GL_ALPHA within compatible context or GL_RED otherwise). More...
 
bool IsTopDown () const
 Return if 2D surface is defined top-down (TRUE) or bottom-up (FALSE). Normally set from Image_PixMap::IsTopDown() within texture initialization. More...
 
void SetTopDown (bool theIsTopDown)
 Set if 2D surface is defined top-down (TRUE) or bottom-up (FALSE). More...
 
bool Create (const Handle< OpenGl_Context > &theCtx)
 Creates Texture id if not yet generated. Data should be initialized by another method. More...
 
const Handle< OpenGl_Sampler > & Sampler () const
 Return texture sampler. More...
 
void SetSampler (const Handle< OpenGl_Sampler > &theSampler)
 Set texture sampler. More...
 
bool InitSamplerObject (const Handle< OpenGl_Context > &theCtx)
 Initialize the Sampler Object (as OpenGL object). More...
 
void Bind (const Handle< OpenGl_Context > &theCtx) const
 Bind this Texture to the unit specified in sampler parameters. Also binds Sampler Object if it is allocated. More...
 
void Unbind (const Handle< OpenGl_Context > &theCtx) const
 Unbind texture from the unit specified in sampler parameters. Also unbinds Sampler Object if it is allocated. More...
 
void Bind (const Handle< OpenGl_Context > &theCtx, const Graphic3d_TextureUnit theTextureUnit) const
 Bind this Texture to specified unit. Also binds Sampler Object if it is allocated. More...
 
void Unbind (const Handle< OpenGl_Context > &theCtx, const Graphic3d_TextureUnit theTextureUnit) const
 Unbind texture from specified unit. Also unbinds Sampler Object if it is allocated. More...
 
Standard_Size Revision () const
 Revision of associated data source. More...
 
void SetRevision (const Standard_Size theRevision)
 Set revision of associated data source. More...
 
bool Init (const Handle< OpenGl_Context > &theCtx, const Image_PixMap &theImage, const Graphic3d_TypeOfTexture theType, const Standard_Boolean theIsColorMap)
 Notice that texture will be unbound after this call. More...
 
bool Init (const Handle< OpenGl_Context > &theCtx, const OpenGl_TextureFormat &theFormat, const Graphic3d_Vec2i &theSizeXY, const Graphic3d_TypeOfTexture theType, const Image_PixMap *theImage=NULL)
 Initialize the texture with specified format, size and texture type. If theImage is empty the texture data will contain trash. Notice that texture will be unbound after this call. More...
 
bool Init (const Handle< OpenGl_Context > &theCtx, const Handle< Graphic3d_TextureMap > &theTextureMap)
 Initialize the texture with Graphic3d_TextureMap. It is an universal way to initialize. Suitable initialization method will be chosen. More...
 
bool InitCompressed (const Handle< OpenGl_Context > &theCtx, const Image_CompressedPixMap &theImage, const Standard_Boolean theIsColorMap)
 Initialize the texture with Image_CompressedPixMap. More...
 
bool Init2DMultisample (const Handle< OpenGl_Context > &theCtx, const GLsizei theNbSamples, const GLint theTextFormat, const GLsizei theSizeX, const GLsizei theSizeY)
 Initialize the 2D multisampling texture using glTexImage2DMultisample(). More...
 
bool InitRectangle (const Handle< OpenGl_Context > &theCtx, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const OpenGl_TextureFormat &theFormat)
 Allocates texture rectangle with specified format and size. More...
 
bool Init3D (const Handle< OpenGl_Context > &theCtx, const OpenGl_TextureFormat &theFormat, const Graphic3d_Vec3i &theSizeXYZ, const void *thePixels)
 Initializes 3D texture rectangle with specified format and size. More...
 
Standard_Boolean HasMipmaps () const
 
Standard_Integer MaxMipmapLevel () const
 Return upper mipmap level index (0 means no mipmaps). More...
 
virtual Standard_Size EstimatedDataSize () const override
 Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules. More...
 
bool Init (const Handle< OpenGl_Context > &theCtx, const GLint theTextFormat, const GLenum thePixelFormat, const GLenum theDataType, const GLsizei theSizeX, const GLsizei theSizeY, const Graphic3d_TypeOfTexture theType, const Image_PixMap *theImage=NULL)
 
bool Init (const Handle< OpenGl_Context > &theCtx, const Image_PixMap &theImage, const Graphic3d_TypeOfTexture theType)
 
bool Init3D (const Handle< OpenGl_Context > &theCtx, const GLint theTextFormat, const GLenum thePixelFormat, const GLenum theDataType, const Standard_Integer theSizeX, const Standard_Integer theSizeY, const Standard_Integer theSizeZ, const void *thePixels)
 
bool InitCubeMap (const Handle< OpenGl_Context > &theCtx, const Handle< Graphic3d_CubeMap > &theCubeMap, Standard_Size theSize, Image_Format theFormat, Standard_Boolean theToGenMipmap, Standard_Boolean theIsColorMap)
 Initializes 6 sides of cubemap. If theCubeMap is not NULL then size and format will be taken from it and corresponding arguments will be ignored. Otherwise this parametres will be taken from arguments. More...
 
- Public Member Functions inherited from OpenGl_NamedResource
 OpenGl_NamedResource (const TCollection_AsciiString &theId)
 Empty constructor. More...
 
const TCollection_AsciiStringResourceId () const
 Return resource name. 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...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. 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...
 

Protected Attributes

GLuint myBitmapList
 if of display list to draw sprite using glBitmap (for backward compatibility) More...
 
- Protected Attributes inherited from OpenGl_Texture
Handle< OpenGl_SamplermySampler
 texture sampler More...
 
Standard_Size myRevision
 revision of associated data source More...
 
GLuint myTextureId
 GL resource ID. More...
 
GLenum myTarget
 GL_TEXTURE_1D/GL_TEXTURE_2D/GL_TEXTURE_3D. More...
 
GLsizei mySizeX
 texture width More...
 
GLsizei mySizeY
 texture height More...
 
GLsizei mySizeZ
 texture depth More...
 
GLenum myTextFormat
 texture format - GL_RGB, GL_RGBA,... More...
 
GLint mySizedFormat
 internal (sized) texture format More...
 
Standard_Integer myNbSamples
 number of MSAA samples More...
 
Standard_Integer myMaxMipLevel
 upper mipmap level index (0 means no mipmaps) More...
 
bool myIsAlpha
 indicates alpha format More...
 
bool myIsTopDown
 indicates if 2D surface is defined top-down (TRUE) or bottom-up (FALSE) More...
 
- Protected Attributes inherited from OpenGl_NamedResource
TCollection_AsciiString myResourceId
 resource name 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_Texture
static Standard_Size PixelSizeOfPixelFormat (Standard_Integer theInternalFormat)
 Return pixel size of pixel format in bytes. Note that this method considers that OpenGL natively supports this pixel format, which might be not the case - in the latter case, actual pixel size might differ! More...
 
static bool GetDataFormat (const Handle< OpenGl_Context > &theCtx, const Image_Format theFormat, GLint &theTextFormat, GLenum &thePixelFormat, GLenum &theDataType)
 
static bool GetDataFormat (const Handle< OpenGl_Context > &theCtx, const Image_PixMap &theData, GLint &theTextFormat, GLenum &thePixelFormat, GLenum &theDataType)
 
- 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...
 
- Static Public Attributes inherited from OpenGl_Texture
static const GLuint NO_TEXTURE = 0
 Helpful constants. More...
 
- Protected Member Functions inherited from OpenGl_Texture
void applyDefaultSamplerParams (const Handle< OpenGl_Context > &theCtx)
 Apply default sampler parameters after texture creation. More...
 

Detailed Description

Point sprite resource. On modern hardware it will be texture with extra parameters. On ancient hardware sprites will be drawn using bitmaps.

Constructor & Destructor Documentation

◆ OpenGl_PointSprite()

OpenGl_PointSprite::OpenGl_PointSprite ( const TCollection_AsciiString theResourceId)

Create uninitialized resource.

◆ ~OpenGl_PointSprite()

virtual OpenGl_PointSprite::~OpenGl_PointSprite ( )
virtual

Destroy object.

Member Function Documentation

◆ DrawBitmap()

void OpenGl_PointSprite::DrawBitmap ( const Handle< OpenGl_Context > &  theCtx) const

Draw sprite using glBitmap. Please call glRasterPos3fv() before to setup sprite position.

◆ IsDisplayList()

Standard_Boolean OpenGl_PointSprite::IsDisplayList ( ) const
inline
Returns
true if this is display list bitmap

◆ IsPointSprite()

virtual bool OpenGl_PointSprite::IsPointSprite ( ) const
inlineoverridevirtual

Returns TRUE for point sprite texture.

Reimplemented from OpenGl_Texture.

◆ Release()

virtual void OpenGl_PointSprite::Release ( OpenGl_Context theCtx)
overridevirtual

Destroy object - will release GPU memory if any.

Reimplemented from OpenGl_Texture.

◆ SetDisplayList()

void OpenGl_PointSprite::SetDisplayList ( const Handle< OpenGl_Context > &  theCtx,
const GLuint  theBitmapList 
)

Initialize point sprite as display list.

Field Documentation

◆ myBitmapList

GLuint OpenGl_PointSprite::myBitmapList
protected

if of display list to draw sprite using glBitmap (for backward compatibility)


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