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.
Syntax
public struct MemoryArray<T>
where T : struct
Type Parameters
Constructors
MemoryArray(T[])
Declaration
public MemoryArray(T[] array)
Parameters
Type |
Name |
Description |
T[] |
array |
|
MemoryArray(NativeArray<T>, Int32, Int32)
Declaration
public MemoryArray(NativeArray<T> array, int startIndex = 0, int subLength = -1)
Parameters
Type |
Name |
Description |
NativeArray<T> |
array |
|
Int32 |
startIndex |
|
Int32 |
subLength |
|
MemoryArray(NativeSlice<T>)
Declaration
public MemoryArray(NativeSlice<T> array)
Parameters
Type |
Name |
Description |
NativeSlice<T> |
array |
|
MemoryArray(MemoryArray<T>, Int32, Int32)
Declaration
public MemoryArray(MemoryArray<T> array, int startIndex = 0, int subLength = -1)
Parameters
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
Length
Determines the amount of elements stored in the memory array.
Declaration
public int Length { get; }
Property Value
Null
Declaration
public static MemoryArray<T> Null { get; }
Property Value
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.
|
Reinterpret<U>()
Declaration
public MemoryArray<U> Reinterpret<U>()
where U : struct
Returns
Type Parameters
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.
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.