Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vl::FBOStencilBufferAttachment Class Reference

A stencil renderbuffer to be attached to a FramebufferObject. More...

#include <FramebufferObject.hpp>

+ Inheritance diagram for vl::FBOStencilBufferAttachment:

Public Member Functions

 FBOStencilBufferAttachment (EStencilBufferFormat type=SBF_STENCIL_INDEX8)
 Constructor. More...
 
void setType (EStencilBufferFormat type)
 The type to specify when allocating the renderbuffer storage. More...
 
EStencilBufferFormat type () const
 The type to specify when allocating the renderbuffer storage. More...
 
- Public Member Functions inherited from vl::FBORenderbufferAttachment
 FBORenderbufferAttachment ()
 Constructor. More...
 
 ~FBORenderbufferAttachment ()
 Destructor. More...
 
void createRenderBuffer ()
 Creates a renderbuffer object calling glGenRenderbuffers(). More...
 
void deleteRenderBuffer ()
 Deletes the renderbuffer object created with the createRenderBuffer() method. More...
 
void setHandle (GLuint handle)
 Sets the handle for this attachment, the handle must have been created by glGenRenderbuffers(). More...
 
GLuint handle () const
 Returns the handle obtained by createRenderBuffer() using glGenRenderbuffers() More...
 
void initStorage (int w, int h, int samples)
 Initializes the storage of the renderbuffer with the given sample count and dimensions. More...
 
void initStorage ()
 The same as calling initStorage( width(), height() ) More...
 
int width () const
 Returns the with of the renderbuffer storage. More...
 
int height () const
 Returns the height of the renderbuffer storage. More...
 
int samples () const
 Returns the number of samples to be used when allocating the renderbuffer's storage. More...
 
void setWidth (int w)
 The width of the renderbuffer storage to be allocated. More...
 
void setHeight (int h)
 The height of the renderbuffer storage to be allocated. More...
 
void setSamples (int samples)
 Sets the number of samples to be specified when allocating the renderbuffer's storage. More...
 
bool renderbufferStorageReady () const
 Returns false if the renderbuffer storage needs to be created or reallocated due to a change of the sample count, renderbuffer type or dimension. More...
 
- Public Member Functions inherited from vl::FBOAbstractAttachment
 FBOAbstractAttachment ()
 Constructor. More...
 
virtual ~FBOAbstractAttachment ()
 Destructor. More...
 
virtual void unbindFromAllFBO ()
 Removes the FBO attachment from all bound FBO render targets. More...
 
const std::set< ref< FramebufferObject > > & fboFramebuffers () const
 Returns an std::set containing the FramebufferObject that use this FBO attachment. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Member Functions

virtual int internalType ()
 
- Protected Member Functions inherited from vl::FBORenderbufferAttachment
void bindAttachment (FramebufferObject *fbo, EAttachmentPoint attach_point)
 
- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Protected Attributes

EStencilBufferFormat mType
 
- Protected Attributes inherited from vl::FBORenderbufferAttachment
GLuint mHandle
 
int mWidth
 
int mHeight
 
int mSamples
 
bool mReallocateRenderbuffer
 
- Protected Attributes inherited from vl::FBOAbstractAttachment
std::set< ref< FramebufferObject > > mFramebufferObjects
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

A stencil renderbuffer to be attached to a FramebufferObject.

Definition at line 248 of file FramebufferObject.hpp.

Constructor & Destructor Documentation

◆ FBOStencilBufferAttachment()

vl::FBOStencilBufferAttachment::FBOStencilBufferAttachment ( EStencilBufferFormat  type = SBF_STENCIL_INDEX8)
inline

Constructor.

Definition at line 254 of file FramebufferObject.hpp.

Member Function Documentation

◆ internalType()

virtual int vl::FBOStencilBufferAttachment::internalType ( )
inlineprotectedvirtual

Implements vl::FBORenderbufferAttachment.

Definition at line 267 of file FramebufferObject.hpp.

◆ setType()

void vl::FBOStencilBufferAttachment::setType ( EStencilBufferFormat  type)
inline

The type to specify when allocating the renderbuffer storage.

Definition at line 261 of file FramebufferObject.hpp.

◆ type()

EStencilBufferFormat vl::FBOStencilBufferAttachment::type ( ) const
inline

The type to specify when allocating the renderbuffer storage.

Definition at line 264 of file FramebufferObject.hpp.

Member Data Documentation

◆ mType

EStencilBufferFormat vl::FBOStencilBufferAttachment::mType
protected

Definition at line 270 of file FramebufferObject.hpp.


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