Microsoft.Xna.Framework.Graphics

Class VertexElement

java.lang.Object

System.ValueType

Microsoft.Xna.Framework.Graphics.VertexElement

public final class VertexElement
extends ValueType

Defines input vertex data to the pipeline.

Author:

Halofreak1990

Constructor Summary

Constructors

Constructor and Description
VertexElement(int offset, VertexElementFormat elementFormat, VertexElementUsage elementUsage, int usageIndex) Initializes a new instance of the VertexElement class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns a value that indicates whether the current instance is equal to a specified object.
int	getOffset() Retrieves the offset (if any) from the beginning of the stream to the beginning of the vertex data.
int	getUsageIndex() Modifies the usage data to allow the user to specify multiple usage types.
VertexElementFormat	getVertexElementFormat() Gets the format of this vertex element.
VertexElementUsage	getVertexElementUsage() Gets a value describing how the vertex element is to be used.
int	hashCode()
void	setOffset(int value) Sets the offset (if any) from the beginning of the stream to the beginning of the vertex data.
void	setUsageIndex(int value) Modifies the usage data to allow the user to specify multiple usage types.
void	setVertexElementFormat(VertexElementFormat value) Sets the format of this vertex element.
void	setVertexElementUsage(VertexElementUsage value) Sets a value describing how the vertex element is to be used.
java.lang.String	toString() Retrieves a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VertexElement

public VertexElement(int offset,
             VertexElementFormat elementFormat,
             VertexElementUsage elementUsage,
             int usageIndex)

Initializes a new instance of the VertexElement class.

Parameters:

offset - Offset (if any) from the beginning of the stream to the beginning of the vertex data.

elementFormat - One of several predefined types that define the vertex data size.

elementUsage - The intended use of the vertex data.

usageIndex - Modifies the usage data to allow the user to specify multiple usage types.

Method Detail

getOffset

public int getOffset()

Retrieves the offset (if any) from the beginning of the stream to the beginning of the vertex data.

setOffset

public void setOffset(int value)

Sets the offset (if any) from the beginning of the stream to the beginning of the vertex data.

getUsageIndex

public int getUsageIndex()

Modifies the usage data to allow the user to specify multiple usage types.

setUsageIndex

public void setUsageIndex(int value)

Modifies the usage data to allow the user to specify multiple usage types.

getVertexElementFormat

public VertexElementFormat getVertexElementFormat()

Gets the format of this vertex element.

setVertexElementFormat

public void setVertexElementFormat(VertexElementFormat value)

Sets the format of this vertex element.

getVertexElementUsage

public VertexElementUsage getVertexElementUsage()

Gets a value describing how the vertex element is to be used.

setVertexElementUsage

public void setVertexElementUsage(VertexElementUsage value)

Sets a value describing how the vertex element is to be used.

equals

public boolean equals(java.lang.Object obj)

Returns a value that indicates whether the current instance is equal to a specified object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The Object to compare with the current VertexElement.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Retrieves a string representation of this object.

Overrides:

toString in class java.lang.Object