OGRE  14.2
Object-Oriented Graphics Rendering Engine
Ogre::ColourBlendState Struct Reference

Describes the global blending factors for combining subsequent renders with the existing frame contents. More...

#include <OgreBlendMode.h>

Public Member Functions

 ColourBlendState ()
 
bool blendingEnabled () const
 can we simply overwrite the existing pixels or do we have to blend More...
 

Public Attributes

Write Mask

Whether writing is enabled for each of the 4 colour channels

bool writeR: 1
 
bool writeG: 1
 
bool writeB: 1
 
bool writeA: 1
 
Blending factors

used to weight the render colour components and the frame colour components

SceneBlendFactor sourceFactor
 
SceneBlendFactor destFactor
 
SceneBlendFactor sourceFactorAlpha
 
SceneBlendFactor destFactorAlpha
 
Blending operations

The blend operation mode for combining colour values

SceneBlendOperation operation
 
SceneBlendOperation alphaOperation
 

Detailed Description

Describes the global blending factors for combining subsequent renders with the existing frame contents.

By default the operation is Ogre::SBO_ADD, which creates this equation

$$final = (passOutput * sourceFactor) + (frameBuffer * destFactor)$$

Each of the factors is specified as one of Ogre::SceneBlendFactor.

By setting a different Ogre::SceneBlendOperation you can achieve a different effect.

Constructor & Destructor Documentation

◆ ColourBlendState()

Ogre::ColourBlendState::ColourBlendState ( )
inline

Member Function Documentation

◆ blendingEnabled()

bool Ogre::ColourBlendState::blendingEnabled ( ) const
inline

can we simply overwrite the existing pixels or do we have to blend

References Ogre::SBF_ONE, and Ogre::SBF_ZERO.

Member Data Documentation

◆ writeR

bool Ogre::ColourBlendState::writeR

◆ writeG

bool Ogre::ColourBlendState::writeG

◆ writeB

bool Ogre::ColourBlendState::writeB

◆ writeA

bool Ogre::ColourBlendState::writeA

◆ sourceFactor

SceneBlendFactor Ogre::ColourBlendState::sourceFactor

◆ destFactor

SceneBlendFactor Ogre::ColourBlendState::destFactor

◆ sourceFactorAlpha

SceneBlendFactor Ogre::ColourBlendState::sourceFactorAlpha

◆ destFactorAlpha

SceneBlendFactor Ogre::ColourBlendState::destFactorAlpha

◆ operation

SceneBlendOperation Ogre::ColourBlendState::operation

◆ alphaOperation

SceneBlendOperation Ogre::ColourBlendState::alphaOperation

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