Kanzi  3.9.4
Kanzi Engine API
graphics_blend_mode.hpp File Reference

Namespaces

 kanzi
 Easing functions that require external dependencies for calculation.
 

Enumerations

enum  kanzi::BlendAlphaEquation : int32_t {
  kanzi::BlendAlphaEquationNone, kanzi::BlendAlphaEquationAdd, kanzi::BlendAlphaEquationSubtract, kanzi::BlendAlphaEquationReverseSubtract,
  kanzi::BlendAlphaEquationMin, kanzi::BlendAlphaEquationMax, kanzi::BlendAlphaEquationComponentMask
}
 Blend equation for alpha. More...
 
enum  kanzi::BlendColorEquation : int32_t {
  kanzi::BlendColorEquationNone, kanzi::BlendColorEquationAdd, kanzi::BlendColorEquationSubtract, kanzi::BlendColorEquationReverseSubtract,
  kanzi::BlendColorEquationMin, kanzi::BlendColorEquationMax, kanzi::BlendColorEquationComponentMask
}
 Blend equation for color. More...
 
enum  kanzi::BlendComponentBitShift : int8_t {
  kanzi::BlendComponentBitShiftSrcColor, kanzi::BlendComponentBitShiftSrcAlpha, kanzi::BlendComponentBitShiftDstColor, kanzi::BlendComponentBitShiftDstAlpha,
  kanzi::BlendComponentBitShiftEquationColor, kanzi::BlendComponentBitShiftEquationAlpha
}
 Blend component bit shifts. More...
 
enum  kanzi::BlendDstAlphaFactor : int32_t {
  kanzi::BlendDstAlphaFactorZero, kanzi::BlendDstAlphaFactorOne, kanzi::BlendDstAlphaFactorSrcAlpha, kanzi::BlendDstAlphaFactorOneMinusSrcAlpha,
  kanzi::BlendDstAlphaFactorDstAlpha, kanzi::BlendDstAlphaFactorOneMinusDstAlpha, kanzi::BlendDstAlphaFactorConstantAlpha, kanzi::BlendDstAlphaFactorOneMinusConstantAlpha,
  kanzi::BlendDstAlphaFactorMask
}
 Blend factor for destination alpha. More...
 
enum  kanzi::BlendDstColorFactor : int32_t {
  kanzi::BlendDstColorFactorZero, kanzi::BlendDstColorFactorOne, kanzi::BlendDstColorFactorSrcColor, kanzi::BlendDstColorFactorOneMinusSrcColor,
  kanzi::BlendDstColorFactorDstColor, kanzi::BlendDstColorFactorOneMinusDstColor, kanzi::BlendDstColorFactorSrcAlpha, kanzi::BlendDstColorFactorOneMinusSrcAlpha,
  kanzi::BlendDstColorFactorDstAlpha, kanzi::BlendDstColorFactorOneMinusDstAlpha, kanzi::BlendDstColorFactorConstantColor, kanzi::BlendDstColorFactorOneMinusConstantColor,
  kanzi::BlendDstColorFactorConstantAlpha, kanzi::BlendDstColorFactorOneMinusConstantAlpha, kanzi::BlendDstColorFactorSrcAlphaSaturate, kanzi::BlendDstColorFactorMask
}
 Blend factor for destination color. More...
 
enum  kanzi::BlendEquation : int8_t {
  kanzi::BlendEquationNone, kanzi::BlendEquationAdd, kanzi::BlendEquationSubtract, kanzi::BlendEquationReverseSubtract,
  kanzi::BlendEquationMin, kanzi::BlendEquationMax, kanzi::BlendEquationMask
}
 Blend equation. More...
 
enum  kanzi::BlendFactor : int8_t {
  kanzi::BlendFactorZero, kanzi::BlendFactorOne, kanzi::BlendFactorSrcColor, kanzi::BlendFactorOneMinusSrcColor,
  kanzi::BlendFactorDstColor, kanzi::BlendFactorOneMinusDstColor, kanzi::BlendFactorSrcAlpha, kanzi::BlendFactorOneMinusSrcAlpha,
  kanzi::BlendFactorDstAlpha, kanzi::BlendFactorOneMinusDstAlpha, kanzi::BlendFactorConstantColor, kanzi::BlendFactorOneMinusConstantColor,
  kanzi::BlendFactorConstantAlpha, kanzi::BlendFactorOneMinusConstantAlpha, kanzi::BlendFactorSrcAlphaSaturate, kanzi::BlendFactorMask
}
 Blend mode representation. More...
 
enum  kanzi::BlendSrcAlphaFactor : int32_t {
  kanzi::BlendSrcAlphaFactorZero, kanzi::BlendSrcAlphaFactorOne, kanzi::BlendSrcAlphaFactorSrcAlpha, kanzi::BlendSrcAlphaFactorOneMinusSrcAlpha,
  kanzi::BlendSrcAlphaFactorDstAlpha, kanzi::BlendSrcAlphaFactorOneMinusDstAlpha, kanzi::BlendSrcAlphaFactorConstantAlpha, kanzi::BlendSrcAlphaFactorOneMinusConstantAlpha,
  kanzi::BlendSrcAlphaFactorMask
}
 Blend factor for source alpha. More...
 
enum  kanzi::BlendSrcColorFactor : int32_t {
  kanzi::BlendSrcColorFactorZero, kanzi::BlendSrcColorFactorOne, kanzi::BlendSrcColorFactorSrcColor, kanzi::BlendSrcColorFactorOneMinusSrcColor,
  kanzi::BlendSrcColorFactorDstColor, kanzi::BlendSrcColorFactorOneMinusDstColor, kanzi::BlendSrcColorFactorSrcAlpha, kanzi::BlendSrcColorFactorOneMinusSrcAlpha,
  kanzi::BlendSrcColorFactorDstAlpha, kanzi::BlendSrcColorFactorOneMinusDstAlpha, kanzi::BlendSrcColorFactorConstantColor, kanzi::BlendSrcColorFactorOneMinusConstantColor,
  kanzi::BlendSrcColorFactorConstantAlpha, kanzi::BlendSrcColorFactorOneMinusConstantAlpha, kanzi::BlendSrcColorFactorSrcAlphaSaturate, kanzi::BlendSrcColorFactorMask
}
 Blend factor for source color. More...
 

Functions

constexpr BlendEquation kanzi::getBlendEquationAlpha (int blendMode)
 Gets the alpha blend equation. More...
 
constexpr BlendEquation kanzi::getBlendEquationColor (int blendMode)
 Gets the color blend equation. More...
 
constexpr BlendFactor kanzi::getDstAlphaFactor (int blendMode)
 Gets the destination alpha factor. More...
 
constexpr BlendFactor kanzi::getDstColorFactor (int blendMode)
 Gets the destination color factor. More...
 
constexpr BlendFactor kanzi::getSrcAlphaFactor (int blendMode)
 Gets the source alpha factor. More...
 
constexpr BlendFactor kanzi::getSrcColorFactor (int blendMode)
 Gets the source color factor. More...
 
constexpr bool kanzi::isOpaquableBlendMode (int blendMode)
 Indicates whether a blend mode can be rendered as opaque as substitute for clearing. More...
 

Variables

constexpr int kanzi::GraphicsBlendModeAdditive
 Additive blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeAlpha
 Legacy blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeClear
 Clear blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeDestinationAtop
 Destination Atop blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeDestinationIn
 Destination In blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeDestinationOut
 Destination Out blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeDestinationOver
 Destination Over blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeExclusiveOr
 Exclusive Or blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeMixedAlpha
 Mixed Alpha blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeMultiply
 Multiply blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeOpaque
 Opaque blend mode. More...
 
constexpr int kanzi::GraphicsBlendModePremultipliedAlpha
 Premultiplied Alpha blend mode - the default and recommend mode for alpha blending. More...
 
constexpr int kanzi::GraphicsBlendModeScreen
 Screen blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeSourceAtop
 Source Atop blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeSourceIn
 Source In blend mode. More...
 
constexpr int kanzi::GraphicsBlendModeSourceOut
 Source Out blend mode. More...