Skip to content

GraphicsAPI reference

Struct DepthAttachment

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

The depth attachment of a pass: the depth texture of a target created with Depth.

C#
public readonly struct DepthAttachment : IEquatable<DepthAttachment>

Implements

IEquatable<DepthAttachment>

Constructors

DepthAttachment(RenderTarget, LoadOp, StoreOp, float)

The depth attachment of a pass: the depth texture of a target created with Depth.

C#
public DepthAttachment(RenderTarget Target, LoadOp Load = LoadOp.Clear, StoreOp Store = StoreOp.DontCare, float ClearDepth = 1)

Parameters

Target RenderTarget

The target owning the depth texture (same size as the colour attachment).

Load LoadOp

Load operation.

Store StoreOp

Store operation.

ClearDepth float

Clear depth when Load is Clear (0..1).

Properties

ClearDepth

Clear depth when Load is Clear (0..1).

C#
public float ClearDepth { get; init; }

Property Value

float

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 owning the depth texture (same size as the colour attachment).

C#
public RenderTarget Target { get; init; }

Property Value

RenderTarget

Methods

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

C#
public void Deconstruct(out RenderTarget Target, out LoadOp Load, out StoreOp Store, out float ClearDepth)

Parameters

Target RenderTarget

Load LoadOp

Store StoreOp

ClearDepth float

Equals(object)

C#
public override bool Equals(object obj)

Parameters

obj object

Returns

bool

Equals(DepthAttachment)

C#
public bool Equals(DepthAttachment other)

Parameters

other DepthAttachment

Returns

bool

GetHashCode()

C#
public override int GetHashCode()

Returns

int

ToString()

C#
public override string ToString()

Returns

string

Operators

operator ==(DepthAttachment, DepthAttachment)

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

Parameters

left DepthAttachment

right DepthAttachment

Returns

bool

operator !=(DepthAttachment, DepthAttachment)

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

Parameters

left DepthAttachment

right DepthAttachment

Returns

bool