Photon Quantum 3.0.0

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

Quantum boolean type that is stored on components. More...

Inherits IEquatable< QBoolean >.

Public Member Functions

override bool Equals (object obj)
 Determines whether two object instances are equal. More...
 
bool Equals (QBoolean other)
 Returns a value indicating whether this instance is equal to a specified QBoolean value. More...
 
override int GetHashCode ()
 Overrides the hash code generation of this type. More...
 
override String ToString ()
 Converts the numeric value of this instance to its equivalent string representation. More...
 

Static Public Member Functions

static implicit operator bool (QBoolean b)
 Case the QBoolean type to a bool. More...
 
static implicit operator QBoolean (bool b)
 Case a bool to QBoolean type. More...
 
static unsafe void Print (QBoolean *ptr, FramePrinter printer)
 Prints the QBoolean using a FramePrinter. More...
 
static unsafe void Serialize (void *ptr, FrameSerializer serializer)
 Serializes a QBoolean into a FrameSerializer to write or read from a frame snapshot. More...
 

Public Attributes

int Value
 The bool value stored as an int. More...
 

Static Public Attributes

const int SIZE = sizeof(int)
 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

Quantum boolean type that is stored on components.

Member Function Documentation

◆ operator bool()

static implicit Quantum.QBoolean.operator bool ( QBoolean  b)
inlinestatic

Case the QBoolean type to a bool.

Parameters
bBool

◆ operator QBoolean()

static implicit Quantum.QBoolean.operator QBoolean ( bool  b)
inlinestatic

Case a bool to QBoolean type.

Parameters
binput bool

◆ Serialize()

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

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

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

◆ Print()

static unsafe void Quantum.QBoolean.Print ( QBoolean ptr,
FramePrinter  printer 
)
inlinestatic

Prints the QBoolean using a FramePrinter.

Parameters
ptrPointer to QBoolean instance
printerPrinter object

◆ ToString()

override String Quantum.QBoolean.ToString ( )
inline

Converts the numeric value of this instance to its equivalent string representation.

Returns
The string representation of the value of this instance

◆ Equals() [1/2]

bool Quantum.QBoolean.Equals ( QBoolean  other)
inline

Returns a value indicating whether this instance is equal to a specified QBoolean value.

Parameters
otherA QBoolean value to compare to this instance.
Returns
true if other has the same value as this instance; otherwise, false.

◆ Equals() [2/2]

override bool Quantum.QBoolean.Equals ( object  obj)
inline

Determines whether two object instances are equal.

Parameters
objThe object to compare with the current object.
Returns
true if the specified object is equal to the current object; otherwise, false.

◆ GetHashCode()

override int Quantum.QBoolean.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.QBoolean.SIZE = sizeof(int)
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.

◆ Value

int Quantum.QBoolean.Value

The bool value stored as an int.