VertexChannelNames

class VertexChannelNames : System.Object

Provides properties for managing a collection of vertex channel names.

public string Binormal(int usageIndex)

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

Parameters:
  • usageIndex (int) – Zero-based index of the vector channel being retrieved.
Returns:

Name of the retrieved vector channel.

public string Color(int usageIndex)

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

Parameters:
  • usageIndex (int) – Zero-based index of the color channel being retrieved.
Returns:

Name of the retrieved color channel.

public string DecodeBaseName(string encodedName)

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

Parameters:
  • encodedName (string) – Encoded string to be decoded.
Returns:

Extracted base name.

public int DecodeUsageIndex(string encodedName)

Gets a channel usage index from the encoded format.

Parameters:
  • encodedName (string) – Encoded name to be decoded.
Returns:

Resulting channel usage index.

public string EncodeName(string baseName, int usageIndex)

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

Parameters:
  • baseName (string) – A channel base name stub.
  • usageIndex (int) – A channel usage index.
Returns:

Resulting encoded name.

public string EncodeName(VertexElementUsage vertexElementUsage, int usageIndex)

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

Parameters:
  • vertexElementUsage (Microsoft.Xna.Framework.Graphics.VertexElementUsage) – A vertex declaration.
  • usageIndex (int) – An index for the vertex declaration.
Returns:

Resulting encoded name.

public string Normal()

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

Returns:Primary normal channel name.
public string Normal(int usageIndex)

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

Parameters:
  • usageIndex (int) – Zero-based index of the normal channel being retrieved.
Returns:

Normal channel at the specified index.

public string Tangent(int usageIndex)

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

Parameters:
  • usageIndex (int) – Zero-based index of the tangent vector channel being retrieved.
Returns:

Name of the retrieved tangent vector channel.

public string TextureCoordinate(int usageIndex)

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

Parameters:
  • usageIndex (int) – Zero-based index of the texture coordinate channel being retrieved.
Returns:

Name of the retrieved texture coordinate channel.

public bool TryDecodeUsage(string encodedName, ref VertexElementUsage usage)
Parameters:
  • encodedName (string) –
  • (ref) usage (Microsoft.Xna.Framework.Graphics.VertexElementUsage) –
public string 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.

Returns:Name of the primary animation weights channel.
public string Weights(int usageIndex)

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.

Parameters:
  • usageIndex (int) – Index of the animation weight channel to be retrieved.
Returns:

Name of the retrieved animation weights channel.