Class AllocatorManager

Inheritance

Object

AllocatorManager

Namespace: Unity.Collections

Syntax

public static class AllocatorManager

Fields

AudioKernel

Corresponds to Allocator.AudioKernel.

Declaration

public static readonly AllocatorManager.AllocatorHandle AudioKernel

Field Value

Type	Description
AllocatorManager.AllocatorHandle

FirstUserIndex

User-defined allocator index.

Declaration

public const ushort FirstUserIndex = 32

Field Value

Type	Description
UInt16

Invalid

Corresponds to Allocator.Invalid.

Declaration

public static readonly AllocatorManager.AllocatorHandle Invalid

Field Value

Type	Description
AllocatorManager.AllocatorHandle

None

Corresponds to Allocator.None.

Declaration

public static readonly AllocatorManager.AllocatorHandle None

Field Value

Type	Description
AllocatorManager.AllocatorHandle

Persistent

Corresponds to Allocator.Persistent.

Declaration

public static readonly AllocatorManager.AllocatorHandle Persistent

Field Value

Type	Description
AllocatorManager.AllocatorHandle

Temp

Corresponds to Allocator.Temp.

Declaration

public static readonly AllocatorManager.AllocatorHandle Temp

Field Value

Type	Description
AllocatorManager.AllocatorHandle

TempJob

Corresponds to Allocator.TempJob.

Declaration

public static readonly AllocatorManager.AllocatorHandle TempJob

Field Value

Type	Description
AllocatorManager.AllocatorHandle

Methods

Allocate(AllocatorManager.AllocatorHandle, Int32, Int32, Int32)

Declaration

public static void *Allocate(AllocatorManager.AllocatorHandle handle, int itemSizeInBytes, int alignmentInBytes, int items = 1)

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle
Int32	itemSizeInBytes
Int32	alignmentInBytes
Int32	items

Returns

Type	Description
Void*

Allocate<T>(AllocatorManager.AllocatorHandle, Int32)

Declaration

public static T*Allocate<T>(AllocatorManager.AllocatorHandle handle, int items = 1)
    where T : struct

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle
Int32	items

Returns

Type	Description
T*

Type Parameters

Name	Description
T

Free(AllocatorManager.AllocatorHandle, Void*)

Declaration

public static void Free(AllocatorManager.AllocatorHandle handle, void *pointer)

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle
Void*	pointer

Free(AllocatorManager.AllocatorHandle, Void*, Int32, Int32, Int32)

Declaration

public static void Free(AllocatorManager.AllocatorHandle handle, void *pointer, int itemSizeInBytes, int alignmentInBytes, int items = 1)

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle
Void*	pointer
Int32	itemSizeInBytes
Int32	alignmentInBytes
Int32	items

Free<T>(AllocatorManager.AllocatorHandle, T*, Int32)

Declaration

public static void Free<T>(AllocatorManager.AllocatorHandle handle, T*pointer, int items = 1)
    where T : struct

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle
T*	pointer
Int32	items

Type Parameters

Name	Description
T

Initialize()

Initializes SharedStatic allocator function table and allocator table, and installs default allocators.

Declaration

public static void Initialize()

Install(AllocatorManager.AllocatorHandle, IntPtr, AllocatorManager.TryFunction)

Creates and saves allocators' function pointers into function table.

Declaration

public static void Install(AllocatorManager.AllocatorHandle handle, IntPtr allocatorState, AllocatorManager.TryFunction function)

Parameters

Type	Name	Description
AllocatorManager.AllocatorHandle	handle	AllocatorHandle to allocator to install function for.
IntPtr	allocatorState	IntPtr to allocator's custom state.
AllocatorManager.TryFunction	function	Function pointer to create or save in function table.

Shutdown()

Declaration

public static void Shutdown()

Try(ref AllocatorManager.Block)

Looks up an allocator's allocate, free, or realloc function pointer from a table and invokes the function.

Declaration

public static int Try(ref AllocatorManager.Block block)

Parameters

Type	Name	Description
AllocatorManager.Block	block	Block to allocate memory for.

Returns

Type	Description
Int32	Error code of invoked function.