Skip to content

GraphicsAPI reference

Struct ColorAttachment

Namespace: MicroEngine.Graphics.Devices
Assembly: MicroEngine.Graphics.dll
Guide: The graphics device

The colour attachment of a pass.

C#
public readonly struct ColorAttachment : IEquatable<ColorAttachment>

Implements

IEquatable<ColorAttachment>

Constructors

ColorAttachment(RenderTarget, LoadOp, StoreOp, ColorF)

The colour attachment of a pass.

C#
public ColorAttachment(RenderTarget Target, LoadOp Load = LoadOp.Load, StoreOp Store = StoreOp.Store, ColorF Clear = default)

Parameters

Target RenderTarget

The target; its ColorFormat must match the bound pipeline.

Load LoadOp

Load operation.

Store StoreOp

Store operation.

Clear ColorF

Clear value when Load is Clear (premultiplied).

Properties

Clear

Clear value when Load is Clear (premultiplied).

C#
public ColorF Clear { get; init; }

Property Value

ColorF

Load

Load operation.

C#
public LoadOp Load { get; init; }

Property Value

LoadOp

Store

Store operation.

C#
public StoreOp Store { get; init; }

Property Value

StoreOp

Target

The target; its ColorFormat must match the bound pipeline.

C#
public RenderTarget Target { get; init; }

Property Value

RenderTarget

Methods

Deconstruct(out RenderTarget, out LoadOp, out StoreOp, out ColorF)

C#
public void Deconstruct(out RenderTarget Target, out LoadOp Load, out StoreOp Store, out ColorF Clear)

Parameters

Target RenderTarget

Load LoadOp

Store StoreOp

Clear ColorF

Equals(object)

C#
public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(ColorAttachment)

C#
public bool Equals(ColorAttachment other)

Parameters

other ColorAttachment

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(ColorAttachment, ColorAttachment)

C#
public static bool operator ==(ColorAttachment left, ColorAttachment right)

Parameters

left ColorAttachment

right ColorAttachment

Returns

bool

operator !=(ColorAttachment, ColorAttachment)

C#
public static bool operator !=(ColorAttachment left, ColorAttachment right)

Parameters

left ColorAttachment

right ColorAttachment

Returns

bool