Class GorgonStreamOutLayout

Defines the layout of an input item within a buffer.

Inheritance
object
GorgonNamedObject
GorgonStreamOutLayout
Implements
Inherited Members
Namespace: Gorgon.Graphics.Core
Assembly: Gorgon.Graphics.Core.dll
Syntax
public sealed class GorgonStreamOutLayout : GorgonNamedObject, IGorgonNamedObject
Remarks

This defines the layout of a piece of data within a stream out buffer. The layout is defined by a list of GorgonStreamOutElement values that determine how the data within the layout is arranged.

Constructors

| Edit this page View Source

GorgonStreamOutLayout(string, IEnumerable<GorgonStreamOutElement>)

Initializes a new instance of the GorgonStreamOutLayout class.

Declaration
public GorgonStreamOutLayout(string name, IEnumerable<GorgonStreamOutElement> elements)
Parameters
Type Name Description
string name

Name of the object.
IEnumerable<GorgonStreamOutElement> elements

The input elements to assign to this layout.
Remarks

The elements list can contain up to 64 elements. If the list is longer than 64 elements, then it will be truncated to 64.

Exceptions
Type Condition
ArgumentNullException

Thrown when the name, or the elements parameter is null.
ArgumentEmptyException

Thrown when the name, or the elements parameter is empty.
ArgumentException

Thrown when an element with the same context, slot and index appears more than once in the elements parameter.

Properties

| Edit this page View Source

Elements

Property to return the input elements for this layout.

Declaration
public IReadOnlyList<GorgonStreamOutElement> Elements { get; }
Property Value
Type Description
IReadOnlyList<GorgonStreamOutElement>

Methods

| Edit this page View Source

Equals(GorgonStreamOutLayout)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(GorgonStreamOutLayout layout)
Parameters
Type Name Description
GorgonStreamOutLayout layout

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the layout parameter; otherwise, false.

Implements

Extension Methods