Class MaximumChunkCapacityAttribute | Entities | 0.10.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Class MaximumChunkCapacityAttribute

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

    Inheritance
    Object
    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
    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
    Int32
    In This Article
    • Constructors
      • MaximumChunkCapacityAttribute(Int32)
    • Fields
      • Capacity
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023