Struct MemoryArray<T>

A memory array is very similar in nature to a NativeArray. It stores a reference to an array of data elements and allows for retrieval of inidividual elements. This is a workaround for the inability to nest NativeArrays.

Namespace: Unity.Kinematica

Syntax

public struct MemoryArray<T>
    where T : struct

Type Parameters

Name	Description
T

Constructors

MemoryArray(T[])

Declaration

public MemoryArray(T[] array)

Parameters

Type	Name	Description
T[]	array

Properties

IsValid

Determines if the given memory array is valid or not.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
Boolean	True if the memory array is valid; false otherwise.

Item[Int32]

Allows to retrieve an individual array element. The element is returned a ref value.

Declaration

public T this[int index] { get; }

Parameters

Type	Name	Description
Int32	index

Property Value

Type	Description
T

Length

Determines the amount of elements stored in the memory array.

Declaration

public int Length { get; }

Property Value

Type	Description
Int32

Null

Invalid memory array.

Declaration

public static MemoryArray<T> Null { get; }

Property Value

Type	Description
MemoryArray<T>

Methods

CopyTo(ref MemoryArray<T>)

Copies the memory array to the target memory array passed as argument.

Declaration

public void CopyTo(ref MemoryArray<T> target)

Parameters

Type	Name	Description
MemoryArray<T>	target	The target memory array that this memory array should be copied to.

ReadFromStream(Buffer)

Reads a memory array from the buffer passed as argument.

Declaration

public void ReadFromStream(Buffer buffer)

Parameters

Type	Name	Description
Buffer	buffer	The buffer that the memory array should be read from.

WriteToStream(Buffer)

Stores a memory array in the buffer passed as argument.

Declaration

public void WriteToStream(Buffer buffer)

Parameters

Type	Name	Description
Buffer	buffer	The buffer that the memory array should be written to.