Photon Quantum 3.0.0

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

The Quantum physics layer mask used with LayerValue. More...

Public Member Functions

override int GetHashCode ()
 Overrides the hash code generation of this type. More...
 

Static Public Member Functions

static implicit operator Int32 (LayerMask mask)
 Cast a LayerMask struct to an integer. More...
 
static implicit operator LayerMask (Int32 mask)
 Case an integer to a LayerMask struct. More...
 
static void Serialize (void *ptr, FrameSerializer serializer)
 Serializes a LayerMask into a FrameSerializer to write or read from a frame snapshot. More...
 

Public Attributes

Int32 BitMask
 The bit mask of the layer saved on the frame. More...
 

Static Public Attributes

const int SIZE = 4
 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...
 

Detailed Description

The Quantum physics layer mask used with LayerValue.

Member Function Documentation

◆ operator Int32()

static implicit Quantum.LayerMask.operator Int32 ( LayerMask  mask)
inlinestatic

Cast a LayerMask struct to an integer.

Parameters
maskInput layer mask

◆ operator LayerMask()

static implicit Quantum.LayerMask.operator LayerMask ( Int32  mask)
inlinestatic

Case an integer to a LayerMask struct.

Parameters
maskInput integer

◆ Serialize()

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

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

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

◆ GetHashCode()

override int Quantum.LayerMask.GetHashCode ( )
inline

Overrides the hash code generation of this type.

Returns
A hash code of the current state of this instance.

Member Data Documentation

◆ SIZE

const int Quantum.LayerMask.SIZE = 4
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.

◆ BitMask

Int32 Quantum.LayerMask.BitMask

The bit mask of the layer saved on the frame.