Free
Frees a block of memory that was previously allocated.
Read time 2 minutesLast updated 13 days ago
Definition
- Type: Method
- Namespace: Unity.Collections.LowLevel.Unsafe
- Assembly: UnityEngine.ManagedKernelModule
Free(void*, Allocator)
Frees a block of memory that was previously allocated.
public static void Free(void* memory, Allocator allocator)
Parameters
A pointer to the block of memory you want to free. Ensure this pointer is valid and was previously allocated using UnsafeUtility.Malloc to avoid undefined behavior.
The allocator type that was originally used to allocate the memory. It is crucial that the allocator matches the one used during allocation to ensure correct deallocation.
Remarks
The method deallocates memory that was allocated using UnsafeUtility.Malloc. This is essential to prevent memory leaks, which can lead to reduced application performance or system instability. Always ensure that any allocated memory is freed when it is no longer needed.
FreeExercise caution when using this method. Improper deallocation of memory can result in undefined behavior and application crashes. The allocator used in this function should match the one used in the corresponding allocation.
Additional Resources: UnsafeUtility.Malloc
Examples
using Unity.Collections;using Unity.Collections.LowLevel.Unsafe;using UnityEngine;public class UnsafeUtilityFreeExample : MonoBehaviour{ void Start() { unsafe { // Allocate a block of memory for 10 integers int sizeOfInt = UnsafeUtility.SizeOf<int>(); void* memoryBlock = UnsafeUtility.Malloc(sizeOfInt * 10, 4, Allocator.Temp); // Ensure memory is freed when no longer needed UnsafeUtility.Free(memoryBlock, Allocator.Temp); Debug.Log("Memory block freed."); } }}
Free(void*, MemoryLabel)
Frees a block of memory that was previously allocated, using the specified memory label.
public static void Free(void* memory, MemoryLabel label)
Parameters
A pointer to the block of memory you want to free. Ensure this pointer is valid and was previously allocated using UnsafeUtility.Malloc to avoid undefined behavior.
The memory label that was used to allocate the memory. The memory label should match the one used during allocation to ensure correct deallocation.
Remarks
The method deallocates memory that was allocated using UnsafeUtility.Malloc. This is essential to prevent memory leaks, which can lead to reduced application performance or system instability. Always ensure that any allocated memory is freed when it is no longer needed.
FreeExercise caution when using this method. Improper deallocation of memory can result in undefined behavior and application crashes. The memory label used in this function must match the one used in the corresponding allocation.
Additional Resources: MemoryLabel, UnsafeUtility.Malloc