openscenegraph
Public Types | Public Member Functions | Protected Member Functions | List of all members
osg::FrameBufferObject Class Reference

#include <FrameBufferObject>

Inheritance diagram for osg::FrameBufferObject:
osg::StateAttribute osg::Object osg::Referenced

Public Types

enum  BindTarget { READ_FRAMEBUFFER = GL_READ_FRAMEBUFFER_EXT , DRAW_FRAMEBUFFER = GL_DRAW_FRAMEBUFFER_EXT , READ_DRAW_FRAMEBUFFER = GL_FRAMEBUFFER_EXT }
 
typedef std::map< Camera::BufferComponent, FrameBufferAttachmentAttachmentMap
 
typedef std::vector< GLenum > MultipleRenderingTargets
 
typedef Camera::BufferComponent BufferComponent
 
- Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0 , ON = 0x1 , OVERRIDE = 0x2 , PROTECTED = 0x4 ,
  INHERIT = 0x8
}
 
enum  Type {
  TEXTURE , POLYGONMODE , POLYGONOFFSET , MATERIAL ,
  ALPHAFUNC , ANTIALIAS , COLORTABLE , CULLFACE ,
  FOG , FRONTFACE , LIGHT , POINT ,
  LINEWIDTH , LINESTIPPLE , POLYGONSTIPPLE , SHADEMODEL ,
  TEXENV , TEXENVFILTER , TEXGEN , TEXMAT ,
  LIGHTMODEL , BLENDFUNC , BLENDEQUATION , LOGICOP ,
  STENCIL , COLORMASK , DEPTH , VIEWPORT ,
  SCISSOR , BLENDCOLOR , MULTISAMPLE , CLIPPLANE ,
  COLORMATRIX , VERTEXPROGRAM , FRAGMENTPROGRAM , POINTSPRITE ,
  PROGRAM , CLAMPCOLOR , HINT , SAMPLEMASKI ,
  PRIMITIVERESTARTINDEX , CLIPCONTROL , VALIDATOR , VIEWMATRIXEXTRACTOR ,
  OSGNV_PARAMETER_BLOCK , OSGNVEXT_TEXTURE_SHADER , OSGNVEXT_VERTEX_PROGRAM , OSGNVEXT_REGISTER_COMBINERS ,
  OSGNVCG_PROGRAM , OSGNVSLANG_PROGRAM , OSGNVPARSE_PROGRAM_PARSER , UNIFORMBUFFERBINDING ,
  TRANSFORMFEEDBACKBUFFERBINDING , ATOMICCOUNTERBUFFERBINDING , PATCH_PARAMETER , FRAME_BUFFER_OBJECT ,
  VERTEX_ATTRIB_DIVISOR , SHADERSTORAGEBUFFERBINDING , INDIRECTDRAWBUFFERBINDING , VIEWPORTINDEXED ,
  DEPTHRANGEINDEXED , SCISSORINDEXED , BINDIMAGETEXTURE , SAMPLER ,
  CAPABILITY = 100
}
 
typedef GLenum GLMode
 
typedef unsigned int GLModeValue
 
typedef unsigned int OverrideValue
 
typedef std::pair< Type, unsigned int > TypeMemberPair
 
typedef std::vector< StateSet * > ParentList
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
 

Public Member Functions

 FrameBufferObject ()
 
 FrameBufferObject (const FrameBufferObject &copy, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
 META_StateAttribute (osg, FrameBufferObject, FRAME_BUFFER_OBJECT)
 
const AttachmentMapgetAttachmentMap () const
 
void setAttachment (BufferComponent attachment_point, const FrameBufferAttachment &attachment)
 
const FrameBufferAttachmentgetAttachment (BufferComponent attachment_point) const
 
bool hasAttachment (BufferComponent attachment_point) const
 
bool hasMultipleRenderingTargets () const
 
const MultipleRenderingTargetsgetMultipleRenderingTargets () const
 
bool isMultisample () const
 
int compare (const StateAttribute &sa) const
 
void apply (State &state) const
 
GLuint getHandle (unsigned int contextID) const
 
void apply (State &state, BindTarget target) const
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 
virtual void releaseGLObjects (osg::State *=0) const
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual ObjectcloneType () const =0
 
virtual Objectclone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual TextureasTexture ()
 
virtual const TextureasTexture () const
 
virtual Type getType () const =0
 
virtual unsigned int getMember () const
 
TypeMemberPair getTypeMemberPair () const
 
virtual bool isTextureAttribute () const
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentListgetParents () const
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 
unsigned int getNumParents () const
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
virtual bool getModeUsage (ModeUsage &) const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 
void setUpdateCallback (StateAttributeCallback *uc)
 
StateAttributeCallbackgetUpdateCallback ()
 
const StateAttributeCallbackgetUpdateCallback () const
 
void setEventCallback (StateAttributeCallback *ec)
 
StateAttributeCallbackgetEventCallback ()
 
const StateAttributeCallbackgetEventCallback () const
 
virtual void compileGLObjects (State &) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
std::string getCompoundClassName () const
 
virtual NodeasNode ()
 
virtual const NodeasNode () const
 
virtual NodeVisitorasNodeVisitor ()
 
virtual const NodeVisitorasNodeVisitor () const
 
virtual StateSetasStateSet ()
 
virtual const StateSetasStateSet () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () const
 
virtual CameraasCamera ()
 
virtual const CameraasCamera () const
 
virtual DrawableasDrawable ()
 
virtual const DrawableasDrawable () const
 
virtual CallbackasCallback ()
 
virtual const CallbackasCallback () const
 
virtual CallbackObjectasCallbackObject ()
 
virtual const CallbackObjectasCallbackObject () const
 
virtual UserDataContainerasUserDataContainer ()
 
virtual const UserDataContainerasUserDataContainer () const
 
virtual ValueObjectasValueObject ()
 
virtual const ValueObjectasValueObject () const
 
virtual ImageasImage ()
 
virtual const ImageasImage () const
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 
virtual const ReferencedgetUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::MutexgetRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSetgetObserverSet () const
 
ObserverSetgetOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Protected Member Functions

virtual ~FrameBufferObject ()
 
FrameBufferObjectoperator= (const FrameBufferObject &)
 
void updateDrawBuffers ()
 
void dirtyAll ()
 
GLenum convertBufferComponentToGLenum (BufferComponent attachment_point) const
 
- Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
 
void addParent (osg::StateSet *object)
 
void removeParent (osg::StateSet *object)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandlergetDeleteHandler ()
 
- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
 
ref_ptr< ShaderComponent_shaderComponent
 
ref_ptr< StateAttributeCallback_updateCallback
 
ref_ptr< StateAttributeCallback_eventCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Member Typedef Documentation

◆ AttachmentMap

◆ BufferComponent

◆ MultipleRenderingTargets

Member Enumeration Documentation

◆ BindTarget

Enumerator
READ_FRAMEBUFFER 
DRAW_FRAMEBUFFER 
READ_DRAW_FRAMEBUFFER 

Constructor & Destructor Documentation

◆ FrameBufferObject() [1/2]

osg::FrameBufferObject::FrameBufferObject ( )

◆ FrameBufferObject() [2/2]

osg::FrameBufferObject::FrameBufferObject ( const FrameBufferObject copy,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

◆ ~FrameBufferObject()

virtual osg::FrameBufferObject::~FrameBufferObject ( )
protectedvirtual

Member Function Documentation

◆ apply() [1/2]

void osg::FrameBufferObject::apply ( State ) const
virtual

apply the OpenGL state attributes. The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

◆ apply() [2/2]

void osg::FrameBufferObject::apply ( State state,
BindTarget  target 
) const

Bind the FBO as either the read or draw target, or both.

◆ compare()

int osg::FrameBufferObject::compare ( const StateAttribute sa) const
virtual

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

◆ convertBufferComponentToGLenum()

GLenum osg::FrameBufferObject::convertBufferComponentToGLenum ( BufferComponent  attachment_point) const
protected

◆ dirtyAll()

void osg::FrameBufferObject::dirtyAll ( )
inlineprotected

◆ getAttachment()

const FrameBufferAttachment & osg::FrameBufferObject::getAttachment ( FrameBufferObject::BufferComponent  attachment_point) const
inline

◆ getAttachmentMap()

const FrameBufferObject::AttachmentMap & osg::FrameBufferObject::getAttachmentMap ( ) const
inline

◆ getHandle()

GLuint osg::FrameBufferObject::getHandle ( unsigned int  contextID) const
inline

◆ getMultipleRenderingTargets()

const MultipleRenderingTargets & osg::FrameBufferObject::getMultipleRenderingTargets ( ) const
inline

◆ hasAttachment()

bool osg::FrameBufferObject::hasAttachment ( FrameBufferObject::BufferComponent  attachment_point) const
inline

◆ hasMultipleRenderingTargets()

bool osg::FrameBufferObject::hasMultipleRenderingTargets ( ) const
inline

◆ isMultisample()

bool osg::FrameBufferObject::isMultisample ( ) const

◆ META_StateAttribute()

osg::FrameBufferObject::META_StateAttribute ( osg  ,
FrameBufferObject  ,
FRAME_BUFFER_OBJECT   
)

◆ operator=()

FrameBufferObject & osg::FrameBufferObject::operator= ( const FrameBufferObject )
inlineprotected

◆ releaseGLObjects()

virtual void osg::FrameBufferObject::releaseGLObjects ( osg::State = 0) const
virtual

If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objexts for all graphics contexts.

Reimplemented from osg::StateAttribute.

◆ resizeGLObjectBuffers()

virtual void osg::FrameBufferObject::resizeGLObjectBuffers ( unsigned int  maxSize)
virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

◆ setAttachment()

void osg::FrameBufferObject::setAttachment ( BufferComponent  attachment_point,
const FrameBufferAttachment attachment 
)

◆ updateDrawBuffers()

void osg::FrameBufferObject::updateDrawBuffers ( )
protected

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