Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

AllocatorHandle

struct in Unity.Collections


Implements interfaces:IAllocator

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Represents the allocator function used within an allocator.

Static Properties

Property Description
InvalidChildAllocatorIndex For internal use only.
InvalidChildSafetyHandleIndex For internal use only.

Properties

Property Description
Function For internal use only.
Handle This handle.
Index This allocator's index into the global table of allocator functions.
IsAutoDispose Check whether this allocator will automatically dispose allocations.
IsCustomAllocator Check whether this allocator is a custom allocator.
ToAllocator Retrieve the Allocator associated with this allocator handle.
Value The AllocatorManager.AllocatorHandle.Index cast to int.
Version This allocator's version number.

Public Methods

Method Description
AllocateBlock Allocates a block with this allocator function.
CompareTo Compare this AllocatorHandle against a given one
Dispose Dispose the allocator.
Equals AllocatorHandle instances are equal if they refer to the same instance at the same version.
GetHashCode A hash used for comparisons.
Try Tries to allocate the block with this allocator.
TryAllocateBlock Allocates a block from this allocator.

Operators

Operator Description
AllocatorHandle Implicitly convert an Allocator to an AllocatorHandle with its Version being reset to 0.
operator != Evaluates if one AllocatorHandle is not equal to the other.
operator < Evaluates if one AllocatorHandle is less than the other.
operator <= Evaluates if one AllocatorHandle is less than or equal to the other.
operator == Evaluates if one AllocatorHandle is equal to the other.
operator > Evaluates if one AllocatorHandle is greater than the other.
operator >= Evaluates if one AllocatorHandle is greater than or equal to the other.