Struct SpatialObserverHandle

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Opaque handle to a registered spatial observer. Validated via generation counter to detect use-after-destroy.

public readonly struct SpatialObserverHandle : IEquatable<SpatialObserverHandle>

Implements

IEquatable<SpatialObserverHandle>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Methods

Equals(object)

Indicates whether obj is a SpatialObserverHandle equal to this one.

public override bool Equals(object obj)

Parameters

obj object

Object to compare against.

Returns

bool

true if obj is an equal handle.

Equals(SpatialObserverHandle)

Indicates whether this handle equals other (same slot index and generation).

public bool Equals(SpatialObserverHandle other)

Parameters

other SpatialObserverHandle

Handle to compare against.

Returns

bool

true if both refer to the same observer registration.

GetHashCode()

Returns a hash code combining the slot index and generation.

public override int GetHashCode()

Returns

int

ToString()

Returns a string of the form Observer(index:generation).

public override string ToString()

Returns

string

Operators

operator ==(SpatialObserverHandle, SpatialObserverHandle)

Equality operator; see Equals(SpatialObserverHandle).

public static bool operator ==(SpatialObserverHandle left, SpatialObserverHandle right)

Parameters

left SpatialObserverHandle

Left handle.

right SpatialObserverHandle

Right handle.

Returns

bool

true if the handles are equal.

operator !=(SpatialObserverHandle, SpatialObserverHandle)

Inequality operator; see Equals(SpatialObserverHandle).

public static bool operator !=(SpatialObserverHandle left, SpatialObserverHandle right)

Parameters

left SpatialObserverHandle

Left handle.

right SpatialObserverHandle

Right handle.

Returns

bool

true if the handles differ.