docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method ToComponentDataArray

    ToComponentDataArray<T>(AllocatorHandle)

    Creates a NativeArray containing the components of type T for the selected entities.

    Declaration
    [GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleComponentData) })]
    public NativeArray<T> ToComponentDataArray<T>(AllocatorManager.AllocatorHandle allocator) where T : unmanaged, IComponentData
    Parameters
    Type Name Description
    AllocatorManager.AllocatorHandle allocator

    The type of memory to allocate.

    Returns
    Type Description
    NativeArray<T>

    An array containing the specified component for all the entities selected by the EntityQuery.

    Type Parameters
    Name Description
    T

    The component type.

    Remarks

    This version of the function blocks on all registered jobs against the relevant query components. For a non-blocking variant, see ToComponentDataListAsync<T>(AllocatorHandle, out JobHandle)

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if you request a component that is not part of the group.

    InvalidOperationException

    Thrown if T is not part of the query.

    ToComponentDataArray<T>()

    Creates a managed array containing the components of type T for the selected entities.

    Declaration
    [ExcludeFromBurstCompatTesting("Returns managed array")]
    public T[] ToComponentDataArray<T>() where T : class, IComponentData, new()
    Returns
    Type Description
    T[]

    A managed array containing the specified component for all the entities selected by the EntityQuery.

    Type Parameters
    Name Description
    T

    The component type.

    Remarks

    This version of the function blocks on all registered jobs against the relevant query components. For a non-blocking variant, see ToComponentDataListAsync<T>(AllocatorHandle, out JobHandle)

    Exceptions
    Type Condition
    InvalidOperationException

    Thrown if you request a component that is not part of the group.

    InvalidOperationException

    Thrown if T is not part of the query.

    In This Article
    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