SiliconStudio.Paradox.Graphics.VertexDeclaration Class Reference

The layout of a vertex buffer with a set of VertexElement. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.VertexDeclaration:

Classes
class	Serializer

Public Member Functions
	VertexDeclaration (params VertexElement[] elements)
	Initializes a new instance of the VertexDeclaration class. More...
	VertexDeclaration (VertexElement[] elements, int instanceCount=0, int vertexStride=0)
	Initializes a new instance of the VertexDeclaration class. More...
IEnumerable < VertexElementWithOffset >	EnumerateWithOffsets ()
	Enumerates VertexElement with declared offsets. More...
int	CalculateSize ()
	Calculate the size of the vertex declaration. More...
bool	Equals (VertexDeclaration other)
override bool	Equals (object obj)
override int	GetHashCode ()

Static Public Member Functions
static implicit	operator VertexDeclaration (VertexElement element)
	Performs an implicit conversion from VertexElement to VertexDeclaration. More...
static implicit	operator VertexDeclaration (VertexElement[] elements)
	Performs an implicit conversion from VertexElement[][] to VertexDeclaration. More...

Properties
VertexElement[]	VertexElements [get]
	Gets the vertex elements. More...
int	InstanceCount [get]
	Gets the instance count. More...
int	VertexStride [get]
	Gets the vertex stride. More...

Detailed Description

The layout of a vertex buffer with a set of VertexElement.

Definition at line 16 of file VertexDeclaration.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Graphics.VertexDeclaration.VertexDeclaration

(

params VertexElement[]

elements

)

Initializes a new instance of the VertexDeclaration class.

Parameters

elements

The elements.

Definition at line 32 of file VertexDeclaration.cs.

SiliconStudio.Paradox.Graphics.VertexDeclaration.VertexDeclaration	(	VertexElement[]	elements,
		int	instanceCount = 0,
		int	vertexStride = 0
	)

Initializes a new instance of the VertexDeclaration class.

Parameters

elements	The elements.
instanceCount	The instance count.
vertexStride	The vertex stride.

Exceptions

System.ArgumentNullException

elements

Definition at line 44 of file VertexDeclaration.cs.

References SiliconStudio.Paradox.Graphics.VertexElement.GetHashCode().

Member Function Documentation

int SiliconStudio.Paradox.Graphics.VertexDeclaration.CalculateSize

(

)

Calculate the size of the vertex declaration.

Returns

The size in bytes of the vertex declaration

Definition at line 122 of file VertexDeclaration.cs.

References SiliconStudio.Paradox.Graphics.VertexElement.AppendAligned, and DirectX.size.

IEnumerable<VertexElementWithOffset> SiliconStudio.Paradox.Graphics.VertexDeclaration.EnumerateWithOffsets

(

)

Enumerates VertexElement with declared offsets.

Returns

A set of VertexElement with offsets.

Definition at line 100 of file VertexDeclaration.cs.

References SiliconStudio.Paradox.Graphics.VertexElement.AppendAligned.

bool SiliconStudio.Paradox.Graphics.VertexDeclaration.Equals

(

VertexDeclaration

other

)

Definition at line 144 of file VertexDeclaration.cs.

override bool SiliconStudio.Paradox.Graphics.VertexDeclaration.Equals

(

object

obj

)

Definition at line 151 of file VertexDeclaration.cs.

override int SiliconStudio.Paradox.Graphics.VertexDeclaration.GetHashCode

(

)

Definition at line 159 of file VertexDeclaration.cs.

static implicit SiliconStudio.Paradox.Graphics.VertexDeclaration.operator VertexDeclaration ( VertexElement  element )

static

Performs an implicit conversion from VertexElement to VertexDeclaration.

Parameters

element

The element.

Returns

The result of the conversion.

Definition at line 169 of file VertexDeclaration.cs.

static implicit SiliconStudio.Paradox.Graphics.VertexDeclaration.operator VertexDeclaration ( VertexElement[]  elements )

static

Performs an implicit conversion from VertexElement[][] to VertexDeclaration.

Parameters

elements

The elements.

Returns

The result of the conversion.

Definition at line 179 of file VertexDeclaration.cs.

Property Documentation

int SiliconStudio.Paradox.Graphics.VertexDeclaration.InstanceCount

get

Gets the instance count.

The instance count.

Definition at line 77 of file VertexDeclaration.cs.

VertexElement [] SiliconStudio.Paradox.Graphics.VertexDeclaration.VertexElements

get

Gets the vertex elements.

The vertex elements.

Definition at line 68 of file VertexDeclaration.cs.

int SiliconStudio.Paradox.Graphics.VertexDeclaration.VertexStride

get

Gets the vertex stride.

The vertex stride.

Definition at line 89 of file VertexDeclaration.cs.

---

The documentation for this class was generated from the following file:

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Graphics/VertexDeclaration.cs