Struct D3D11InputElementDesc

A description of a single element for the input-assembler stage.

Implements

IEquatable<D3D11InputElementDesc>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.D3D11

Assembly: JeremyAnsel.DirectX.D3D11.dll

Syntax

public struct D3D11InputElementDesc : IEquatable<D3D11InputElementDesc>

Constructors

| Edit this page View Source

D3D11InputElementDesc(ReadOnlySpan<byte>, uint, DxgiFormat, uint, uint, D3D11InputClassification, uint)

Initializes a new instance of the D3D11InputElementDesc struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "byte", Justification = "Reviewed")]
public D3D11InputElementDesc(ReadOnlySpan<byte> semanticName, uint semanticIndex, DxgiFormat format, uint inputSlot, uint alignedByteOffset, D3D11InputClassification inputSlotClass, uint instanceDataStepRate)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	semanticName	The HLSL semantic associated with this element in a shader input-signature.
uint	semanticIndex	The semantic index for the element.
DxgiFormat	format	The data type of the element data.
uint	inputSlot	An integer value that identifies the input-assembler.
uint	alignedByteOffset	Offset (in bytes) between each element. Optional.
D3D11InputClassification	inputSlotClass	Identifies the input data class for a single input slot.
uint	instanceDataStepRate	The number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data.

| Edit this page View Source

D3D11InputElementDesc(ReadOnlySpan<char>, uint, DxgiFormat, uint, uint, D3D11InputClassification, uint)

Initializes a new instance of the D3D11InputElementDesc struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "byte", Justification = "Reviewed")]
public D3D11InputElementDesc(ReadOnlySpan<char> semanticName, uint semanticIndex, DxgiFormat format, uint inputSlot, uint alignedByteOffset, D3D11InputClassification inputSlotClass, uint instanceDataStepRate)

Parameters

Type	Name	Description
ReadOnlySpan<char>	semanticName	The HLSL semantic associated with this element in a shader input-signature.
uint	semanticIndex	The semantic index for the element.
DxgiFormat	format	The data type of the element data.
uint	inputSlot	An integer value that identifies the input-assembler.
uint	alignedByteOffset	Offset (in bytes) between each element. Optional.
D3D11InputClassification	inputSlotClass	Identifies the input data class for a single input slot.
uint	instanceDataStepRate	The number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data.

| Edit this page View Source

D3D11InputElementDesc(string, uint, DxgiFormat, uint, uint, D3D11InputClassification, uint)

Initializes a new instance of the D3D11InputElementDesc struct.

Declaration

[SuppressMessage("Microsoft.Naming", "CA1720:IdentifiersShouldNotContainTypeNames", MessageId = "byte", Justification = "Reviewed")]
public D3D11InputElementDesc(string semanticName, uint semanticIndex, DxgiFormat format, uint inputSlot, uint alignedByteOffset, D3D11InputClassification inputSlotClass, uint instanceDataStepRate)

Parameters

Type	Name	Description
string	semanticName	The HLSL semantic associated with this element in a shader input-signature.
uint	semanticIndex	The semantic index for the element.
DxgiFormat	format	The data type of the element data.
uint	inputSlot	An integer value that identifies the input-assembler.
uint	alignedByteOffset	Offset (in bytes) between each element. Optional.
D3D11InputClassification	inputSlotClass	Identifies the input data class for a single input slot.
uint	instanceDataStepRate	The number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data.

Fields

| Edit this page View Source

SemanticNameMaxLength

Gets the maximum char count of the string that contains the semantic name.

Declaration

public const int SemanticNameMaxLength = 64

Field Value

Type	Description
int

Properties

| Edit this page View Source

AlignedByteOffset

Gets or sets the offset (in bytes) between each element. Optional.

Declaration

public uint AlignedByteOffset { get; set; }

Property Value

Type	Description
uint

| Edit this page View Source

Format

Gets or sets the data type of the element data.

Declaration

public DxgiFormat Format { get; set; }

Property Value

Type	Description
DxgiFormat

| Edit this page View Source

InputSlot

Gets or sets an integer value that identifies the input-assembler.

Declaration

public uint InputSlot { get; set; }

Property Value

Type	Description
uint

| Edit this page View Source

InputSlotClass

Gets or sets the input data class for a single input slot.

Declaration

public D3D11InputClassification InputSlotClass { get; set; }

Property Value

Type	Description
D3D11InputClassification

| Edit this page View Source

InstanceDataStepRate

Gets or sets the number of instances to draw using the same per-instance data before advancing in the buffer by one element. This value must be 0 for an element that contains per-vertex data.

Declaration

public uint InstanceDataStepRate { get; set; }

Property Value

Type	Description
uint

| Edit this page View Source

SemanticIndex

Gets or sets the semantic index for the element.

Declaration

public uint SemanticIndex { get; set; }

Property Value

Type	Description
uint

| Edit this page View Source

SemanticName

Gets or sets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public string SemanticName { get; set; }

Property Value

Type	Description
string

Methods

| Edit this page View Source

Equals(D3D11InputElementDesc)

Declaration

public readonly bool Equals(D3D11InputElementDesc other)

Parameters

Type	Name	Description
D3D11InputElementDesc	other

Returns

Type	Description
bool

| Edit this page View Source

Equals(object?)

Declaration

public override readonly bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

| Edit this page View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

| Edit this page View Source

GetSemanticNameAsSpan()

Gets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public ReadOnlySpan<byte> GetSemanticNameAsSpan()

Returns

Type	Description
ReadOnlySpan<byte>

| Edit this page View Source

GetSemanticNameCharCount()

Gets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public int GetSemanticNameCharCount()

Returns

Type	Description
int	The count.

| Edit this page View Source

GetSemanticNameChars(Span<char>)

Gets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public int GetSemanticNameChars(Span<char> text)

Parameters

Type	Name	Description
Span<char>	text

Returns

Type	Description
int

| Edit this page View Source

NativeReadFrom(nint)

Declaration

public static D3D11InputElementDesc NativeReadFrom(nint buffer)

Parameters

Type	Name	Description
nint	buffer

Returns

Type	Description
D3D11InputElementDesc

| Edit this page View Source

NativeReadFrom(nint, Span<D3D11InputElementDesc>)

Declaration

public static void NativeReadFrom(nint buffer, Span<D3D11InputElementDesc> objects)

Parameters

Type	Name	Description
nint	buffer
Span<D3D11InputElementDesc>	objects

| Edit this page View Source

NativeRequiredSize()

Declaration

public static int NativeRequiredSize()

Returns

Type	Description
int

| Edit this page View Source

NativeRequiredSize(int)

Declaration

public static int NativeRequiredSize(int count)

Parameters

Type	Name	Description
int	count

Returns

Type	Description
int

| Edit this page View Source

NativeWriteTo(nint, in D3D11InputElementDesc)

Declaration

public static void NativeWriteTo(nint buffer, in D3D11InputElementDesc obj)

Parameters

Type	Name	Description
nint	buffer
D3D11InputElementDesc	obj

| Edit this page View Source

NativeWriteTo(nint, ReadOnlySpan<D3D11InputElementDesc>)

Declaration

public static void NativeWriteTo(nint buffer, ReadOnlySpan<D3D11InputElementDesc> objects)

Parameters

Type	Name	Description
nint	buffer
ReadOnlySpan<D3D11InputElementDesc>	objects

| Edit this page View Source

SetSemanticName(ReadOnlySpan<byte>)

Sets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public void SetSemanticName(ReadOnlySpan<byte> value)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	value

| Edit this page View Source

SetSemanticName(ReadOnlySpan<char>)

Sets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public void SetSemanticName(ReadOnlySpan<char> value)

Parameters

Type	Name	Description
ReadOnlySpan<char>	value

| Edit this page View Source

SetSemanticName(string)

Sets the HLSL semantic associated with this element in a shader input-signature.

Declaration

public void SetSemanticName(string value)

Parameters

Type	Name	Description
string	value

Operators

| Edit this page View Source

operator ==(D3D11InputElementDesc, D3D11InputElementDesc)

Declaration

public static bool operator ==(D3D11InputElementDesc left, D3D11InputElementDesc right)

Parameters

Type	Name	Description
D3D11InputElementDesc	left
D3D11InputElementDesc	right

Returns

Type	Description
bool

| Edit this page View Source

operator !=(D3D11InputElementDesc, D3D11InputElementDesc)

Declaration

public static bool operator !=(D3D11InputElementDesc left, D3D11InputElementDesc right)

Parameters

Type	Name	Description
D3D11InputElementDesc	left
D3D11InputElementDesc	right

Returns

Type	Description
bool

Implements

IEquatable<T>