Struct RenderTargetDescription

Namespace

BSGameLib.Game.Rendering

Assembly

BSGameLib.Game.dll

Describes how a concrete render target should be realized for a frame-graph resource.

public readonly record struct RenderTargetDescription : IEquatable<RenderTargetDescription>

Implements

IEquatable<RenderTargetDescription>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RenderTargetDescription(int, int, FrameGraphResourceFormat, FrameGraphResourceFlags)

Describes how a concrete render target should be realized for a frame-graph resource.

public RenderTargetDescription(int Width, int Height, FrameGraphResourceFormat Format, FrameGraphResourceFlags Flags)

Parameters

Width int

Height int

Format FrameGraphResourceFormat

Flags FrameGraphResourceFlags

Properties

Flags

public FrameGraphResourceFlags Flags { get; init; }

Property Value

FrameGraphResourceFlags

Format

public FrameGraphResourceFormat Format { get; init; }

Property Value

FrameGraphResourceFormat

Height

public int Height { get; init; }

Property Value

int

Width

public int Width { get; init; }

Property Value

int

Methods

From(FrameGraphResourceDescriptor, Func<(int width, int height)>)

Works out the pixel size of a target for descriptor. A size that is not set is the back buffer's size, from backBufferSizeProvider, times the scale, which is 1 when not set. Each size is at least one pixel.

public static RenderTargetDescription From(FrameGraphResourceDescriptor descriptor, Func<(int width, int height)> backBufferSizeProvider)

Parameters

descriptor FrameGraphResourceDescriptor

backBufferSizeProvider Func<(int width, int height)>

Returns

RenderTargetDescription