Overte C++ Documentation
gpu::State::BlendFunction Struct Reference

Represents blending state. More...

#include <State.h>

Public Member Functions

 BlendFunction (bool enabled, BlendArg sourceColor, BlendOp operationColor, BlendArg destinationColor, BlendArg sourceAlpha, BlendOp operationAlpha, BlendArg destinationAlpha)
 
 BlendFunction (bool enabled=false, BlendArg source=ONE, BlendOp operation=BLEND_OP_ADD, BlendArg destination=ZERO)
 
bool isEnabled () const
 
BlendArg getSourceColor () const
 
BlendArg getDestinationColor () const
 
BlendOp getOperationColor () const
 
BlendArg getSourceAlpha () const
 
BlendArg getDestinationAlpha () const
 
BlendOp getOperationAlpha () const
 

Public Attributes

uint16 enabled
 true if blending is enabled.
 
BlendArg sourceColor
 Determines how source color will be used.
 
BlendArg sourceAlpha
 Determines how source alpha will be used.
 
BlendArg destColor
 Determines how destination color will be used.
 
BlendArg destAlpha
 Determines how destination alpha will be used.
 
BlendOp opColor
 Type of operation that will be performed on color if blending is enabled.
 
BlendOp opAlpha
 Type of operation that will be performed on alpha if blending is enabled.
 

Detailed Description

Represents blending state.

Constructor & Destructor Documentation

◆ BlendFunction() [1/2]

gpu::State::BlendFunction::BlendFunction ( bool  enabled,
BlendArg  sourceColor,
BlendOp  operationColor,
BlendArg  destinationColor,
BlendArg  sourceAlpha,
BlendOp  operationAlpha,
BlendArg  destinationAlpha 
)
inline
Parameters
enabledtrue if blending is enabled.
sourceColorDetermines how source color will be used.
operationColorType of operation that will be performed on color if blending is enabled.
destinationColorDetermines how destination color will be used.
sourceAlphaDetermines how source alpha will be used.
operationAlphaType of operation that will be performed on alpha if blending is enabled.
destinationAlphaDetermines how destination alpha will be used.

◆ BlendFunction() [2/2]

gpu::State::BlendFunction::BlendFunction ( bool  enabled = false,
BlendArg  source = ONE,
BlendOp  operation = BLEND_OP_ADD,
BlendArg  destination = ZERO 
)
inline
Parameters
enabledtrue if blending is enabled.
sourceDetermines how source (both color and alpha) will be used.
operationType of operation that will be performed on both color and alpha if blending is enabled.
destinationDetermines how destination (both color and alpha) will be used.

Member Function Documentation

◆ getDestinationAlpha()

BlendArg gpu::State::BlendFunction::getDestinationAlpha ( ) const
inline
Returns
Enum determining how destination alpha will be used.

◆ getDestinationColor()

BlendArg gpu::State::BlendFunction::getDestinationColor ( ) const
inline
Returns
Enum determining how destination color will be used.

◆ getOperationAlpha()

BlendOp gpu::State::BlendFunction::getOperationAlpha ( ) const
inline
Returns
Type of operation that will be performed on alpha if blending is enabled.

◆ getOperationColor()

BlendOp gpu::State::BlendFunction::getOperationColor ( ) const
inline
Returns
Type of operation that will be performed if blending is enabled.

◆ getSourceAlpha()

BlendArg gpu::State::BlendFunction::getSourceAlpha ( ) const
inline
Returns
Enum determining how source alpha will be used.

◆ getSourceColor()

BlendArg gpu::State::BlendFunction::getSourceColor ( ) const
inline
Returns
Enum determining how source color will be used.

◆ isEnabled()

bool gpu::State::BlendFunction::isEnabled ( ) const
inline
Returns
true if blending is enabled.

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