openscenegraph
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
osg::FrameBufferObject Class Reference
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,
FrameBufferAttachment
AttachmentMap
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, VALIDATOR,
  VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM,
  OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER,
  UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING
}
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,(StateAttribute::Type) 0x101010)
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
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 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)
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)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
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)
- 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

Static Public Member Functions

static void deleteFrameBufferObject (unsigned int contextID, GLuint program)
static void flushDeletedFrameBufferObjects (unsigned int contextID, double currentTime, double &availableTime)
static void discardDeletedFrameBufferObjects (unsigned int contextID)

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

- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
ref_ptr< ShaderComponent_shaderComponent
ref_ptr< StateAttributeCallback_updateCallback
ref_ptr< StateAttributeCallback_eventCallback

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
READ_FRAMEBUFFER 
DRAW_FRAMEBUFFER 
READ_DRAW_FRAMEBUFFER 

Constructor & Destructor Documentation

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

Member Function Documentation

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.

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

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

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.

GLenum osg::FrameBufferObject::convertBufferComponentToGLenum ( BufferComponent  attachment_point) const
protected
static void osg::FrameBufferObject::deleteFrameBufferObject ( unsigned int  contextID,
GLuint  program 
)
static

Mark internal FBO for deletion. Deletion requests are queued until they can be executed in the proper GL context.

void osg::FrameBufferObject::dirtyAll ( )
inlineprotected
static void osg::FrameBufferObject::discardDeletedFrameBufferObjects ( unsigned int  contextID)
static

discard all the cached FBOs which need to be deleted in the OpenGL context related to contextID.

static void osg::FrameBufferObject::flushDeletedFrameBufferObjects ( unsigned int  contextID,
double  currentTime,
double &  availableTime 
)
static

flush all the cached FBOs which need to be deleted in the OpenGL context related to contextID.

const FrameBufferAttachment & osg::FrameBufferObject::getAttachment ( FrameBufferObject::BufferComponent  attachment_point) const
inline
const FrameBufferObject::AttachmentMap & osg::FrameBufferObject::getAttachmentMap ( ) const
inline
const MultipleRenderingTargets& osg::FrameBufferObject::getMultipleRenderingTargets ( ) const
inline
bool osg::FrameBufferObject::hasAttachment ( FrameBufferObject::BufferComponent  attachment_point) const
inline
bool osg::FrameBufferObject::hasMultipleRenderingTargets ( ) const
inline
bool osg::FrameBufferObject::isMultisample ( ) const
osg::FrameBufferObject::META_StateAttribute ( osg  ,
FrameBufferObject  ,
(StateAttribute::Type 0x101010 
)
FrameBufferObject& osg::FrameBufferObject::operator= ( const FrameBufferObject )
inlineprotected
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.

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

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

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

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