Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


MemoryLabel(string, string, Allocator)

Initializes a new instance of the MemoryLabel struct.
Read time 1 minuteLast updated 8 days ago

Definition

  • Type: Constructor
  • Namespace: Unity.Collections
  • Assembly: UnityEngine.ManagedKernelModule
public MemoryLabel(string areaName, string objectName, Allocator allocator = Allocator.Persistent)

Parameters

areaName

The name of the memory area.

objectName

The name of the object being labeled.

allocator

The allocator to use. Defaults to Allocator.Persistent. Only Allocator.Persistent and Allocator.Domain support memory labeling.

Remarks

Creates a new memory label with the specified area name, object name, and allocator. Attempting to create a memory label with empty strings for the area name or object name, or with an unsupported allocator, throws an exception.
You can create multiple memory labels with the same area name and object name. However, for the purposes of memory tracking, this is equivalent to reusing a previously created label.
Creating a memory label is a thread-safe operation.