class in Unity.Collections.LowLevel.Unsafe
/
Implemented in:UnityEngine.CoreModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseProvides a collection of low-level, unsafe utility methods for memory operations in Unity.
The UnsafeUtility
class provides functions for direct memory manipulation. These functions are unsafe because they allow you to bypass the safety restrictions of managed code. You can perform operations such as memory allocation, deallocation, copying, and setting memory directly.
Use these methods with extreme caution to avoid memory leaks, access violations, or data corruption. The UnsafeUtility
class is intended for scenarios where performance is critical, and the overhead of managed memory safety is prohibitive.
Common use cases include interaction with native code, performance-critical sections in custom collections or game systems, and low-level manipulation required by specific algorithms.
using Unity.Collections; using Unity.Collections.LowLevel.Unsafe; using UnityEngine;
public class UnsafeUtilityExample : MonoBehaviour { void Start() { unsafe { // Allocate a block of unmanaged memory to store 10 integers int sizeOfInt = UnsafeUtility.SizeOf<int>(); int length = 10; void* memoryBlock = UnsafeUtility.Malloc(sizeOfInt * length, 4, Allocator.Temp);
// Write data to the allocated memory for (int i = 0; i < length; i++) { UnsafeUtility.WriteArrayElement<int>(memoryBlock, i, i * 10); }
// Read and print data from the allocated memory for (int i = 0; i < length; i++) { int value = UnsafeUtility.ReadArrayElement<int>(memoryBlock, i); Debug.Log("Value: " + value); }
// Free the allocated unmanaged memory UnsafeUtility.Free(memoryBlock, Allocator.Temp); } } }
Additional resources: NativeArray<T0>, NativeArrayUnsafeUtility, Job system overview.
AddressOf | Obtains the memory address of the specified object as a pointer. |
AlignOf | Retrieves the minimum memory alignment requirement for a specified struct type. |
ArrayElementAsRef | Obtains a reference to a value of type T in an array at a specified index in memory. |
As | Performs an unsafe cast of a specified object to a different type. |
AsRef | Gets a reference to a struct at a specific memory location. |
CheckForLeaks | Gets a list of memory leaks. |
CopyObjectAddressToPtr | Assigns an object reference to a struct or pinned class. |
CopyPtrToStructure | Copies sizeof(T) bytes from a memory pointer to a struct. |
CopyStructureToPtr | Copies sizeof(T) bytes from a memory pointer to a struct. |
EnumEquals | Determines whether specified enums are equal without boxing. |
EnumToInt | Gets the integer representation of an enum value without boxing. |
ForgiveLeaks | Tells the leak checking system to ignore any memory allocations made up to that point. |
Free | Frees a block of memory that was previously allocated. |
FreeTracked | Free memory with leak tracking. |
GetFieldOffset | Returns the offset of the field relative struct or class it is contained in. |
GetLeakDetectionMode | Gets the mode of memory leak detection. |
IsBlittable | Gets whether a struct is blittable. |
IsNativeContainerType | Checks whether a struct or type is a NativeContainer. |
IsUnmanaged | Checks whether the struct or type is unmanaged. |
IsValidAllocator | Returns true if the allocator label is valid and can be used to allocate or deallocate memory. |
IsValidNativeContainerElementType | Checks whether the type is acceptable as an element type in a native container. |
Malloc | Allocates a block of memory of a specified size and alignment. |
MallocTracked | Allocates a block of memory with specified size, alignment, and tracking information. |
MemClear | Clears a block of memory, setting all bytes to zero. |
MemCmp | Checks whether two memory regions are identical. |
MemCpy | Copies a specified number of bytes from a source memory location to a destination memory location. |
MemCpyReplicate | Copies memory from a source to a destination and replicates it multiple times. |
MemCpyStride | Copies data between memory blocks with specified strides, allowing skipped bytes in both source and destination. |
MemMove | Copies a specified number of bytes from a source memory location to a destination, allowing overlapping regions. |
MemSet | Sets a block of memory to a specified byte value for a defined size. |
MemSwap | Swap the content of two memory buffers of the same size. |
PinGCArrayAndGetDataAddress | Pins a garbage-collected (GC) array and returns the address of its first element, ensuring the array's memory location remains fixed. |
PinGCObjectAndGetAddress | Pins an object in memory, ensuring it remains at a fixed memory location during garbage collection. |
ReadArrayElement | Read array element. |
ReadArrayElementWithStride | Read array element with stride. |
ReleaseGCObject | Releases a GC handle obtained from UnsafeUtility.PinGCObjectAndGetAddress or UnsafeUtility.PinGCArrayAndGetDataAddress. |
SetLeakDetectionMode | Set the leak detection mode. |
SizeOf | Determines the size, in bytes, of a specified type, including padding for alignment. |
WriteArrayElement | Write array element. |
WriteArrayElementWithStride | Write array element with stride. |
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.