NativeBitArray
An arbitrarily-sized array of bits.
Read time 2 minutesLast updated 8 days ago
Definition
- Type: Struct
- Namespace: Unity.Collections
- Assembly: UnityEngine.ManagedKernelModule
- Implements: INativeDisposable, IDisposable
public struct NativeBitArray : INativeDisposable, IDisposable
Remarks
The number of allocated bytes is always a multiple of 8. For example, a 65-bit array could fit in 9 bytes, but its allocation is actually 16 bytes.
Static Fields
Value | Description |
|---|---|
| MaxCapacity | The maximum number of elements this type of container can hold. |
Constructors
Constructor | Description |
|---|---|
| NativeBitArray(System.Int32,Unity.Collections.AllocatorManager.AllocatorHandle,Unity.Collections.NativeArrayOptions) | Initializes and returns an instance of NativeBitArray. |
Properties
Property | Description |
|---|---|
| Capacity | Returns the capacity number of bits. |
| IsCreated | Whether this array has been allocated (and not yet deallocated). |
| IsEmpty | Whether the container is empty. |
| Length | Returns the number of bits. |
Methods
Method | Description |
|---|---|
| AsNativeArray | Returns a native array that aliases the content of this array. |
| AsReadOnly | Returns a readonly version of this NativeBitArray instance. |
| Clear | Sets all the bits to 0. |
| Copy | Copies a range of bits from this array to another range in this array. |
| CountBits | Returns the number of bits in a range that are 1. |
| Dispose | Releases all resources (memory and safety handles). |
| Find | Find a sequence of N contiguous 0 bits in a bit array. To achieve higher performance, it is not guaranteed that the found index is necessarily the first occurrence of such a sequence. |
| GetBits | Returns a ulong which has bits copied from this array. |
| IsSet | Returns true if the bit at an index is 1. |
| Resize | Sets the length, expanding the capacity if necessary. |
| Set | Sets the bit at an index to 0 or 1. |
| SetBits | Sets a range of bits to 0 or 1. |
| SetCapacity | Sets the capacity. |
| TestAll | Returns true if all of the bits in a range are 1. |
| TestAny | Returns true if at least one of the bits in a range is 1. |
| TestNone | Returns true if none of the bits in a range are 1 ("i.e." all bits in the range are 0). |
| TrimExcess | Sets the capacity to match what it would be if it had been originally initialized with all its entries. |
Structs
Struct | Description |
|---|---|
| NativeBitArray.ReadOnly | A read-only alias for the value of a UnsafeBitArray. Does not have its own allocated storage. |