Struct RenderMesh
Defines the mesh and rendering properties of an entity.
Namespace: Unity.Rendering
Syntax
[Serializable]
[MaximumChunkCapacity(128)]
[TemporaryBakingType]
public struct RenderMesh : ISharedComponentData, IQueryTypeParameter, IEquatable<RenderMesh>Remarks
Add a RenderMesh component to an entity to define its graphical attributes. For Entities Graphics to render the entity, the entity must also have a LocalToWorld component from the Unity.Transforms namespace.
The standard ECS conversion systems add RenderMesh components to entities created from GameObjects that contain UnityEngine.MeshRenderer and UnityEngine.MeshFilter components.
RenderMesh is a shared component, which means all entities of the same Archetype and same RenderMesh settings are stored together in the same chunks of memory. The rendering system batches the entities together to reduce the number of draw calls.
Constructors
RenderMesh(Renderer, Mesh, List<Material>, Int32)
Constructs a RenderMesh using the given Renderer, Mesh, optional list of shared Materials, and option sub-mesh index.
Declaration
public RenderMesh(Renderer renderer, Mesh mesh, List<Material> sharedMaterials = null, int subMeshIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Renderer | renderer | The Renderer to use. |
| Mesh | mesh | The Mesh to use. |
| List<Material> | sharedMaterials | An optional list of Materials to use. |
| Int32 | subMeshIndex | An options sub-mesh index that represents a sub-mesh in the mesh parameter. |
Fields
material
A reference to a UnityEngine.Material object.
Declaration
public Material materialField Value
| Type | Description |
|---|---|
| Material |
Remarks
For efficient rendering, the material should enable GPU instancing. For entities converted from GameObjects, this value is derived from the Materials array of the source Mesh Renderer Component.
mesh
A reference to a UnityEngine.Mesh object.
Declaration
public Mesh meshField Value
| Type | Description |
|---|---|
| Mesh |
subMesh
The submesh index.
Declaration
public int subMeshField Value
| Type | Description |
|---|---|
| Int32 |
Methods
Equals(RenderMesh)
Two RenderMesh objects are equal if their respective property values are equal.
Declaration
public bool Equals(RenderMesh other)Parameters
| Type | Name | Description |
|---|---|---|
| RenderMesh | other | Another RenderMesh. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if the properties of both RenderMeshes are equal. |
GetHashCode()
A representative hash code.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | A number that is guaranteed to be the same when generated from two objects that are the same. |