Photon Quantum 3.0.0

Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Quantum.BitSet1024 Struct Reference

A bitmask with 1024 bits. More...

Public Member Functions

void Clear (Int32 bit)
 Clear a bit in the bitmask. More...
 
void ClearAll ()
 Clear all bits in the bitmask. More...
 
override Int32 GetHashCode ()
 Returns the hash code for the BitSet1024. More...
 
Boolean IsSet (Int32 bit)
 Check if a bit is set in the bitmask. More...
 
void Set (Int32 bit)
 Set a bit in the bitmask. More...
 

Static Public Member Functions

static BitSet1024 FromArray (UInt64[] values)
 Create a new BitSet1024 and initialize the data from an array. More...
 
static void Print (void *ptr, FramePrinter printer)
 Prints the BitSet1024 using a FramePrinter. More...
 
static void Serialize (void *ptr, FrameSerializer serializer)
 Serializes a BitSet1024 into a FrameSerializer to write or read from a frame snapshot. More...
 

Public Attributes

fixed UInt64 Bits [16]
 The data that the bitmask is actually saved to. More...
 

Static Public Attributes

const Int32 ALIGNMENT = 8
 The alignment of the component. More...
 
const Int32 BitsSize = 1024
 The maximum number of bits that can be stored in this bitmask. More...
 
const Int32 SIZE = 128
 The size of the component (or struct/type) in-memory inside the Frame data-buffers or stack (when passed as value parameter). Not related to the snapshot payload this occupies, which is bit-packed and compressed. More...
 

Properties

Int32 Length [get]
 The maximum number of bits that can be stored in this bitmask. More...
 

Detailed Description

A bitmask with 1024 bits.

Member Function Documentation

◆ Print()

static void Quantum.BitSet1024.Print ( void *  ptr,
FramePrinter  printer 
)
inlinestatic

Prints the BitSet1024 using a FramePrinter.

Parameters
ptrPointer to BitSet1024 instance
printerPrinter object

◆ FromArray()

static BitSet1024 Quantum.BitSet1024.FromArray ( UInt64[]  values)
inlinestatic

Create a new BitSet1024 and initialize the data from an array.

Parameters
valuesArray of UInt64 values

◆ Set()

void Quantum.BitSet1024.Set ( Int32  bit)
inline

Set a bit in the bitmask.

Parameters
bitBit index, must be less than Length

◆ Clear()

void Quantum.BitSet1024.Clear ( Int32  bit)
inline

Clear a bit in the bitmask.

Parameters
bitBit index, must be less than Length

◆ ClearAll()

void Quantum.BitSet1024.ClearAll ( )
inline

Clear all bits in the bitmask.

◆ IsSet()

Boolean Quantum.BitSet1024.IsSet ( Int32  bit)
inline

Check if a bit is set in the bitmask.

Parameters
bitBit index, must be less than Length

◆ GetHashCode()

override Int32 Quantum.BitSet1024.GetHashCode ( )
inline

Returns the hash code for the BitSet1024.

Returns
The hash code for the BitSet1024.

◆ Serialize()

static void Quantum.BitSet1024.Serialize ( void *  ptr,
FrameSerializer  serializer 
)
inlinestatic

Serializes a BitSet1024 into a FrameSerializer to write or read from a frame snapshot.

Parameters
ptrThe pointer to the BitSet1024.
serializerThe FrameSerializer instance into which the struct will be serialized.

Member Data Documentation

◆ SIZE

const Int32 Quantum.BitSet1024.SIZE = 128
static

The size of the component (or struct/type) in-memory inside the Frame data-buffers or stack (when passed as value parameter). Not related to the snapshot payload this occupies, which is bit-packed and compressed.

◆ ALIGNMENT

const Int32 Quantum.BitSet1024.ALIGNMENT = 8
static

The alignment of the component.

◆ Bits

fixed UInt64 Quantum.BitSet1024.Bits[16]

The data that the bitmask is actually saved to.

◆ BitsSize

const Int32 Quantum.BitSet1024.BitsSize = 1024
static

The maximum number of bits that can be stored in this bitmask.

Property Documentation

◆ Length

Int32 Quantum.BitSet1024.Length
get

The maximum number of bits that can be stored in this bitmask.