OGRE  1.11.4
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

SceneBlendOperation alphaOperation
 The blend operation mode for combining alpha values. More...
 
SceneBlendFactor destFactor
 multiplied by the frame colour components More...
 
SceneBlendFactor destFactorAlpha
 multiplied by the frame alpha components More...
 
SceneBlendOperation operation
 The blend operation mode for combining colour values. More...
 
SceneBlendFactor sourceFactor
 multiplied by the render colour components More...
 
SceneBlendFactor sourceFactorAlpha
 multiplied by the render alpha components More...
 
bool writeA: 1
 
bool writeB: 1
 
bool writeG: 1
 
bool writeR: 1
 Whether writing is enabled for each of the 4 colour channels. More...
 

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

Whether writing is enabled for each of the 4 colour channels.

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ writeG

bool Ogre::ColourBlendState::writeG

◆ writeB

bool Ogre::ColourBlendState::writeB

◆ writeA

bool Ogre::ColourBlendState::writeA

◆ sourceFactor

SceneBlendFactor Ogre::ColourBlendState::sourceFactor

multiplied by the render colour components

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ destFactor

SceneBlendFactor Ogre::ColourBlendState::destFactor

multiplied by the frame colour components

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ sourceFactorAlpha

SceneBlendFactor Ogre::ColourBlendState::sourceFactorAlpha

multiplied by the render alpha components

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ destFactorAlpha

SceneBlendFactor Ogre::ColourBlendState::destFactorAlpha

multiplied by the frame alpha components

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ operation

SceneBlendOperation Ogre::ColourBlendState::operation

The blend operation mode for combining colour values.

Referenced by Ogre::RenderSystem::setColourBlendState().

◆ alphaOperation

SceneBlendOperation Ogre::ColourBlendState::alphaOperation

The blend operation mode for combining alpha values.

Referenced by Ogre::RenderSystem::setColourBlendState().


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