om::graphics::base::BlendMode Class Reference

A class that specifies how blending should be performed between a source and destination fragment. More...

#include <omGraphicsBlendMode.h>

Public Member Functions
	BlendMode ()
	Create a new blend mode with the default blending parameters. More...
	BlendMode (BlendFactor newSourceFactor, BlendFactor newDestinationFactor, BlendFunction newFunction)
	Create a new blend mode with the given source and destination blend factors and blend function. More...
	BlendMode (BlendFactor newSourceFactor, BlendFactor newDestinationFactor, BlendFunction newFunction, const Color4f &newConstantColor)
	Create a new blend mode with the given source and destination blend factors, blend function, and color. More...
const BlendFactor &	getSource () const
	Return an object that describes the source color blend factor for this blend mode. More...
void	setSource (const BlendFactor &newSource)
	Set the source color blend factor for this blend mode. More...
const BlendFactor &	getDestination () const
	Return an object that describes the destination color blend factor for this blend mode. More...
void	setDestination (const BlendFactor &newDestination)
	Set the destination color blend factor for this blend mode. More...
const BlendFunction &	getFunction () const
	Return an object that describes the blending function used by this blend mode. More...
void	setFunction (const BlendFunction &newFunction)
	Set the blending function used by this blend mode. More...
const Color4f &	getConstantColor () const
	Return a constant color value that may be used as a blending factor in some operations. More...
void	setConstantColor (const Color4f &newConstantColor)
	Set a constant color value that may be used as a blending factor in some operations. More...
Bool	operator== (const BlendMode &other) const
	Return whether or not this blend mode is equal to another blend mode. More...
Bool	operator!= (const BlendMode &other) const
	Return whether or not this blend mode is not equal to another blend mode. More...

Detailed Description

A class that specifies how blending should be performed between a source and destination fragment.

Constructor & Destructor Documentation

om::graphics::base::BlendMode::BlendMode ( )

inline

Create a new blend mode with the default blending parameters.

The default blend mode is SOURCE_ALPHA for the source factor, INVERSE_SOURCE_ALPHA for the destination factor, and a blend function of ADD.

om::graphics::base::BlendMode::BlendMode ( BlendFactor  newSourceFactor, BlendFactor  newDestinationFactor, BlendFunction  newFunction  )

inline

Create a new blend mode with the given source and destination blend factors and blend function.

om::graphics::base::BlendMode::BlendMode ( BlendFactor  newSourceFactor, BlendFactor  newDestinationFactor, BlendFunction  newFunction, const Color4f &  newConstantColor  )

inline

Create a new blend mode with the given source and destination blend factors, blend function, and color.

Member Function Documentation

const BlendFactor& om::graphics::base::BlendMode::getSource ( ) const

inline

Return an object that describes the source color blend factor for this blend mode.

void om::graphics::base::BlendMode::setSource ( const BlendFactor &  newSource )

inline

Set the source color blend factor for this blend mode.

const BlendFactor& om::graphics::base::BlendMode::getDestination ( ) const

inline

Return an object that describes the destination color blend factor for this blend mode.

void om::graphics::base::BlendMode::setDestination ( const BlendFactor &  newDestination )

inline

Set the destination color blend factor for this blend mode.

const BlendFunction& om::graphics::base::BlendMode::getFunction ( ) const

inline

Return an object that describes the blending function used by this blend mode.

void om::graphics::base::BlendMode::setFunction ( const BlendFunction &  newFunction )

inline

Set the blending function used by this blend mode.

const Color4f& om::graphics::base::BlendMode::getConstantColor ( ) const

inline

Return a constant color value that may be used as a blending factor in some operations.

void om::graphics::base::BlendMode::setConstantColor ( const Color4f &  newConstantColor )

inline

Set a constant color value that may be used as a blending factor in some operations.

Bool om::graphics::base::BlendMode::operator== ( const BlendMode &  other ) const

inline

Return whether or not this blend mode is equal to another blend mode.

Bool om::graphics::base::BlendMode::operator!= ( const BlendMode &  other ) const

inline

Return whether or not this blend mode is not equal to another blend mode.

---

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

• omGraphicsBlendMode.h