Skip to content

Class PassPlan

Namespace: Apogee.Rendering.Graph
Assembly: Apogee.Rendering.dll

What the planner decided about one pass.

public sealed record PassPlan : IEquatable<PassPlan>

Inheritance

object ← PassPlan

Implements

IEquatable<PassPlan>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

PassPlan(string, PassType, bool, IReadOnlyList<string>, IReadOnlyList<string>, int, IReadOnlyList<ImageBarrierPlan>)

What the planner decided about one pass.

public PassPlan(string Name, PassType Type, bool Culled, IReadOnlyList<string> Reads, IReadOnlyList<string> Writes, int Barriers, IReadOnlyList<ImageBarrierPlan> ImageBarriers)

Parameters

Name string

Type PassType

Culled bool

Nothing that reaches an output depends on it, so it does not run.

Reads IReadOnlyList<string>

Writes IReadOnlyList<string>

Barriers int

How many barriers (image rectangles and buffers) go in front of it.

ImageBarriers IReadOnlyList<ImageBarrierPlan>

The image part of those barriers, for tools and tests.

Properties

Barriers

How many barriers (image rectangles and buffers) go in front of it.

public int Barriers { get; init; }

Property Value

int

Culled

Nothing that reaches an output depends on it, so it does not run.

public bool Culled { get; init; }

Property Value

bool

ImageBarriers

The image part of those barriers, for tools and tests.

public IReadOnlyList<ImageBarrierPlan> ImageBarriers { get; init; }

Property Value

IReadOnlyList<ImageBarrierPlan>

Name

public string Name { get; init; }

Property Value

string

Reads

public IReadOnlyList<string> Reads { get; init; }

Property Value

IReadOnlyList<string>

Type

public PassType Type { get; init; }

Property Value

PassType

Writes

public IReadOnlyList<string> Writes { get; init; }

Property Value

IReadOnlyList<string>