Entities Graphics

https://docs.unity3d.com/Packages/com.unity.entities.graphics@1.4/
Admin
Entities Graphics provides systems and components for rendering ECS entities by collecting rendering...
Tokens:51,257
Snippets:808
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### RenderMeshDescription

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Represents how to setup and configure Entities Graphics entities.

```APIDOC
## Struct RenderMeshDescription

### Description
Represents how to setup and configure Entities Graphics entities.

### Type
Struct
```

--------------------------------

### Begin Upload Frame

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Starts a new upload frame, returning a ThreadedSparseUploader. This uploader is valid until the next call to EndAndCommit. Specify maximum data size, largest upload size, and maximum operation count for the frame.

```csharp
public ThreadedSparseUploader Begin(int maxDataSizeInBytes, int biggestDataUpload, int maxOperationCount)
```

--------------------------------

### HeapBlock.begin Property

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapBlock.html

Gets the starting memory address of the allocated block. This is a raw offset within the managed heap.

```csharp
public ulong begin { get; }
```

--------------------------------

### EntitiesGraphicsStatsDrawer Component Setup

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/manual/entities-graphics-performance.html

Attach this component to a new GameObject to enable the on-screen GUI for Culling and Rendering stats in the GameView. This component is Editor only.

```csharp
using Unity.Entities.Graphics;

// ...

// Create a new GameObject and attach the EntitiesGraphicsStatsDrawer component.
// Example:
// GameObject statsDrawer = new GameObject("EntitiesGraphicsStatsDrawer");
// statsDrawer.AddComponent<EntitiesGraphicsStatsDrawer>();
```

--------------------------------

### MaterialColor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

An unmanaged component that acts as an example material override for setting the RGBA color of an entity.

```APIDOC
## Struct MaterialColor

### Description
An unmanaged component that acts as an example material override for setting the RGBA color of an entity.

### Type
Struct
```

--------------------------------

### Construct RenderMeshDescription with Custom Values

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshDescription.html

Initializes a new instance by explicitly specifying rendering parameters.

```csharp
public RenderMeshDescription(ShadowCastingMode shadowCastingMode, bool receiveShadows = false, MotionVectorGenerationMode motionVectorGenerationMode = MotionVectorGenerationMode.Camera, int layer = 0, uint renderingLayerMask = 4294967295, LightProbeUsage lightProbeUsage = LightProbeUsage.Off, bool staticShadowCaster = false)
```

--------------------------------

### Construct RenderMeshDescription from Renderer

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshDescription.html

Initializes a new instance using default settings derived from an existing Renderer object.

```csharp
public RenderMeshDescription(Renderer renderer)
```

--------------------------------

### SparseUploader.Begin

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Begins a new upload frame and returns a new ThreadedSparseUploader that is valid until the next call to SparseUploader.EndAndCommit.

```APIDOC
## Begin(int, int, int)

### Description
Begins a new upload frame and returns a new ThreadedSparseUploader that is valid until the next call to SparseUploader.EndAndCommit.

### Parameters
- **maxDataSizeInBytes** (int) - An upper bound of total data size that you want to upload this frame.
- **biggestDataUpload** (int) - The size of the largest upload operation that will occur.
- **maxOperationCount** (int) - An upper bound of the total number of upload operations that will occur this frame.

### Returns
- **ThreadedSparseUploader** - Returns a new ThreadedSparseUploader that must be passed to SparseUploader.EndAndCommit later.

### Remarks
You must follow this method with a call to SparseUploader.EndAndCommit later in the frame. You must also pass the returned value from a Begin method to the next SparseUploader.EndAndCommit.
```

--------------------------------

### HeapBlock.end Property

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapBlock.html

Gets the ending memory address of the allocated block. This marks the boundary of the usable memory within the HeapBlock.

```csharp
public ulong end { get; }
```

--------------------------------

### Create and Instantiate Entities at Runtime

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/manual/runtime-entity-creation.html

Uses RenderMeshUtility.AddComponents to prepare a prototype entity, which is then cloned in parallel using an EntityCommandBuffer within a Burst job.

```csharp
using Unity.Collections;
using Unity.Entities;
using Unity.Jobs;
using Unity.Mathematics;
using Unity.Rendering;
using Unity.Transforms;
using UnityEngine;
using UnityEngine.Rendering;

public class AddComponentsExample : MonoBehaviour
{
    public Mesh Mesh;
    public Material Material;
    public int EntityCount;

    // Example Burst job that creates many entities
    [GenerateTestsForBurstCompatibility]
    public struct SpawnJob : IJobParallelFor
    {
        public Entity Prototype;
        public int EntityCount;
        public EntityCommandBuffer.ParallelWriter Ecb;

        public void Execute(int index)
        {
            // Clone the Prototype entity to create a new entity.
            var e = Ecb.Instantiate(index, Prototype);
            // Prototype has all correct components up front, can use SetComponent to
            // set values unique to the newly created entity, such as the transform.
            Ecb.SetComponent(index, e, new LocalToWorld {Value = ComputeTransform(index)});
        }

        public float4x4 ComputeTransform(int index)
        {
            return float4x4.Translate(new float3(index, 0, 0));
        }
    }

    void Start()
    {
        var world = World.DefaultGameObjectInjectionWorld;
        var entityManager = world.EntityManager;

        EntityCommandBuffer ecb = new EntityCommandBuffer(Allocator.TempJob);

        // Create a RenderMeshDescription using the convenience constructor
        // with named parameters.
        var desc = new RenderMeshDescription(
            shadowCastingMode: ShadowCastingMode.Off,
            receiveShadows: false);

        // Create an array of mesh and material required for runtime rendering.
        var renderMeshArray = new RenderMeshArray(new Material[] { Material }, new Mesh[] { Mesh });

        // Create empty base entity
        var prototype = entityManager.CreateEntity();

        // Call AddComponents to populate base entity with the components required
        // by Entities Graphics
        RenderMeshUtility.AddComponents(
            prototype,
            entityManager,
            desc,
            renderMeshArray,
            MaterialMeshInfo.FromRenderMeshArrayIndices(0, 0));
        entityManager.AddComponentData(prototype, new LocalToWorld());

        // Spawn most of the entities in a Burst job by cloning a pre-created prototype entity,
        // which can be either a Prefab or an entity created at run time like in this sample.
        // This is the fastest and most efficient way to create entities at run time.
        var spawnJob = new SpawnJob
        {
            Prototype = prototype,
            Ecb = ecb.AsParallelWriter(),
            EntityCount = EntityCount,
        };

        var spawnHandle = spawnJob.Schedule(EntityCount, 128);
        spawnHandle.Complete();

        ecb.Playback(entityManager);
        ecb.Dispose();
        entityManager.DestroyEntity(prototype);
    }
}
```

--------------------------------

### MaterialMeshInfo Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Creates an instance using IDs registered with the EntitiesGraphicsSystem.

```csharp
public MaterialMeshInfo(BatchMaterialID materialID, BatchMeshID meshID, ushort submeshIndex = 0)
```

--------------------------------

### ConstructLightMaps Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.LightMaps.html

A static method to create a new LightMaps instance by combining lists of Texture2D objects for colors, directions, and shadow masks.

```csharp
public static LightMaps ConstructLightMaps(List<Texture2D> inColors, List<Texture2D> inDirections, List<Texture2D> inShadowMasks)
```

--------------------------------

### RenderMeshDescription(Renderer)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshDescription.html

Constructs a new RenderMeshDescription instance using default settings derived from a provided Renderer object.

```APIDOC
## RenderMeshDescription(Renderer renderer)

### Description
Constructs a RenderMeshDescription using default values extracted from the specified Renderer object (e.g., a MeshRenderer).

### Parameters
- **renderer** (Renderer) - Required - The renderer object to extract default settings from.
```

--------------------------------

### HeapAllocator(ulong, uint)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Constructor to create a new HeapAllocator instance with a specified initial size and alignment.

```APIDOC
## HeapAllocator(ulong size, uint minimumAlignment)

### Description
Creates a new HeapAllocator with the given initial size and alignment. The allocator can be resized later.

### Parameters
- **size** (ulong) - The initial size of the allocator.
- **minimumAlignment** (uint) - The initial alignment of the allocator.
```

--------------------------------

### Equals Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.LightMaps.html

Compares this LightMaps instance with another for equality.

```csharp
public bool Equals(LightMaps other)
```

--------------------------------

### ConstructLightMaps

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.LightMaps.html

Constructs a LightMaps instance from lists of color, direction, and shadow mask textures.

```APIDOC
## ConstructLightMaps

### Description
Constructs a LightMaps instance from a list of textures for colors, direction lights, and shadow masks.

### Method
`public static LightMaps ConstructLightMaps(List<Texture2D> inColors, List<Texture2D> inDirections, List<Texture2D> inShadowMasks)`

### Parameters
#### Path Parameters
- **inColors** (List<Texture2D>) - Required - The list of Texture2D for colors.
- **inDirections** (List<Texture2D>) - Required - The list of Texture2D for direction lights.
- **inShadowMasks** (List<Texture2D>) - Required - The list of Texture2D for shadow masks.

### Returns
#### Success Response
- **LightMaps** - Returns a new LightMaps object.
```

--------------------------------

### Factory Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Static methods to create MaterialMeshInfo instances from RenderMeshArray indices or ranges.

```APIDOC
## FromRenderMeshArrayIndices(int materialIndexInRenderMeshArray, int meshIndexInRenderMeshArray, ushort submeshIndex)
Creates an instance from material and mesh indices in a RenderMeshArray.

## FromMaterialMeshIndexRange(int rangeStart, int rangeLength)
Creates an instance from a range of indices in the corresponding RenderMeshArray.
```

--------------------------------

### RenderFilterSettings Equals(RenderFilterSettings) Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Entities.Graphics.RenderFilterSettings.html

Compares the current RenderFilterSettings instance with another RenderFilterSettings instance for equality.

```csharp
public bool Equals(RenderFilterSettings other);
```

--------------------------------

### MaterialPropertyAttribute Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialPropertyAttribute.html

Initializes a new instance of the attribute with a property name and optional GPU size.

```csharp
public MaterialPropertyAttribute(string materialPropertyName, short overrideSizeGPU = -1)
```

--------------------------------

### MaterialMeshInfo Static Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Utility methods for converting between array indices and static indices, or creating instances from RenderMeshArray data.

```csharp
public static int ArrayIndexToStaticIndex(int index)
```

```csharp
public static MaterialMeshInfo FromMaterialMeshIndexRange(int rangeStart, int rangeLength)
```

```csharp
public static MaterialMeshInfo FromRenderMeshArrayIndices(int materialIndexInRenderMeshArray, int meshIndexInRenderMeshArray, ushort submeshIndex = 0)
```

```csharp
public static int StaticIndexToArrayIndex(int staticIndex)
```

--------------------------------

### MaterialMeshInfo Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Creates an instance of MaterialMeshInfo using material and mesh IDs registered with the EntitiesGraphicsSystem.

```APIDOC
## MaterialMeshInfo(BatchMaterialID materialID, BatchMeshID meshID, ushort submeshIndex)

### Description
Creates an instance of MaterialMeshInfo from material and mesh/sub-mesh IDs registered with EntitiesGraphicsSystem.

### Parameters
- **materialID** (BatchMaterialID) - The material ID from RegisterMaterial(Material).
- **meshID** (BatchMeshID) - The mesh ID from RegisterMesh(Mesh).
- **submeshIndex** (ushort) - An optional submesh ID (default: 0).
```

--------------------------------

### Populate Frustum Planes from Camera

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.FrustumPlanes.html

Use this static method to calculate and populate a NativeArray with the 6 frustum planes based on a given Camera. Ensure the NativeArray is initialized with a size of 6.

```csharp
public static void FromCamera(Camera camera, NativeArray<float4> planes)
```

--------------------------------

### RenderMeshDescription(ShadowCastingMode, bool, MotionVectorGenerationMode, int, uint, LightProbeUsage, bool)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshDescription.html

Constructs a new RenderMeshDescription instance using explicitly provided rendering configuration values.

```APIDOC
## RenderMeshDescription(ShadowCastingMode shadowCastingMode, bool receiveShadows, MotionVectorGenerationMode motionVectorGenerationMode, int layer, uint renderingLayerMask, LightProbeUsage lightProbeUsage, bool staticShadowCaster)

### Description
Constructs a RenderMeshDescription with specific rendering settings.

### Parameters
- **shadowCastingMode** (ShadowCastingMode) - Required - Mode for shadow casting.
- **receiveShadows** (bool) - Optional - Mode for shadow receival (default: false).
- **motionVectorGenerationMode** (MotionVectorGenerationMode) - Optional - Mode for motion vectors generation (default: MotionVectorGenerationMode.Camera).
- **layer** (int) - Optional - Rendering layer (default: 0).
- **renderingLayerMask** (uint) - Optional - Rendering layer mask (default: 4294967295).
- **lightProbeUsage** (LightProbeUsage) - Optional - Light probe usage mode (default: LightProbeUsage.Off).
- **staticShadowCaster** (bool) - Optional - Static shadow caster flag (default: false).
```

--------------------------------

### Animate Material Property with Burst System

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/manual/material-overrides-code.html

Implement a SystemBase to update the IComponentData values, which are then synchronized with the material properties.

```csharp
class AnimateMyOwnColorSystem : SystemBase
{
   protected override void OnUpdate()
  {
       Entities.ForEach((ref MyOwnColor color, in MyAnimationTime t) =>
          {
               color.Value = new float4(
                   math.cos(t.Value + 1.0f),
                   math.cos(t.Value + 2.0f),
                   math.cos(t.Value + 3.0f),
                   1.0f);
          })
          .Schedule();
  }
}
```

--------------------------------

### Construct SparseUploader

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Constructs a new sparse uploader targeting a specific GraphicsBuffer. Optionally set the upload buffer chunk size.

```csharp
public SparseUploader(GraphicsBuffer destinationBuffer, int bufferChunkSize = 16777216)
```

--------------------------------

### SparseUploader

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Provides utility methods that you can use to upload data into GPU memory.

```APIDOC
## Struct SparseUploader

### Description
Provides utility methods that you can use to upload data into GPU memory.

### Type
Struct
```

--------------------------------

### SparseUploader Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Constructs a new sparse uploader with the specified buffer as the target.

```APIDOC
## SparseUploader(GraphicsBuffer, int)

### Description
Constructs a new sparse uploader with the specified buffer as the target.

### Parameters
- **destinationBuffer** (GraphicsBuffer) - The target buffer to write uploads into.
- **bufferChunkSize** (int) - The upload buffer chunk size. Defaults to 16777216.
```

--------------------------------

### Allocate(ulong, uint)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Attempts to allocate a block from the heap with at least the given size and alignment.

```APIDOC
### HeapBlock Allocate(ulong size, uint alignment = 1)

#### Description
Attempts to allocate a block from the heap with at least the given size and alignment. The allocated block might be bigger than the requested size, but will never be smaller. If the allocation fails, this method returns an empty block.

#### Parameters
- **size** (ulong) - The size of the block to allocate.
- **alignment** (uint) - Alignment of the allocated block (default: 1).

#### Returns
- **HeapBlock** - Returns a new allocated HeapBlock on success, or an empty block on failure.
```

--------------------------------

### HeapAllocator Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Initializes a new instance of the HeapAllocator with a specified size and alignment.

```csharp
public HeapAllocator(ulong size = 0, uint minimumAlignment = 1)
```

--------------------------------

### MaterialMeshInfo

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Represents which materials and meshes to use to render an entity.

```APIDOC
## Struct MaterialMeshInfo

### Description
Represents which materials and meshes to use to render an entity.

### Type
Struct
```

--------------------------------

### AddComponents(Entity, EntityManager, RenderMeshDescription, MaterialMeshInfo)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUtility.html

Sets the Entities Graphics component values to render the given entity using the provided description. Adds any missing components, which results in structural changes.

```APIDOC
## AddComponents(Entity, EntityManager, RenderMeshDescription, MaterialMeshInfo)

### Description
Sets the Entities Graphics component values to render the given entity using the given description. Any missing components will be added, which results in structural changes.

### Parameters
#### Path Parameters
- **entity** (Entity) - Description: The entity to set the component values for.
- **entityManager** (EntityManager) - Description: The Unity.Entities.EntityManager used to set the component values.
- **renderMeshDescription** (in RenderMeshDescription) - Description: The description that determines how the entity is to be rendered.
- **materialMeshInfo** (MaterialMeshInfo) - Description: The MaterialMeshInfo containing the mesh and material ids
```

--------------------------------

### AddComponents(Entity, EntityManager, RenderMeshDescription, RenderMeshArray, MaterialMeshInfo)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUtility.html

Sets the Entities Graphics component values to render the given entity using the provided description. Adds any missing components, which results in structural changes.

```APIDOC
## AddComponents(Entity, EntityManager, RenderMeshDescription, RenderMeshArray, MaterialMeshInfo)

### Description
Sets the Entities Graphics component values to render the given entity using the given description. Any missing components will be added, which results in structural changes.

### Parameters
#### Path Parameters
- **entity** (Entity) - Description: The entity to set the component values for.
- **entityManager** (EntityManager) - Description: The Unity.Entities.EntityManager used to set the component values.
- **renderMeshDescription** (in RenderMeshDescription) - Description: The description that determines how the entity is to be rendered.
- **renderMeshArray** (RenderMeshArray) - Description: The instance of the RenderMeshArray which contains mesh and material.
- **materialMeshInfo** (MaterialMeshInfo) - Default: default - Description: The MaterialMeshInfo used to index into renderMeshArray.
```

--------------------------------

### ThreadedSparseUploader

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

An unmanaged and Burst-compatible interface for SparseUploader.

```APIDOC
## Struct ThreadedSparseUploader

### Description
An unmanaged and Burst-compatible interface for SparseUploader.

### Type
Struct
```

--------------------------------

### ThreadedSparseUploader Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.ThreadedSparseUploader.html

Defines the structure for ThreadedSparseUploader, an unmanaged and Burst-compatible interface for SparseUploader.

```csharp
public struct ThreadedSparseUploader
```

--------------------------------

### RenderBounds Syntax Declaration

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderBounds.html

The structure definition for RenderBounds, implementing IComponentData and IQueryTypeParameter.

```csharp
public struct RenderBounds : IComponentData, IQueryTypeParameter
```

--------------------------------

### AddComponents with RenderMeshDescription and MaterialMeshInfo

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUtility.html

Use this method to set the Entities Graphics component values for an entity. It adds any missing components, which may result in structural changes.

```csharp
public static void AddComponents(Entity entity, EntityManager entityManager, in RenderMeshDescription renderMeshDescription, MaterialMeshInfo materialMeshInfo)

```

--------------------------------

### HeapBlock Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapBlock.html

Provides methods for comparing HeapBlocks and checking for equality.

```APIDOC
### Methods 
#### CompareTo(HeapBlock)
##### Declaration
```
public int CompareTo(HeapBlock other)
```

##### Parameters
Type | Name | Description  
---|---|---  
HeapBlock | other |

##### Returns
Type | Description  
---|---  
int |

#### Equals(HeapBlock)
##### Declaration
```
public bool Equals(HeapBlock other)
```

##### Parameters
Type | Name | Description  
---|---|---  
HeapBlock | other |

##### Returns
Type | Description  
---|---  
bool |
```

--------------------------------

### MaterialPropertyAttribute Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialPropertyAttribute.html

Defines the attribute usage for structs to map them to shader properties.

```csharp
[AttributeUsage(AttributeTargets.Struct, AllowMultiple = true)]
public class MaterialPropertyAttribute : Attribute
```

--------------------------------

### Properties

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialPropertyAttribute.html

Accessors for the material property configuration.

```APIDOC
## Properties

### Name
- **Type**: string
- **Description**: Gets the name of the material property.

### OverrideSizeGPU
- **Type**: short
- **Description**: Gets the size of the property in bytes on the GPU.
```

--------------------------------

### RenderFilterSettings Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Entities.Graphics.RenderFilterSettings.html

Methods for comparing RenderFilterSettings instances and calculating hash codes.

```APIDOC
## Struct RenderFilterSettings

### Methods
#### Equals(object)
Indicates whether the current instance is equal to the specified object.
```csharp
public override bool Equals(object obj)
```
#### Equals(RenderFilterSettings)
Indicates whether the current instance is equal to the specified RenderFilterSettings.
```csharp
public bool Equals(RenderFilterSettings other)
```
#### GetHashCode()
Calculates the hash code for this object.
```csharp
public override int GetHashCode()
```
```

--------------------------------

### HeapAllocator Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

The basic structure definition for the HeapAllocator.

```csharp
public struct HeapAllocator
```

--------------------------------

### RenderMeshUtility

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Helper class that contains static methods for populating entities so that they are compatible with the Entities Graphics package.

```APIDOC
## Class RenderMeshUtility

### Description
Helper class that contains static methods for populating entities so that they are compatible with the Entities Graphics package.

### Type
Class
```

--------------------------------

### RenderFilterSettings GetHashCode() Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Entities.Graphics.RenderFilterSettings.html

Calculates and returns the hash code for the current RenderFilterSettings instance.

```csharp
public override int GetHashCode();
```

--------------------------------

### SparseUploader.ReplaceBuffer

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Replaces the destination GPU buffer with a new one.

```APIDOC
## ReplaceBuffer(GraphicsBuffer, bool)

### Description
Replaces the destination GPU buffer with a new one.

### Parameters
- **buffer** (GraphicsBuffer) - The new buffer to replace the old one with.
- **copyFromPrevious** (bool) - Indicates whether to copy the contents of the old buffer to the new buffer. Defaults to false.
```

--------------------------------

### RegisterMaterial Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.EntitiesGraphicsSystem.html

Registers a material instance and returns a BatchMaterialID for use in the system.

```csharp
public BatchMaterialID RegisterMaterial(Material material)
```

--------------------------------

### HybridLightBakingDataSystem

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Represents a light baking system that assigns a LightBakingOutput to the bakingOutput of the Light component.

```APIDOC
## Class HybridLightBakingDataSystem

### Description
Represents a light baking system that assigns a LightBakingOutput to the bakingOutput of the Light component.

### Type
Class
```

--------------------------------

### Resize(ulong)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Attempts to grow or shrink the allocator.

```APIDOC
### bool Resize(ulong newSize)

#### Description
Attempts to grow or shrink the allocator. Growing always succeeds, but shrinking might fail if the end of the heap is allocated.

#### Parameters
- **newSize** (ulong) - The new size of the allocator.

#### Returns
- **bool** - Returns true if the operation is a success, false otherwise.
```

--------------------------------

### AddComponents with RenderMeshDescription, RenderMeshArray, and MaterialMeshInfo

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUtility.html

This overload allows setting Entities Graphics component values using a RenderMeshArray for mesh and material information. It also adds any missing components, potentially causing structural changes.

```csharp
public static void AddComponents(Entity entity, EntityManager entityManager, in RenderMeshDescription renderMeshDescription, RenderMeshArray renderMeshArray, MaterialMeshInfo materialMeshInfo = default)

```

--------------------------------

### RenderMeshDescription Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshDescription.html

The basic structure definition for RenderMeshDescription.

```csharp
public struct RenderMeshDescription
```

--------------------------------

### Bake Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.OverrideLightProbeAnchorBaker.html

Defines the signature for the Bake method used to process MeshRenderer components during baking.

```csharp
public override void Bake(MeshRenderer authoring)
```

--------------------------------

### SparseUploader.FrameCleanup

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Cleans up internal data and recovers buffers into the free buffer pool.

```APIDOC
## FrameCleanup()

### Description
Cleans up internal data and recovers buffers into the free buffer pool.

### Remarks
It's best practice to call this once at the end of every frame.
```

--------------------------------

### GetHashCode Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.LightMaps.html

Calculates and returns the hash code for the LightMaps struct.

```csharp
public override int GetHashCode()
```

--------------------------------

### OnInspectorGUI Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Global%20Namespace.MaterialOverrideEditor.html

Draws the custom inspector for the material override asset.

```APIDOC
## OnInspectorGUI()
Draws the custom inspector for the material override asset.

##### Declaration
```
public override void OnInspectorGUI()
```
```

--------------------------------

### Resize allocator

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Attempts to change the size of the allocator. Growing always succeeds, while shrinking may fail if the end of the heap is currently allocated.

```csharp
public bool Resize(ulong newSize)
```

--------------------------------

### Static Index Conversion Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Utility methods for converting between array indices and static indices used for serialization.

```APIDOC
## ArrayIndexToStaticIndex(int index)
Converts an array index into a negative static index.

## StaticIndexToArrayIndex(int staticIndex)
Converts a negative static index back to a valid array index.
```

--------------------------------

### Material and Mesh Fields

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

Accessors for the raw material and mesh IDs.

```csharp
public int Material
```

```csharp
public int Mesh
```

--------------------------------

### LightMaps

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Represents a container for light maps.

```APIDOC
## Struct LightMaps

### Description
Represents a container for light maps.

### Type
Struct
```

--------------------------------

### AddMatrixUploadAndInverse Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.ThreadedSparseUploader.html

Adds a pending matrix upload operation that also computes and stores the inverse of the matrices. This is useful when both the original and inverted matrices are needed on the GPU.

```csharp
public void AddMatrixUploadAndInverse(void* src, int numMatrices, int offset, int offsetInverse, ThreadedSparseUploader.MatrixType srcType, ThreadedSparseUploader.MatrixType dstType)
```

--------------------------------

### SparseUploaderStats Field Declarations

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploaderStats.html

Definitions for the fields tracking GPU memory usage statistics.

```csharp
public long BytesGPUMemoryUploadedCurr
```

```csharp
public long BytesGPUMemoryUploadedMax
```

```csharp
public long BytesGPUMemoryUsed
```

--------------------------------

### MaterialPropertyAttribute(string, short)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialPropertyAttribute.html

Constructs a new instance of the MaterialPropertyAttribute to associate a component with a shader property.

```APIDOC
## MaterialPropertyAttribute(string materialPropertyName, short overrideSizeGPU = -1)

### Description
Constructs a material property attribute to define the mapping between a component and a shader property.

### Parameters
- **materialPropertyName** (string) - The name of the material property in the shader.
- **overrideSizeGPU** (short) - Optional size of the property on the GPU in bytes. Defaults to -1.
```

--------------------------------

### HeapAllocator

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Represents a generic best-fit heap allocation algorithm that operates on abstract integer indices.

```APIDOC
## Struct HeapAllocator

### Description
Represents a generic best-fit heap allocation algorithm that operates on abstract integer indices.

### Type
Struct
```

--------------------------------

### RenderMeshUnmanaged Methods

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUnmanaged.html

Provides methods for equality comparison and hash code generation.

```APIDOC
public bool Equals(RenderMeshUnmanaged other)
public override int GetHashCode()
```

--------------------------------

### HeapAllocator Properties

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Properties to query the state and capacity of the allocator.

```csharp
public bool Empty { get; }
```

```csharp
public ulong FreeSpace { get; }
```

```csharp
public bool Full { get; }
```

```csharp
public bool IsCreated { get; }
```

```csharp
public ulong Size { get; }
```

```csharp
public ulong UsedSpace { get; }
```

--------------------------------

### CombineRenderMeshArrays(List<RenderMeshArray>)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshArray.html

Combines a list of RenderMeshArray instances into a single RenderMeshArray.

```APIDOC
## CombineRenderMeshArrays(List<RenderMeshArray>)

### Description
Combines a list of RenderMeshArrays into one RenderMeshArray.

### Parameters
- **renderMeshArrays** (List<RenderMeshArray>) - The list of RenderMeshArray instances to combine.

### Returns
- **RenderMeshArray** - Returns a RenderMeshArray instance that contains all of the meshes and materials. The MaterialMeshIndices field is left to null.
```

--------------------------------

### MaterialPropertyAttribute Properties

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialPropertyAttribute.html

Accessors for the material property name and the GPU override size.

```csharp
public string Name { get; }
```

```csharp
public short OverrideSizeGPU { get; }
```

--------------------------------

### SparseUploaderStats Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploaderStats.html

The structure definition for SparseUploaderStats.

```csharp
public struct SparseUploaderStats
```

--------------------------------

### SparseUploader.Dispose

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.SparseUploader.html

Disposes of the SparseUploader.

```APIDOC
## Dispose()

### Description
Disposes of the SparseUploader.
```

--------------------------------

### EntitiesGraphicsSystem

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

Renders all entities that contain both RenderMesh and LocalToWorld components.

```APIDOC
## Class EntitiesGraphicsSystem

### Description
Renders all entities that contain both RenderMesh and LocalToWorld components.

### Type
Class
```

--------------------------------

### ThreadedSparseUploader.AddUpload (void*)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.ThreadedSparseUploader.html

Adds a new pending upload operation for raw data.

```APIDOC
## AddUpload

### Description
Adds a new pending upload operation to execute when you call SparseUploader.EndAndCommit. When this operation executes, the SparseUploader copies data from the source pointer.

### Parameters
- **src** (void*) - The source pointer of data to upload.
- **size** (int) - The amount of data, in bytes, to read from the source pointer.
- **offsetInBytes** (int) - The destination offset of the data in the GPU buffer.
- **repeatCount** (int) - Optional. The number of times to repeat the source data in the destination buffer when uploading. Defaults to 1.
```

--------------------------------

### MaterialMeshInfo Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.MaterialMeshInfo.html

The struct definition for MaterialMeshInfo, implementing necessary interfaces for ECS component data.

```csharp
public struct MaterialMeshInfo : IComponentData, IQueryTypeParameter, IEnableableComponent
```

--------------------------------

### Bake(MeshRenderer)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.OverrideLightProbeAnchorBaker.html

Bakes the provided MeshRenderer authoring component during the baking process.

```APIDOC
## Bake(MeshRenderer)

### Description
Called in the baking process to bake the authoring component. This method is invoked for every instance of the authoring type.

### Signature
`public override void Bake(MeshRenderer authoring)`

### Parameters
- **authoring** (MeshRenderer) - The authoring component to bake.

### Overrides
Unity.Entities.Baker<UnityEngine.MeshRenderer>.Bake(UnityEngine.MeshRenderer)
```

--------------------------------

### HeapBlock.CompareTo Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapBlock.html

Compares the current HeapBlock with another HeapBlock for ordering. Used for sorting or determining relative positions of memory blocks.

```csharp
public int CompareTo(HeapBlock other)
```

--------------------------------

### Register Material Property Types

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.EntitiesGraphicsSystem.html

Registers a material property type with the system, optionally specifying the GPU size.

```csharp
public static void RegisterMaterialPropertyType(Type type, string propertyName, short overrideTypeSizeGPU = -1)
```

```csharp
public static void RegisterMaterialPropertyType<T>(string propertyName, short overrideTypeSizeGPU = -1) where T : IComponentData
```

--------------------------------

### FrustumPlanes.FromCamera

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.FrustumPlanes.html

Populates the frustum plane array from the given camera frustum.

```APIDOC
## FrustumPlanes.FromCamera(Camera, NativeArray<float4>)

### Description
Populates the frustum plane array from the given camera frustum.

### Method
static void

### Parameters
#### Parameters
- **camera** (Camera) - The camera to use for calculation.
- **planes** (NativeArray<float4>) - The result of the operation.

### Exceptions
- **ArgumentNullException**: Is thrown if the planes are empty.
- **ArgumentException**: Is thrown if the planes size is not equal to 6.
```

--------------------------------

### Allocate memory block

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Attempts to allocate a block of memory with a specified size and alignment.

```csharp
public HeapBlock Allocate(ulong size, uint alignment = 1)
```

--------------------------------

### HeapAllocator Properties

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.HeapAllocator.html

Properties to query the state and capacity of the HeapAllocator.

```APIDOC
## Properties

- **Empty** (bool) - Indicates whether the allocator is empty.
- **FreeSpace** (ulong) - The amount of available free space in the allocator.
- **Full** (bool) - Indicates whether the allocator is full.
- **IsCreated** (bool) - Indicates whether the allocator has been created.
- **Size** (ulong) - The total size of the heap managed by the allocator.
- **UsedSpace** (ulong) - The amount of used space in the allocator.
```

--------------------------------

### RenderBounds

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

An unmanaged component that represent the render bounds.

```APIDOC
## Struct RenderBounds

### Description
An unmanaged component that represent the render bounds.

### Type
Struct
```

--------------------------------

### RegisterMesh(Mesh)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.EntitiesGraphicsSystem.html

Registers a mesh with the Entities Graphics System and returns a BatchMeshID.

```APIDOC
## RegisterMesh(Mesh)

### Description
Registers a mesh with the Entities Graphics System.

### Parameters
- **mesh** (Mesh) - Mesh instance to register.

### Returns
- **BatchMeshID** - Returns the batch mesh ID.
```

--------------------------------

### GetMaterial

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshArray.html

Retrieves the material associated with the provided MaterialMeshInfo.

```APIDOC
## GetMaterial(MaterialMeshInfo)

### Declaration
`public Material GetMaterial(MaterialMeshInfo materialMeshInfo)`

### Parameters
- **materialMeshInfo** (MaterialMeshInfo) - The MaterialMeshInfo to use.

### Returns
- **Material** - Returns the associated material instance, or null if the material is runtime.
```

--------------------------------

### RenderMeshArray(ReadOnlySpan<UnityObjectRef<Material>>, ReadOnlySpan<UnityObjectRef<Mesh>>, ReadOnlySpan<MaterialMeshIndex>)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshArray.html

Constructs an instance of RenderMeshArray from spans of materials, meshes, and optional material-mesh indices.

```APIDOC
## RenderMeshArray(ReadOnlySpan<UnityObjectRef<Material>>, ReadOnlySpan<UnityObjectRef<Mesh>>, ReadOnlySpan<MaterialMeshIndex>)

### Description
Constructs an instance of RenderMeshArray from an array of materials and an array of meshes.

### Parameters
- **materials** (ReadOnlySpan<UnityObjectRef<Material>>) - The array of materials to use in the RenderMeshArray.
- **meshes** (ReadOnlySpan<UnityObjectRef<Mesh>>) - The array of meshes to use in the RenderMeshArray.
- **materialMeshIndices** (ReadOnlySpan<MaterialMeshIndex>) - The array of MaterialMeshIndex to use in the RenderMeshArray.
```

--------------------------------

### CustomProbeTag

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

A tag component that marks an entity as a custom light probe.

```APIDOC
## Struct CustomProbeTag

### Description
A tag component that marks an entity as a custom light probe.

### Type
Struct
```

--------------------------------

### MaterialColorBaker Class Syntax

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.Authoring.MaterialColorBaker.html

The class definition for MaterialColorBaker, inheriting from Baker<MaterialColor>.

```csharp
public class MaterialColorBaker : Baker<MaterialColor>
```

--------------------------------

### PerInstanceCullingTag

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.html

A tag component that allows for granular per-instance culling control.

```APIDOC
## Struct PerInstanceCullingTag

### Description
A tag component that allows for granular per-instance culling control.

### Type
Struct
```

--------------------------------

### RenderFilterSettings Equals(object) Method

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Entities.Graphics.RenderFilterSettings.html

Overrides the base Equals method to compare the current RenderFilterSettings instance with another object.

```csharp
public override bool Equals(object obj);
```

--------------------------------

### RenderMeshUnmanaged Constructor

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.RenderMeshUnmanaged.html

Constructs a RenderMeshUnmanaged instance using a mesh, an optional material for a specific submesh, and an optional submesh index.

```csharp
public RenderMeshUnmanaged(UnityObjectRef<Mesh> mesh, UnityObjectRef<Material> materialForSubMesh = default, int subMeshIndex = 0)
```

--------------------------------

### Bake(MaterialColor)

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.Authoring.MaterialColorBaker.html

Called during the baking process to bake the authoring component.

```APIDOC
## Bake(MaterialColor)

### Description
Called during the baking process to bake the authoring component.

### Declaration
`public override void Bake(MaterialColor authoring)`

### Parameters
- **authoring** (MaterialColor) - The authoring component to bake.

### Overrides
Baker<MaterialColor>.Bake(MaterialColor)
```

--------------------------------

### Register Mesh

Source: https://docs.unity3d.com/Packages/com.unity.entities.graphics%401.4/api/Unity.Rendering.EntitiesGraphicsSystem.html

Registers a mesh instance with the Entities Graphics System and returns a BatchMeshID.

```csharp
public BatchMeshID RegisterMesh(Mesh mesh)
```
Tokens:
Raw