Class VertexElement

Vertex buffer data element. Defines access to data passed to Vertex Shader.

System.Object
VertexElement
System.IEquatable<VertexElement>
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class VertexElement : ValueType, IEquatable<VertexElement>

Constructors

VertexElement(VertexElement.Types, Byte, Byte, Boolean, PixelFormat)

Creates the vertex element description.

Declaration
public VertexElement(VertexElement.Types type, byte slot, byte offset, bool perInstance, PixelFormat format)
Parameters
VertexElement.Types type

Element type.
System.Byte slot

Vertex buffer bind slot.
System.Byte offset

Data byte offset.
System.Boolean perInstance

True if element data is instanced.
PixelFormat format

Data format.

Fields

Format

Format of the vertex element data.

Declaration
public PixelFormat Format
Field Value
PixelFormat

Offset

Byte offset of this element relative to the start of a vertex buffer. Use value 0 to use auto-calculated offset based on previous elements in the layout (except when explicitOffsets is false).

Declaration
public byte Offset
Field Value
System.Byte

PerInstance

Flag used to mark data using hardware-instancing (element will be repeated for every instance). Empty to step data per-vertex when reading input buffer stream (rather than per-instance step).

Declaration
public byte PerInstance
Field Value
System.Byte

Slot

Index of the input vertex buffer slot (as provided in GPUContext.BindVB).

Declaration
public byte Slot
Field Value
System.Byte

Type

Type of the vertex element data.

Declaration
public VertexElement.Types Type
Field Value
VertexElement.Types

Methods

Equals(VertexElement)

Declaration
public bool Equals(VertexElement other)
Parameters
VertexElement other

Returns
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

ToString()

Declaration
public override string ToString()
Returns
System.String

Extension Methods