Struct OutputDescription

Contains properties that describe the characteristics of a new pipeline state object.

Implements

IEquatable<OutputDescription>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Evergine.Common.Graphics

Assembly: Evergine.Common.dll

Syntax

public struct OutputDescription : IEquatable<OutputDescription>

Constructors

OutputDescription(OutputAttachmentDescription?, OutputAttachmentDescription[], TextureSampleCount, uint)

Initializes a new instance of the OutputDescription struct.

Declaration

public OutputDescription(OutputAttachmentDescription? depth, OutputAttachmentDescription[] colors, TextureSampleCount sampleCount, uint arraySliceCount)

Parameters

Type	Name	Description
OutputAttachmentDescription?	depth	A description of the depth attachment.
OutputAttachmentDescription[]	colors	An array of descriptions of each color attachment.
TextureSampleCount	sampleCount	The number of samples in each target attachment.
uint	arraySliceCount	The number of views rendered.

Fields

ArraySliceCount

Gets the number of view counts.

Declaration

public readonly uint ArraySliceCount

Field Value

Type	Description
uint

CachedHashCode

Precomputed outputDescription hash. Used to speed up the comparison between output descriptions.

Declaration

public readonly int CachedHashCode

Field Value

Type	Description
int

ColorAttachments

An array of attachment descriptions, one for each color attachment.

Declaration

public readonly OutputAttachmentDescription[] ColorAttachments

Field Value

Type	Description
OutputAttachmentDescription[]

DepthAttachment

A description of the depth attachment, or null if none exists.

Declaration

public readonly OutputAttachmentDescription? DepthAttachment

Field Value

Type	Description
OutputAttachmentDescription?

SampleCount

The number of samples in each target attachment.

Declaration

public readonly TextureSampleCount SampleCount

Field Value

Type	Description
TextureSampleCount

Methods

CreateFromFrameBuffer(FrameBuffer)

Create a new instance of OutputDescription from a FrameBuffer.

Declaration

public static OutputDescription CreateFromFrameBuffer(FrameBuffer frameBuffer)

Parameters

Type	Name	Description
FrameBuffer	frameBuffer	The framebuffer to extract the attachment description.

Returns

Type	Description
OutputDescription	A new instance of OutputDescription.

Equals(OutputDescription)

Returns a hash code for this instance.

Declaration

public bool Equals(OutputDescription other)

Parameters

Type	Name	Description
OutputDescription	other	Other used to compare.

Returns

Type	Description
bool	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

Operators

operator ==(OutputDescription, OutputDescription)

Implements the operator ==.

Declaration

public static bool operator ==(OutputDescription value1, OutputDescription value2)

Parameters

Type	Name	Description
OutputDescription	value1	The value1.
OutputDescription	value2	The value2.

Returns

Type	Description
bool	The result of the operator.

operator !=(OutputDescription, OutputDescription)

Implements the operator ==.

Declaration

public static bool operator !=(OutputDescription value1, OutputDescription value2)

Parameters

Type	Name	Description
OutputDescription	value1	The value1.
OutputDescription	value2	The value2.

Returns

Type	Description
bool	The result of the operator.

Implements

IEquatable<T>

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)