Struct NativeHashMap<TKey, TValue>

Namespace: Unity.Collections
Syntax
public struct NativeHashMap<TKey, TValue> : IDisposable where TKey : struct, IEquatable<TKey> where TValue : struct
Type Parameters
Name Description
TKey
TValue

Constructors

NativeHashMap(Int32, Allocator)

Declaration
public NativeHashMap(int capacity, Allocator allocator)
Parameters
Type Name Description
System.Int32 capacity
Allocator allocator

Properties

Capacity

Declaration
public int Capacity { get; set; }
Property Value
Type Description
System.Int32

IsCreated

Declaration
public bool IsCreated { get; }
Property Value
Type Description
System.Boolean

Item[TKey]

Declaration
public TValue this[TKey key] { get; set; }
Parameters
Type Name Description
TKey key
Property Value
Type Description
TValue

Length

Declaration
public int Length { get; }
Property Value
Type Description
System.Int32

Methods

AsParallelWriter()

Returns parallel writer instance.

Declaration
public NativeHashMap<TKey, TValue>.ParallelWriter AsParallelWriter()
Returns
Type Description
NativeHashMap.ParallelWriter<>

Clear()

Declaration
public void Clear()

ContainsKey(TKey)

Declaration
public bool ContainsKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
System.Boolean

Dispose()

Disposes of this container and deallocates its memory immediately.

Declaration
public void Dispose()

Dispose(JobHandle)

Safely disposes of this container and deallocates its memory when the jobs that use it have completed.

Declaration
public JobHandle Dispose(JobHandle inputDeps)
Parameters
Type Name Description
JobHandle inputDeps
Returns
Type Description
JobHandle

A new job handle containing the prior handles as well as the handle for the job that deletes the container.
Remarks

You can call this function dispose of the container immediately after scheduling the job. Pass the JobHandle returned by the Job.Schedule method using the jobHandle parameter so the job scheduler can dispose the container after all jobs using it have run.

GetKeyArray(Allocator)

Declaration
public NativeArray<TKey> GetKeyArray(Allocator allocator)
Parameters
Type Name Description
Allocator allocator
Returns
Type Description
NativeArray<TKey>

GetValueArray(Allocator)

Declaration
public NativeArray<TValue> GetValueArray(Allocator allocator)
Parameters
Type Name Description
Allocator allocator
Returns
Type Description
NativeArray<TValue>

Remove(TKey)

Declaration
public void Remove(TKey key)
Parameters
Type Name Description
TKey key

TryAdd(TKey, TValue)

Declaration
public bool TryAdd(TKey key, TValue item)
Parameters
Type Name Description
TKey key
TValue item
Returns
Type Description
System.Boolean

TryGetValue(TKey, out TValue)

Declaration
public bool TryGetValue(TKey key, out TValue item)
Parameters
Type Name Description
TKey key
TValue item
Returns
Type Description
System.Boolean

Extension Methods