Class MaximumChunkCapacityAttribute

Specifies the maximum number of components of a type that can be stored in the same chunk.

Inheritance

System.Object

System.Attribute

MaximumChunkCapacityAttribute

Namespace: Unity.Entities

Syntax

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct)]
public class MaximumChunkCapacityAttribute : Attribute, _Attribute

Remarks

Place this attribute on the declaration of a component, such as IComponentData, to limit the number of entities with that component which can be stored in a single chunk. Note that the actual limit on the number of entities in a chunk can be smaller, based on the actual size of all the components in the same EntityArchetype as the component defining this limit.

If an archetype contains more than one component type specifying a chunk capacity limit, then the lowest limit is used.

Constructors

MaximumChunkCapacityAttribute(Int32)

The maximum number of entities having this component type in an ArchetypeChunk.

Declaration

public MaximumChunkCapacityAttribute(int capacity)

Parameters

Type	Name	Description
System.Int32	capacity

Fields

Capacity

The maximum number of entities having this component type in an ArchetypeChunk.

Declaration

public readonly int Capacity

Field Value

Type	Description
System.Int32