Struct OutputDescription
Contains properties that describe the characteristics of a new pipeline state object.
Namespace: Evergine.Common.Graphics
Assembly: Evergine.Common.dll
Syntax
public struct OutputDescriptionConstructors
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 for each color attachment. |
| TextureSampleCount | sampleCount | The number of samples in each target attachment. |
| uint | arraySliceCount | The number of rendered views. |
Fields
ArraySliceCount
Gets the number of view counts.
Declaration
public readonly uint ArraySliceCountField Value
| Type | Description |
|---|---|
| uint |
CachedHashCode
Precomputed outputDescription hash. Used to speed up the comparison of output descriptions.
Declaration
public readonly int CachedHashCodeField Value
| Type | Description |
|---|---|
| int |
ColorAttachments
An array of attachment descriptions, one for each color attachment.
Declaration
public readonly OutputAttachmentDescription[] ColorAttachmentsField Value
| Type | Description |
|---|---|
| OutputAttachmentDescription[] |
DepthAttachment
A description of the depth attachment, or null if it doesn't exist.
Declaration
public readonly OutputAttachmentDescription? DepthAttachmentField Value
| Type | Description |
|---|---|
| OutputAttachmentDescription? |
SampleCount
The number of samples in each target attachment.
Declaration
public readonly TextureSampleCount SampleCountField Value
| Type | Description |
|---|---|
| TextureSampleCount |
Methods
CreateFromFrameBuffer(FrameBuffer)
Creates a new instance of OutputDescription from a FrameBuffer.
Declaration
public static OutputDescription CreateFromFrameBuffer(FrameBuffer frameBuffer)Parameters
| Type | Name | Description |
|---|---|---|
| FrameBuffer | frameBuffer | The FrameBuffer from which 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 | The object used for comparison. |
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 |
|
Overrides
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 such as a hash table. |
Overrides
Operators
operator ==(OutputDescription, OutputDescription)
Implements the operator ==.
Declaration
public static bool operator ==(OutputDescription value1, OutputDescription value2)Parameters
| Type | Name | Description |
|---|---|---|
| OutputDescription | value1 | The first value. |
| OutputDescription | value2 | The second value. |
Returns
| Type | Description |
|---|---|
| bool | The result of the operation. |
operator !=(OutputDescription, OutputDescription)
Implements the operator ==.
Declaration
public static bool operator !=(OutputDescription value1, OutputDescription value2)Parameters
| Type | Name | Description |
|---|---|---|
| OutputDescription | value1 | The first value. |
| OutputDescription | value2 | The second value. |
Returns
| Type | Description |
|---|---|
| bool | The result of the operator. |