VisuTwin Canvas
C++ 3D Engine — Metal Backend
Loading...
Searching...
No Matches
visutwin::canvas::BlendState Class Reference

#include <platform/graphics/blendState.h>

Public Member Functions

int alphaDstFactor () const
int alphaOp () const
int alphaSrcFactor () const
bool alphaWrite () const
 BlendState ()
bool blueWrite () const
int colorDstFactor () const
int colorOp () const
int colorSrcFactor () const
bool enabled () const
bool greenWrite () const
uint32_t key () const
bool redWrite () const
void setAlphaDstFactor (int factor)
void setAlphaOp (int op)
void setAlphaSrcFactor (int factor)
void setAlphaWrite (bool value)
void setBlueWrite (bool value)
void setColorDstFactor (int factor)
void setColorOp (int op)
void setColorSrcFactor (int factor)
void setEnabled (bool value)
void setGreenWrite (bool value)
void setRedWrite (bool value)

Static Public Member Functions

static BlendState additiveBlend ()
static BlendState alphaBlend ()
static BlendState multiplicativeBlend ()

Detailed Description

BlendState is a descriptor that defines how output of fragment shader is written and blended into a render target. A blend state can be set on a material using Material::blendState, or in some cases on the graphics device using GraphicsDevice::setBlendState.

For the best performance, do not modify the blend state after it has been created, but create multiple blend states and assign them to the material or graphics device as needed.

Definition at line 42 of file blendState.h.

Constructor & Destructor Documentation

◆ BlendState()

visutwin::canvas::BlendState::BlendState ( )

Definition at line 27 of file blendState.cpp.

References visutwin::canvas::alphaWriteShift, visutwin::canvas::blueWriteShift, visutwin::canvas::greenWriteShift, and visutwin::canvas::redWriteShift.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

Member Function Documentation

◆ additiveBlend()

BlendState visutwin::canvas::BlendState::additiveBlend ( )
static

Definition at line 197 of file blendState.cpp.

References visutwin::canvas::BLENDEQUATION_ADD, visutwin::canvas::BLENDMODE_ONE, visutwin::canvas::BLENDMODE_SRC_ALPHA, BlendState(), setAlphaDstFactor(), setAlphaOp(), setAlphaSrcFactor(), setColorDstFactor(), setColorOp(), setColorSrcFactor(), and setEnabled().

Referenced by visutwin::canvas::GlbParser::parse().

◆ alphaBlend()

BlendState visutwin::canvas::BlendState::alphaBlend ( )
static

Definition at line 168 of file blendState.cpp.

References visutwin::canvas::BLENDEQUATION_ADD, visutwin::canvas::BLENDMODE_ONE, visutwin::canvas::BLENDMODE_ONE_MINUS_SRC_ALPHA, visutwin::canvas::BLENDMODE_SRC_ALPHA, BlendState(), setAlphaDstFactor(), setAlphaOp(), setAlphaSrcFactor(), setColorDstFactor(), setColorOp(), setColorSrcFactor(), and setEnabled().

Referenced by visutwin::canvas::ElementInput::syncTextElements().

◆ alphaDstFactor()

int visutwin::canvas::BlendState::alphaDstFactor ( ) const

Definition at line 86 of file blendState.cpp.

References visutwin::canvas::alphaDstFactorShift, and visutwin::canvas::factorMask.

◆ alphaOp()

int visutwin::canvas::BlendState::alphaOp ( ) const

Definition at line 76 of file blendState.cpp.

References visutwin::canvas::alphaOpShift, and visutwin::canvas::opMask.

◆ alphaSrcFactor()

int visutwin::canvas::BlendState::alphaSrcFactor ( ) const

Definition at line 81 of file blendState.cpp.

References visutwin::canvas::alphaSrcFactorShift, and visutwin::canvas::factorMask.

◆ alphaWrite()

bool visutwin::canvas::BlendState::alphaWrite ( ) const

Definition at line 56 of file blendState.cpp.

References visutwin::canvas::alphaWriteShift.

◆ blueWrite()

bool visutwin::canvas::BlendState::blueWrite ( ) const

Definition at line 51 of file blendState.cpp.

References visutwin::canvas::blueWriteShift.

◆ colorDstFactor()

int visutwin::canvas::BlendState::colorDstFactor ( ) const

Definition at line 71 of file blendState.cpp.

References visutwin::canvas::colorDstFactorShift, and visutwin::canvas::factorMask.

◆ colorOp()

int visutwin::canvas::BlendState::colorOp ( ) const

Definition at line 61 of file blendState.cpp.

References visutwin::canvas::colorOpShift, and visutwin::canvas::opMask.

◆ colorSrcFactor()

int visutwin::canvas::BlendState::colorSrcFactor ( ) const

Definition at line 66 of file blendState.cpp.

References visutwin::canvas::colorSrcFactorShift, and visutwin::canvas::factorMask.

◆ enabled()

bool visutwin::canvas::BlendState::enabled ( ) const

Definition at line 36 of file blendState.cpp.

References visutwin::canvas::blendShift.

◆ greenWrite()

bool visutwin::canvas::BlendState::greenWrite ( ) const

Definition at line 46 of file blendState.cpp.

References visutwin::canvas::greenWriteShift.

◆ key()

uint32_t visutwin::canvas::BlendState::key ( ) const
inline

Definition at line 47 of file blendState.h.

◆ multiplicativeBlend()

BlendState visutwin::canvas::BlendState::multiplicativeBlend ( )
static

Definition at line 181 of file blendState.cpp.

References visutwin::canvas::BLENDEQUATION_ADD, visutwin::canvas::BLENDMODE_DST_COLOR, visutwin::canvas::BLENDMODE_ONE, visutwin::canvas::BLENDMODE_ZERO, BlendState(), setAlphaDstFactor(), setAlphaOp(), setAlphaSrcFactor(), setColorDstFactor(), setColorOp(), setColorSrcFactor(), and setEnabled().

Referenced by visutwin::canvas::ShadowCatcher::initialize().

◆ redWrite()

bool visutwin::canvas::BlendState::redWrite ( ) const

Definition at line 41 of file blendState.cpp.

References visutwin::canvas::redWriteShift.

◆ setAlphaDstFactor()

void visutwin::canvas::BlendState::setAlphaDstFactor ( int factor)

Definition at line 141 of file blendState.cpp.

References visutwin::canvas::alphaDstFactorShift, and visutwin::canvas::factorMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setAlphaOp()

void visutwin::canvas::BlendState::setAlphaOp ( int op)

Definition at line 131 of file blendState.cpp.

References visutwin::canvas::alphaOpShift, and visutwin::canvas::opMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setAlphaSrcFactor()

void visutwin::canvas::BlendState::setAlphaSrcFactor ( int factor)

Definition at line 136 of file blendState.cpp.

References visutwin::canvas::alphaSrcFactorShift, and visutwin::canvas::factorMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setAlphaWrite()

void visutwin::canvas::BlendState::setAlphaWrite ( bool value)

Definition at line 161 of file blendState.cpp.

References visutwin::canvas::alphaWriteShift.

◆ setBlueWrite()

void visutwin::canvas::BlendState::setBlueWrite ( bool value)

Definition at line 156 of file blendState.cpp.

References visutwin::canvas::blueWriteShift.

◆ setColorDstFactor()

void visutwin::canvas::BlendState::setColorDstFactor ( int factor)

Definition at line 126 of file blendState.cpp.

References visutwin::canvas::colorDstFactorShift, and visutwin::canvas::factorMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setColorOp()

void visutwin::canvas::BlendState::setColorOp ( int op)

Definition at line 116 of file blendState.cpp.

References visutwin::canvas::colorOpShift, and visutwin::canvas::opMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setColorSrcFactor()

void visutwin::canvas::BlendState::setColorSrcFactor ( int factor)

Definition at line 121 of file blendState.cpp.

References visutwin::canvas::colorSrcFactorShift, and visutwin::canvas::factorMask.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setEnabled()

void visutwin::canvas::BlendState::setEnabled ( bool value)

Definition at line 107 of file blendState.cpp.

References visutwin::canvas::blendShift.

Referenced by additiveBlend(), alphaBlend(), and multiplicativeBlend().

◆ setGreenWrite()

void visutwin::canvas::BlendState::setGreenWrite ( bool value)

Definition at line 151 of file blendState.cpp.

References visutwin::canvas::greenWriteShift.

◆ setRedWrite()

void visutwin::canvas::BlendState::setRedWrite ( bool value)

Definition at line 146 of file blendState.cpp.

References visutwin::canvas::redWriteShift.

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