openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::BlendFunc Class Reference
Inheritance diagram for osg::BlendFunc:
osg::StateAttribute osg::Object osg::Referenced

Classes

class  Extensions

Public Types

enum  BlendFuncMode {
  DST_ALPHA = GL_DST_ALPHA, DST_COLOR = GL_DST_COLOR, ONE = GL_ONE, ONE_MINUS_DST_ALPHA = GL_ONE_MINUS_DST_ALPHA,
  ONE_MINUS_DST_COLOR = GL_ONE_MINUS_DST_COLOR, ONE_MINUS_SRC_ALPHA = GL_ONE_MINUS_SRC_ALPHA, ONE_MINUS_SRC_COLOR = GL_ONE_MINUS_SRC_COLOR, SRC_ALPHA = GL_SRC_ALPHA,
  SRC_ALPHA_SATURATE = GL_SRC_ALPHA_SATURATE, SRC_COLOR = GL_SRC_COLOR, CONSTANT_COLOR = GL_CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR = GL_ONE_MINUS_CONSTANT_COLOR,
  CONSTANT_ALPHA = GL_CONSTANT_ALPHA, ONE_MINUS_CONSTANT_ALPHA = GL_ONE_MINUS_CONSTANT_ALPHA, ZERO = GL_ZERO
}
- 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

 BlendFunc ()
 BlendFunc (GLenum source, GLenum destination)
 BlendFunc (GLenum source, GLenum destination, GLenum source_alpha, GLenum destination_alpha)
 BlendFunc (const BlendFunc &trans, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_StateAttribute (osg, BlendFunc, BLENDFUNC)
virtual int compare (const StateAttribute &sa) const
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
void setFunction (GLenum source, GLenum destination)
void setFunction (GLenum source_rgb, GLenum destination_rgb, GLenum source_alpha, GLenum destination_alpha)
void setSource (GLenum source)
GLenum getSource () const
void setSourceRGB (GLenum source)
GLenum getSourceRGB () const
void setSourceAlpha (GLenum source)
GLenum getSourceAlpha () const
void setDestination (GLenum destination)
GLenum getDestination () const
void setDestinationRGB (GLenum destination)
GLenum getDestinationRGB () const
void setDestinationAlpha (GLenum destination)
GLenum getDestinationAlpha () const
virtual void apply (State &state) 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 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
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (State *=0) 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 ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
static void setExtensions (unsigned int contextID, Extensions *extensions)

Protected Member Functions

virtual ~BlendFunc ()
- 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

Protected Attributes

GLenum _source_factor
GLenum _destination_factor
GLenum _source_factor_alpha
GLenum _destination_factor_alpha
- 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

Detailed Description

Encapsulates OpenGL blend/transparency state.

Blending combines incoming fragment with a fragment already present in the target buffer.

OpenGL 1.1 supports following source and destination blending factors: GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_DST_ALPHA, GL_ONE_MINUS_DST_ALPHA, GL_ZERO, GL_ONE.

Moreover, there are three source-only blending factors: GL_DST_COLOR, GL_ONE_MINUS_DST_COLOR, GL_SRC_ALPHA_SATURATE and two destination-only blending factors: GL_SRC_COLOR, GL_ONE_MINUS_SRC_COLOR. OpenGL 1.4 allowed to use these five blending factors as both - source and destination blending factors.

Following four source and destination blending factors were added by Imaging subset of OpenGL 1.2 and made mandatory by OpenGL 1.4: GL_CONSTANT_COLOR, GL_ONE_MINUS_CONSTANT_COLOR, GL_CONSTANT_ALPHA, GL_ONE_MINUS_CONSTANT_ALPHA

OpenGL 1.4 further provides glBlendFuncSeparate (promoted from GL_EXT_blend_func_separate). It makes possible to set blending functions for RGB and Alpha separately. Before, it was possible to set just one blending function for RGBA.

Member Enumeration Documentation

Enumerator:
DST_ALPHA 
DST_COLOR 
ONE 
ONE_MINUS_DST_ALPHA 
ONE_MINUS_DST_COLOR 
ONE_MINUS_SRC_ALPHA 
ONE_MINUS_SRC_COLOR 
SRC_ALPHA 
SRC_ALPHA_SATURATE 
SRC_COLOR 
CONSTANT_COLOR 
ONE_MINUS_CONSTANT_COLOR 
CONSTANT_ALPHA 
ONE_MINUS_CONSTANT_ALPHA 
ZERO 

Constructor & Destructor Documentation

osg::BlendFunc::BlendFunc ( )
osg::BlendFunc::BlendFunc ( GLenum  source,
GLenum  destination 
)
osg::BlendFunc::BlendFunc ( GLenum  source,
GLenum  destination,
GLenum  source_alpha,
GLenum  destination_alpha 
)
osg::BlendFunc::BlendFunc ( const BlendFunc trans,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)
inline

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::BlendFunc::~BlendFunc ( )
protectedvirtual

Member Function Documentation

virtual void osg::BlendFunc::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.

virtual int osg::BlendFunc::compare ( const StateAttribute sa) const
inlinevirtual

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

Implements osg::StateAttribute.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

GLenum osg::BlendFunc::getDestination ( ) const
inline
GLenum osg::BlendFunc::getDestinationAlpha ( ) const
inline
GLenum osg::BlendFunc::getDestinationRGB ( ) const
inline
static Extensions* osg::BlendFunc::getExtensions ( unsigned int  contextID,
bool  createIfNotInitalized 
)
static

Returns the Extensions object for the given context. If createIfNotInitalized is true and the Extensions object doesn't exist, getExtensions() creates it on the given context. Returns NULL if createIfNotInitalized is false and the Extensions object doesn't exist.

virtual bool osg::BlendFunc::getModeUsage ( StateAttribute::ModeUsage ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

References osg::StateAttribute::ModeUsage::usesMode().

GLenum osg::BlendFunc::getSource ( ) const
inline
GLenum osg::BlendFunc::getSourceAlpha ( ) const
inline
GLenum osg::BlendFunc::getSourceRGB ( ) const
inline
osg::BlendFunc::META_StateAttribute ( osg  ,
BlendFunc  ,
BLENDFUNC   
)
void osg::BlendFunc::setDestination ( GLenum  destination)
inline
void osg::BlendFunc::setDestinationAlpha ( GLenum  destination)
inline
void osg::BlendFunc::setDestinationRGB ( GLenum  destination)
inline
static void osg::BlendFunc::setExtensions ( unsigned int  contextID,
Extensions extensions 
)
static

setExtensions() allows users to override the extensions across graphics contexts. Typically used when you have different extensions supported across graphics pipes, but need to ensure that they all use the same low common denominator extensions.

void osg::BlendFunc::setFunction ( GLenum  source,
GLenum  destination 
)
inline
void osg::BlendFunc::setFunction ( GLenum  source_rgb,
GLenum  destination_rgb,
GLenum  source_alpha,
GLenum  destination_alpha 
)
inline
void osg::BlendFunc::setSource ( GLenum  source)
inline
void osg::BlendFunc::setSourceAlpha ( GLenum  source)
inline
void osg::BlendFunc::setSourceRGB ( GLenum  source)
inline

Member Data Documentation

GLenum osg::BlendFunc::_destination_factor
protected
GLenum osg::BlendFunc::_destination_factor_alpha
protected
GLenum osg::BlendFunc::_source_factor
protected
GLenum osg::BlendFunc::_source_factor_alpha
protected

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