Class SkinnedMesh

Represents part of the skinned model that is made of vertices and can be rendered using custom material, transformation and skeleton bones hierarchy.

System.Object
Object
MeshBase
SkinnedMesh
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public class SkinnedMesh : MeshBase

Constructors

SkinnedMesh()

Initializes a new instance of the SkinnedMesh.

Declaration
public SkinnedMesh()

Properties

IndexBufferFormat

Gets a format of the mesh index buffer.

Declaration
public PixelFormat IndexBufferFormat { get; }
Property Value
PixelFormat

MaterialSlot

Gets the material slot used by this mesh during rendering.

Declaration
public MaterialSlot MaterialSlot { get; }
Property Value
MaterialSlot

ParentSkinnedModel

Gets the parent model asset.

Declaration
public SkinnedModel ParentSkinnedModel { get; }
Property Value
SkinnedModel

Methods

DownloadIndexBuffer(Boolean)

Downloads the index buffer that contains mesh triangles data. To download data from GPU set forceGpu to true and call this method from the thread other than main thread (see IsInMainThread).

Declaration
public uint[] DownloadIndexBuffer(bool forceGpu = false)
Parameters
System.Boolean forceGpu

If set to true the data will be downloaded from the GPU, otherwise it can be loaded from the drive (source asset file) or from memory (if cached). Downloading mesh from GPU requires this call to be made from the other thread than main thread. Virtual assets are always downloaded from GPU memory due to lack of dedicated storage container for the asset data.
Returns
System.UInt32[]

The gathered data.
Remarks

If mesh index buffer format (see IndexBufferFormat) is R16_UInt then it's faster to call .

DownloadIndexBufferUShort(Boolean)

Downloads the index buffer that contains mesh triangles data. To download data from GPU set forceGpu to true and call this method from the thread other than main thread (see IsInMainThread).

Declaration
public ushort[] DownloadIndexBufferUShort(bool forceGpu = false)
Parameters
System.Boolean forceGpu

If set to true the data will be downloaded from the GPU, otherwise it can be loaded from the drive (source asset file) or from memory (if cached). Downloading mesh from GPU requires this call to be made from the other thread than main thread. Virtual assets are always downloaded from GPU memory due to lack of dedicated storage container for the asset data.
Returns
System.UInt16[]

The gathered data.
Remarks

If mesh index buffer format (see IndexBufferFormat) is R32_UInt then data won't be downloaded.

DownloadVertexBuffer(Boolean)

Downloads the raw vertex buffer that contains mesh vertices data. To download data from GPU set forceGpu to true and call this method from the thread other than main thread (see IsInMainThread).

Declaration
public SkinnedMesh.Vertex[] DownloadVertexBuffer(bool forceGpu = false)
Parameters
System.Boolean forceGpu

If set to true the data will be downloaded from the GPU, otherwise it can be loaded from the drive (source asset file) or from memory (if cached). Downloading mesh from GPU requires this call to be made from the other thread than main thread. Virtual assets are always downloaded from GPU memory due to lack of dedicated storage container for the asset data.
Returns
SkinnedMesh.Vertex[]

The gathered data.

DownloadVertexBuffer0(Boolean)

Downloads the first vertex buffer that contains mesh vertices data. To download data from GPU set forceGpu to true and call this method from the thread other than main thread (see IsInMainThread).

Declaration
public SkinnedMesh.Vertex0[] DownloadVertexBuffer0(bool forceGpu = false)
Parameters
System.Boolean forceGpu

If set to true the data will be downloaded from the GPU, otherwise it can be loaded from the drive (source asset file) or from memory (if cached). Downloading mesh from GPU requires this call to be made from the other thread than main thread. Virtual assets are always downloaded from GPU memory due to lack of dedicated storage container for the asset data.
Returns
SkinnedMesh.Vertex0[]

The gathered data.

UpdateMesh(Float3[], Int32[], Int4[], Float4[], Float3[], Float3[], Float2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay.

Declaration
public void UpdateMesh(Float3[] vertices, int[] triangles, Int4[] blendIndices, Float4[] blendWeights, Float3[] normals = null, Float3[] tangents = null, Float2[] uv = null)
Parameters
Float3[] vertices

The mesh vertices positions. Cannot be null.
System.Int32[] triangles

The mesh index buffer (clockwise triangles). Uses 32-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Float4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Float3[] normals

The normal vectors (per vertex).
Float3[] tangents

The normal vectors (per vertex). Use null to compute them from normal vectors.
Float2[] uv

The texture coordinates (per vertex).

UpdateMesh(Float3[], UInt16[], Int4[], Float4[], Float3[], Float3[], Float2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay.

Declaration
public void UpdateMesh(Float3[] vertices, ushort[] triangles, Int4[] blendIndices, Float4[] blendWeights, Float3[] normals = null, Float3[] tangents = null, Float2[] uv = null)
Parameters
Float3[] vertices

The mesh vertices positions. Cannot be null.
System.UInt16[] triangles

The mesh index buffer (clockwise triangles). Uses 16-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Float4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Float3[] normals

The normal vectors (per vertex).
Float3[] tangents

The tangent vectors (per vertex). Use null to compute them from normal vectors.
Float2[] uv

The texture coordinates (per vertex).

UpdateMesh(Float3[], UInt32[], Int4[], Float4[], Float3[], Float3[], Float2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay.

Declaration
public void UpdateMesh(Float3[] vertices, uint[] triangles, Int4[] blendIndices, Float4[] blendWeights, Float3[] normals = null, Float3[] tangents = null, Float2[] uv = null)
Parameters
Float3[] vertices

The mesh vertices positions. Cannot be null.
System.UInt32[] triangles

The mesh index buffer (clockwise triangles). Uses 32-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Float4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Float3[] normals

The normal vectors (per vertex).
Float3[] tangents

The normal vectors (per vertex). Use null to compute them from normal vectors.
Float2[] uv

The texture coordinates (per vertex).

UpdateMesh(Vector3[], Int32[], Int4[], Vector4[], Vector3[], Vector3[], Vector2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay. [Deprecated on 26.05.2022, expires on 26.05.2024]

Declaration
public void UpdateMesh(Vector3[] vertices, int[] triangles, Int4[] blendIndices, Vector4[] blendWeights, Vector3[] normals = null, Vector3[] tangents = null, Vector2[] uv = null)
Parameters
Vector3[] vertices

The mesh vertices positions. Cannot be null.
System.Int32[] triangles

The mesh index buffer (clockwise triangles). Uses 32-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Vector4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Vector3[] normals

The normal vectors (per vertex).
Vector3[] tangents

The normal vectors (per vertex). Use null to compute them from normal vectors.
Vector2[] uv

The texture coordinates (per vertex).

UpdateMesh(Vector3[], UInt16[], Int4[], Vector4[], Vector3[], Vector3[], Vector2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay. [Deprecated on 26.05.2022, expires on 26.05.2024]

Declaration
public void UpdateMesh(Vector3[] vertices, ushort[] triangles, Int4[] blendIndices, Vector4[] blendWeights, Vector3[] normals = null, Vector3[] tangents = null, Vector2[] uv = null)
Parameters
Vector3[] vertices

The mesh vertices positions. Cannot be null.
System.UInt16[] triangles

The mesh index buffer (clockwise triangles). Uses 16-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Vector4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Vector3[] normals

The normal vectors (per vertex).
Vector3[] tangents

The tangent vectors (per vertex). Use null to compute them from normal vectors.
Vector2[] uv

The texture coordinates (per vertex).

UpdateMesh(Vector3[], UInt32[], Int4[], Vector4[], Vector3[], Vector3[], Vector2[])

Updates the skinned model mesh vertex and index buffer data. Can be used only for virtual assets (see IsVirtual and CreateVirtualAsset<T>()). Mesh data will be cached and uploaded to the GPU with a delay. [Deprecated on 26.05.2022, expires on 26.05.2024]

Declaration
public void UpdateMesh(Vector3[] vertices, uint[] triangles, Int4[] blendIndices, Vector4[] blendWeights, Vector3[] normals = null, Vector3[] tangents = null, Vector2[] uv = null)
Parameters
Vector3[] vertices

The mesh vertices positions. Cannot be null.
System.UInt32[] triangles

The mesh index buffer (clockwise triangles). Uses 32-bit stride buffer. Cannot be null.
Int4[] blendIndices

The skinned mesh blend indices buffer. Contains indices of the skeleton bones (up to 4 bones per vertex) to use for vertex position blending. Cannot be null.
Vector4[] blendWeights

The skinned mesh blend weights buffer (normalized). Contains weights per blend bone (up to 4 bones per vertex) of the skeleton bones to mix for vertex position blending. Cannot be null.
Vector3[] normals

The normal vectors (per vertex).
Vector3[] tangents

The normal vectors (per vertex). Use null to compute them from normal vectors.
Vector2[] uv

The texture coordinates (per vertex).

Extension Methods