Class VertexChannelNames

Namespace

Microsoft.Xna.Framework.Content.Pipeline.Graphics

Assembly

MonoGame.Framework.Content.Pipeline.dll

Provides properties for managing a collection of vertex channel names.

public static class VertexChannelNames

Inheritance

object

VertexChannelNames

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Binormal(int)

Gets the name of a binormal vector channel with the specified index. This will typically contain Vector3 data.

public static string Binormal(int usageIndex)

Parameters

usageIndex int

Zero-based index of the vector channel being retrieved.

Returns

string

Name of the retrieved vector channel.

Color(int)

Gets the name of a color channel with the specified index. This will typically contain Vector3 data.

public static string Color(int usageIndex)

Parameters

usageIndex int

Zero-based index of the color channel being retrieved.

Returns

string

Name of the retrieved color channel.

DecodeBaseName(string)

Gets a channel base name stub from the encoded string format.

public static string DecodeBaseName(string encodedName)

Parameters

encodedName string

Encoded string to be decoded.

Returns

string

Extracted base name.

DecodeUsageIndex(string)

Gets a channel usage index from the encoded format.

public static int DecodeUsageIndex(string encodedName)

Parameters

encodedName string

Encoded name to be decoded.

Returns

int

Resulting channel usage index.

EncodeName(VertexElementUsage, int)

Combines a vertex declaration usage and usage index into a string name.

public static string EncodeName(VertexElementUsage vertexElementUsage, int usageIndex)

Parameters

vertexElementUsage VertexElementUsage

A vertex declaration.

usageIndex int

An index for the vertex declaration.

Returns

string

Resulting encoded name.

EncodeName(string, int)

Combines a channel name stub and usage index into a string name.

public static string EncodeName(string baseName, int usageIndex)

Parameters

baseName string

A channel base name stub.

usageIndex int

A channel usage index.

Returns

string

Resulting encoded name.

Normal()

Gets the name of the primary normal channel. This will typically contain Vector3 data.

public static string Normal()

Returns

string

Primary normal channel name.

Normal(int)

Gets the name of a normal channel with the specified index. This will typically contain Vector3 data.

public static string Normal(int usageIndex)

Parameters

usageIndex int

Zero-based index of the normal channel being retrieved.

Returns

string

Normal channel at the specified index.

Tangent(int)

Gets the name of a tangent vector channel with the specified index. This will typically contain Vector3 data.

public static string Tangent(int usageIndex)

Parameters

usageIndex int

Zero-based index of the tangent vector channel being retrieved.

Returns

string

Name of the retrieved tangent vector channel.

TextureCoordinate(int)

Gets the name of a texture coordinate channel with the specified index. This will typically contain Vector3 data.

public static string TextureCoordinate(int usageIndex)

Parameters

usageIndex int

Zero-based index of the texture coordinate channel being retrieved.

Returns

string

Name of the retrieved texture coordinate channel.

TryDecodeUsage(string, out VertexElementUsage)

Gets a vertex declaration usage enumeration from the encoded string format.

public static bool TryDecodeUsage(string encodedName, out VertexElementUsage usage)

Parameters

encodedName string

Encoded name of a vertex declaration.

usage VertexElementUsage

Value of the declaration usage for the vertex declaration.

Returns

bool

true if the encoded name maps to a VertexElementUsage enumeration value; false otherwise.

Weights()

Gets the name of the primary animation weights channel. This will typically contain data on the bone weights for a vertex channel. For more information, see BoneWeightCollection.

public static string Weights()

Returns

string

Name of the primary animation weights channel.

Weights(int)

Gets the name of an animation weights channel at the specified index. This will typically contain data on the bone weights for a vertex channel. For more information, see BoneWeightCollection.

public static string Weights(int usageIndex)

Parameters

usageIndex int

Index of the animation weight channel to be retrieved.

Returns

string

Name of the retrieved animation weights channel.