Struct NativeArray<T>

Namespace: Unity.Collections
Syntax
public struct NativeArray<T> : IDisposable, IEnumerable<T>, IEnumerable, IEquatable<NativeArray<T>> where T : struct
Type Parameters
Name Description
T

Constructors

NativeArray(T[], Allocator)

Declaration
public NativeArray(T[] array, Allocator allocator)
Parameters
Type Name Description
T[] array
Allocator allocator

NativeArray(Int32, Allocator, NativeArrayOptions)

Declaration
public NativeArray(int length, Allocator allocator, NativeArrayOptions options = NativeArrayOptions.ClearMemory)
Parameters
Type Name Description
Int32 length
Allocator allocator
NativeArrayOptions options

NativeArray(NativeArray<T>, Allocator)

Declaration
public NativeArray(NativeArray<T> array, Allocator allocator)
Parameters
Type Name Description
NativeArray<T> array
Allocator allocator

Properties

IsCreated

Declaration
public bool IsCreated { get; }
Property Value
Type Description
Boolean

Item[Int32]

Declaration
public T this[int index] { get; set; }
Parameters
Type Name Description
Int32 index
Property Value
Type Description
T

Length

Declaration
public int Length { get; }
Property Value
Type Description
Int32

Methods

AsReadOnly()

Declaration
public NativeArray<T>.ReadOnly AsReadOnly()
Returns
Type Description
NativeArray.ReadOnly<>

Copy(T[], Int32, NativeArray<T>, Int32, Int32)

Declaration
public static void Copy(T[] src, int srcIndex, NativeArray<T> dst, int dstIndex, int length)
Parameters
Type Name Description
T[] src
Int32 srcIndex
NativeArray<T> dst
Int32 dstIndex
Int32 length

Copy(T[], NativeArray<T>)

Declaration
public static void Copy(T[] src, NativeArray<T> dst)
Parameters
Type Name Description
T[] src
NativeArray<T> dst

Copy(T[], NativeArray<T>, Int32)

Declaration
public static void Copy(T[] src, NativeArray<T> dst, int length)
Parameters
Type Name Description
T[] src
NativeArray<T> dst
Int32 length

Copy(NativeArray<T>, T[])

Declaration
public static void Copy(NativeArray<T> src, T[] dst)
Parameters
Type Name Description
NativeArray<T> src
T[] dst

Copy(NativeArray<T>, T[], Int32)

Declaration
public static void Copy(NativeArray<T> src, T[] dst, int length)
Parameters
Type Name Description
NativeArray<T> src
T[] dst
Int32 length

Copy(NativeArray<T>, Int32, T[], Int32, Int32)

Declaration
public static void Copy(NativeArray<T> src, int srcIndex, T[] dst, int dstIndex, int length)
Parameters
Type Name Description
NativeArray<T> src
Int32 srcIndex
T[] dst
Int32 dstIndex
Int32 length

Copy(NativeArray<T>, Int32, NativeArray<T>, Int32, Int32)

Declaration
public static void Copy(NativeArray<T> src, int srcIndex, NativeArray<T> dst, int dstIndex, int length)
Parameters
Type Name Description
NativeArray<T> src
Int32 srcIndex
NativeArray<T> dst
Int32 dstIndex
Int32 length

Copy(NativeArray<T>, NativeArray<T>)

Declaration
public static void Copy(NativeArray<T> src, NativeArray<T> dst)
Parameters
Type Name Description
NativeArray<T> src
NativeArray<T> dst

Copy(NativeArray<T>, NativeArray<T>, Int32)

Declaration
public static void Copy(NativeArray<T> src, NativeArray<T> dst, int length)
Parameters
Type Name Description
NativeArray<T> src
NativeArray<T> dst
Int32 length

CopyFrom(T[])

Declaration
public void CopyFrom(T[] array)
Parameters
Type Name Description
T[] array

CopyFrom(NativeArray<T>)

Declaration
public void CopyFrom(NativeArray<T> array)
Parameters
Type Name Description
NativeArray<T> array

CopyTo(T[])

Declaration
public void CopyTo(T[] array)
Parameters
Type Name Description
T[] array

CopyTo(NativeArray<T>)

Declaration
public void CopyTo(NativeArray<T> array)
Parameters
Type Name Description
NativeArray<T> array

Dispose()

Declaration
public void Dispose()

Dispose(JobHandle)

Safely disposes of this container and deallocates its memory when the jobs that use it have completed.

Declaration
public JobHandle Dispose(JobHandle inputDeps)
Parameters
Type Name Description
JobHandle inputDeps
Returns
Type Description
JobHandle

A new job handle containing the prior handles as well as the handle for the job that deletes the container.
Remarks

You can call this function dispose of the container immediately after scheduling the job. Pass the JobHandle returned by the Job.Schedule method using the jobHandle parameter so the job scheduler can dispose the container after all jobs using it have run.

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

Equals(NativeArray<T>)

Declaration
public bool Equals(NativeArray<T> other)
Parameters
Type Name Description
NativeArray<T> other
Returns
Type Description
Boolean

GetEnumerator()

Declaration
public NativeArray<T>.Enumerator GetEnumerator()
Returns
Type Description
NativeArray.Enumerator<>

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

GetSubArray(Int32, Int32)

Declaration
public NativeArray<T> GetSubArray(int start, int length)
Parameters
Type Name Description
Int32 start
Int32 length
Returns
Type Description
NativeArray<T>

Reinterpret<U>()

Declaration
public NativeArray<U> Reinterpret<U>()
    where U : struct
Returns
Type Description
NativeArray<U>
Type Parameters
Name Description
U

Reinterpret<U>(Int32)

Declaration
public NativeArray<U> Reinterpret<U>(int expectedTypeSize)
    where U : struct
Parameters
Type Name Description
Int32 expectedTypeSize
Returns
Type Description
NativeArray<U>
Type Parameters
Name Description
U

ReinterpretLoad<U>(Int32)

Declaration
public U ReinterpretLoad<U>(int sourceIndex)
    where U : struct
Parameters
Type Name Description
Int32 sourceIndex
Returns
Type Description
U
Type Parameters
Name Description
U

ReinterpretStore<U>(Int32, U)

Declaration
public void ReinterpretStore<U>(int destIndex, U data)
    where U : struct
Parameters
Type Name Description
Int32 destIndex
U data
Type Parameters
Name Description
U

ToArray()

Declaration
public T[] ToArray()
Returns
Type Description
T[]

Operators

Equality(NativeArray<T>, NativeArray<T>)

Declaration
public static bool operator ==(NativeArray<T> left, NativeArray<T> right)
Parameters
Type Name Description
NativeArray<T> left
NativeArray<T> right
Returns
Type Description
Boolean

Inequality(NativeArray<T>, NativeArray<T>)

Declaration
public static bool operator !=(NativeArray<T> left, NativeArray<T> right)
Parameters
Type Name Description
NativeArray<T> left
NativeArray<T> right
Returns
Type Description
Boolean

Extension Methods