Class Mesh

Represents part of the model that is made of vertices and can be rendered using custom material and transformation.

System.Object
Object
Mesh
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
[Tooltip("Represents part of the model that is made of vertices and can be rendered using custom material and transformation.")]
public class Mesh : Object

Constructors

Mesh()

Initializes a new instance of the Mesh.

Declaration
public Mesh()

Properties

Box

Gets the box.

Declaration
[Unmanaged]
[Tooltip("The box.")]
public BoundingBox Box { get; }
Property Value
BoundingBox

HasLightmapUVs

Determines whether this mesh contains valid lightmap texture coordinates data.

Declaration
[Unmanaged]
[Tooltip("Determines whether this mesh contains valid lightmap texture coordinates data.")]
public bool HasLightmapUVs { get; }
Property Value
System.Boolean

HasVertexColors

Determines whether this mesh has a vertex colors buffer.

Declaration
[Unmanaged]
[Tooltip("Determines whether this mesh has a vertex colors buffer.")]
public bool HasVertexColors { get; }
Property Value
System.Boolean

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

MaterialSlotIndex

Gets or sets the index of the material slot to use during this mesh rendering.

Declaration
[Unmanaged]
[Tooltip("Gets or sets the index of the material slot to use during this mesh rendering.")]
public int MaterialSlotIndex { get; set; }
Property Value
System.Int32

ParentModel

Gets the parent model asset.

Declaration
public Model ParentModel { get; }
Property Value
Model

Sphere

Gets the sphere.

Declaration
[Unmanaged]
[Tooltip("The sphere.")]
public BoundingSphere Sphere { get; }
Property Value
BoundingSphere

TriangleCount

Gets the triangle count.

Declaration
[Unmanaged]
[Tooltip("The triangle count.")]
public int TriangleCount { get; }
Property Value
System.Int32

Use16BitIndexBuffer

Determines whether this mesh is using 16 bit index buffer, otherwise it's 32 bit.

Declaration
[Unmanaged]
[Tooltip("Determines whether this mesh is using 16 bit index buffer, otherwise it's 32 bit.")]
public bool Use16BitIndexBuffer { get; }
Property Value
System.Boolean

VertexCount

Gets the vertex count.

Declaration
[Unmanaged]
[Tooltip("The vertex count.")]
public int VertexCount { get; }
Property Value
System.Int32

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 int[] 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.Int32[]

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 Mesh.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
Mesh.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 Mesh.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
Mesh.Vertex0[]

The gathered data.

DownloadVertexBuffer1(Boolean)

Downloads the second 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 Mesh.Vertex1[] DownloadVertexBuffer1(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
Mesh.Vertex1[]

The gathered data.

DownloadVertexBuffer2(Boolean)

Downloads the third 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 Mesh.Vertex2[] DownloadVertexBuffer2(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
Mesh.Vertex2[]

The gathered data or null if mesh has no vertex colors.
Remarks

If mesh has no vertex colors (stored in vertex buffer 2) the returned value is null.

Draw(ref RenderContext, MaterialBase, ref Matrix, StaticFlags, Boolean, DrawPass, Single)

Draws the mesh.

Declaration
[Unmanaged]
[Tooltip("Draws the mesh.")]
public void Draw(ref RenderContext renderContext, MaterialBase material, ref Matrix world, StaticFlags flags = StaticFlags.None, bool receiveDecals = true, DrawPass drawModes = DrawPass.Depth | DrawPass.GBuffer | DrawPass.Forward | DrawPass.Distortion | DrawPass.MotionVectors | DrawPass.Default | DrawPass.All, float perInstanceRandom = 0F)
Parameters
RenderContext renderContext

The rendering context.
MaterialBase material

The material to use for rendering.
Matrix world

The world transformation of the model.
StaticFlags flags

The object static flags.
System.Boolean receiveDecals

True if rendered geometry can receive decals, otherwise false.
DrawPass drawModes

The draw passes to use for rendering this object.
System.Single perInstanceRandom

The random per-instance value (normalized to range 0-1).

UpdateMesh(Vector3[], Int32[], Vector3[], Vector3[], Vector2[], Color32[])

Updates the 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(Vector3[] vertices, int[] triangles, Vector3[] normals = null, Vector3[] tangents = null, Vector2[] uv = null, Color32[] colors = 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.
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).
Color32[] colors

The vertex colors (per vertex).

UpdateMesh(Vector3[], UInt16[], Vector3[], Vector3[], Vector2[], Color32[])

Updates the 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(Vector3[] vertices, ushort[] triangles, Vector3[] normals = null, Vector3[] tangents = null, Vector2[] uv = null, Color32[] colors = 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.
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).
Color32[] colors

The vertex colors (per vertex).

UpdateMesh(List<Vector3>, List<Int32>, List<Vector3>, List<Vector3>, List<Vector2>, List<Color32>)

Updates the 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(List<Vector3> vertices, List<int> triangles, List<Vector3> normals = null, List<Vector3> tangents = null, List<Vector2> uv = null, List<Color32> colors = null)
Parameters
System.Collections.Generic.List<Vector3> vertices

The mesh vertices positions. Cannot be null.
System.Collections.Generic.List<System.Int32> triangles

The mesh index buffer (clockwise triangles). Uses 32-bit stride buffer. Cannot be null.
System.Collections.Generic.List<Vector3> normals

The normal vectors (per vertex).
System.Collections.Generic.List<Vector3> tangents

The normal vectors (per vertex). Use null to compute them from normal vectors.
System.Collections.Generic.List<Vector2> uv

The texture coordinates (per vertex).
System.Collections.Generic.List<Color32> colors

The vertex colors (per vertex).

UpdateMesh(List<Vector3>, List<UInt16>, List<Vector3>, List<Vector3>, List<Vector2>, List<Color32>)

Updates the 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(List<Vector3> vertices, List<ushort> triangles, List<Vector3> normals = null, List<Vector3> tangents = null, List<Vector2> uv = null, List<Color32> colors = null)
Parameters
System.Collections.Generic.List<Vector3> vertices

The mesh vertices positions. Cannot be null.
System.Collections.Generic.List<System.UInt16> triangles

The mesh index buffer (clockwise triangles). Uses 16-bit stride buffer. Cannot be null.
System.Collections.Generic.List<Vector3> normals

The normal vectors (per vertex).
System.Collections.Generic.List<Vector3> tangents

The tangent vectors (per vertex). Use null to compute them from normal vectors.
System.Collections.Generic.List<Vector2> uv

The texture coordinates (per vertex).
System.Collections.Generic.List<Color32> colors

The vertex colors (per vertex).

UpdateTriangles(List<Int32>)

Updates the model mesh 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 UpdateTriangles(List<int> triangles)
Parameters
System.Collections.Generic.List<System.Int32> triangles

The mesh index buffer (triangles). Uses 32-bit stride buffer. Cannot be null.

UpdateTriangles(List<UInt16>)

Updates the model mesh 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 UpdateTriangles(List<ushort> triangles)
Parameters
System.Collections.Generic.List<System.UInt16> triangles

The mesh index buffer (triangles). Uses 16-bit stride buffer. Cannot be null.

UpdateTriangles(Int32[])

Updates the model mesh 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 UpdateTriangles(int[] triangles)
Parameters
System.Int32[] triangles

The mesh index buffer (triangles). Uses 32-bit stride buffer. Cannot be null.

UpdateTriangles(UInt16[])

Updates the model mesh 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 UpdateTriangles(ushort[] triangles)
Parameters
System.UInt16[] triangles

The mesh index buffer (triangles). Uses 16-bit stride buffer. Cannot be null.

Extension Methods