Class FrameGraphPassContext

Namespace

BSGameLib.Game.Rendering

Assembly

BSGameLib.Game.dll

What a pass sees while it runs: its name, the resources it declared, and how to get them.

public sealed class FrameGraphPassContext

Inheritance

object

FrameGraphPassContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Descriptor

The render pass descriptor the pass draws with. Resolved the first time it is read, then kept.

public RenderPassDescriptor Descriptor { get; }

Property Value

RenderPassDescriptor

ExecutionContext

The execution context the graph is running with.

public FrameGraphExecutionContext ExecutionContext { get; }

Property Value

FrameGraphExecutionContext

Name

The name of the pass.

public string Name { get; }

Property Value

string

Reads

The resources the pass declared as reads.

public IReadOnlyList<FrameGraphResourceHandle> Reads { get; }

Property Value

IReadOnlyList<FrameGraphResourceHandle>

Writes

The resources the pass declared as writes.

public IReadOnlyList<FrameGraphResourceHandle> Writes { get; }

Property Value

IReadOnlyList<FrameGraphResourceHandle>

Methods

GetRenderTarget(FrameGraphResourceHandle)

Returns the render target for handle, a resource the pass declared, acquired from the resource allocator.

public IRenderTarget GetRenderTarget(FrameGraphResourceHandle handle)

Parameters

handle FrameGraphResourceHandle

Returns

IRenderTarget

Exceptions

InvalidOperationException

The pass did not declare handle, or the execution context has no resource allocator.

GetResource(FrameGraphResourceHandle)

Returns the description of handle, a resource the pass declared.

public FrameGraphResourceInfo GetResource(FrameGraphResourceHandle handle)

Parameters

handle FrameGraphResourceHandle

Returns

FrameGraphResourceInfo

Exceptions

InvalidOperationException

The pass did not declare handle.