BlendState Struct Reference

Structure defining how the GPU should perform blending when outputting pixels onto a surface. More...

Inheritance diagram for BlendState:

Public Member Functions
override bool	Equals ([NotNullWhen(true)] object? obj)
override int	GetHashCode ()
override string	ToString ()
bool	Equals (BlendState other)

Static Public Member Functions
static bool	operator== (BlendState a, BlendState b)
	Checks if two BlendState values are considered equal.
static bool	operator!= (BlendState a, BlendState b)
	Checks if two BlendState values are not equal.

Public Attributes
string	Name
	The name of the See also BlendState value. Used for debugging.
bool	EnableBlending
	Indicates whether blending is enabled.
BlendFactor	SourceBlend
	When blending is enabled, indicates how the source image is factored into the blended image.
BlendFactor	DestinationBlend
	When blending is enabled, indicates how the destination image is factored into the blended image.
BlendFunction	BlendFunction
	When blending is enabled, indicates how the source image and destination image are blended together.

Static Public Attributes
static readonly BlendState	None
	A See also BlendState value indicating that no blending should occur.
static readonly BlendState	AlphaBlend
	A BlendState value indicating that alpha blending should occur.

Detailed Description

Structure defining how the GPU should perform blending when outputting pixels onto a surface.

Member Function Documentation

operator!=()

static bool operator!= ( BlendState a, BlendState b )

inlinestatic

Checks if two BlendState values are not equal.

Parameters

a	Left side of the operation
b	Right side of the operation

Returns

False if equal, true otherwise

operator==()

static bool operator== ( BlendState a, BlendState b )

inlinestatic

Checks if two BlendState values are considered equal.

Parameters

a	Left side of the operation
b	Right side of the operation

Returns

True if equal, false otherwise

Member Data Documentation

AlphaBlend

readonly BlendState AlphaBlend

static

Initial value:

= new BlendState
    {
        Name = "AlphaBlend",
        EnableBlending = true,
        SourceBlend = BlendFactor.SourceAlpha,
        DestinationBlend = BlendFactor.OneMinusSourceAlpha
    }

A BlendState value indicating that alpha blending should occur.

None

readonly BlendState None

static

Initial value:

= new BlendState
    {
        Name = "None",
        EnableBlending = false,
        SourceBlend = BlendFactor.One,
        DestinationBlend = BlendFactor.Zero
    }

A

See also

BlendState

value indicating that no blending should occur.

---

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

• /builds/universe/graphics/src/Inertia.Platform/BlendState.cs