XII Release 0.1.0
Loading...
Searching...
No Matches
Public Types | List of all members
xiiGALBlendFactor Struct Reference

This describes the blend factor. More...

#include <BlendState.h>

Inheritance diagram for xiiGALBlendFactor:
[legend]

Public Types

enum  Enum : StorageType {
  Undefined = 0U , Zero , One , SourceColor ,
  InverseSourceColor , SourceAlpha , InverseSourceAlpha , DestinationAlpha ,
  InverseDestinationAlpha , DestinationColor , InverseDestinationColor , SourceAlphaSaturate ,
  BlendFactor , InverseBlendFactor , SourceOneColor , InverseSourceOneColor ,
  SourceOneAlpha , InverseSourceOneAlpha , ENUM_COUNT , Default = Undefined
}
 
using StorageType = xiiUInt8
 

Detailed Description

This describes the blend factor.

It generally mirrors the D3D11_BLEND and D3D12_BLEND enumerations, and is used to define source and destination blend factors for color and alpha channels.

Member Enumeration Documentation

◆ Enum

enum xiiGALBlendFactor::Enum : StorageType
Enumerator
Undefined 

Undefined blend factor.

Zero 

The blend factor is zero.

One 

The blend factor is one.

SourceColor 

The blend factor is RGB data from a pixel shader.

InverseSourceColor 

The blend factor is 1-RGB, where RGB is the data from a pixel shader.

SourceAlpha 

The blend factor is alpha (A) data from a pixel shader.

InverseSourceAlpha 

The blend factor is 1-A, where A is alpha data from a pixel shader.

DestinationAlpha 

The blend factor is alpha (A) data from a render target.

InverseDestinationAlpha 

The blend factor is 1-A, where A is alpha data from a render target.

DestinationColor 

The blend factor is RGB data from a render target.

InverseDestinationColor 

The blend factor is 1-RGB, where RGB is the data from a render target.

SourceAlphaSaturate 

The blend factor is (f,f,f,1), where f = min(As, 1-Ad), As is alpha data from a pixel shader, and Ad is alpha data from a render target.

BlendFactor 

The blend factor is the constant blend factor set in the device.

InverseBlendFactor 

The blend factor is one minus constant blend factor set in the device.

SourceOneColor 

The blend factor is the second RGB data output from a pixel shader.

InverseSourceOneColor 

The blend factor is 1-RGB, where RGB is the second RGB data output from a pixel shader.

SourceOneAlpha 

The blend factor is the second alpha (A) data output from a pixel shader.

InverseSourceOneAlpha 

The blend factor is 1-A, where A is the second alpha data output from a pixel shader.

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