Struct HSteamNetPollGroup
Wraps the Steamworks HSteamNetPollGroup handle, a uint.
Inherited Members
Namespace: Unity.Steamworks.Interop
Assembly: Unity.Steamworks.Interop.dll
Syntax
[Serializable]
public struct HSteamNetPollGroup : IEquatable<HSteamNetPollGroup>, IComparable<HSteamNetPollGroup>
Constructors
HSteamNetPollGroup(uint)
Initializes a new HSteamNetPollGroup from its underlying value.
Declaration
public HSteamNetPollGroup(uint value)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | value | The underlying |
Fields
Invalid
The value the SDK reserves to mean "no HSteamNetPollGroup".
Declaration
public static readonly HSteamNetPollGroup Invalid
Field Value
| Type | Description |
|---|---|
| HSteamNetPollGroup |
m_HSteamNetPollGroup
The underlying uint value.
Declaration
public uint m_HSteamNetPollGroup
Field Value
| Type | Description |
|---|---|
| uint |
Methods
CompareTo(HSteamNetPollGroup)
Orders this value against other by their underlying values.
Declaration
public int CompareTo(HSteamNetPollGroup other)
Parameters
| Type | Name | Description |
|---|---|---|
| HSteamNetPollGroup | other | The value to compare against. |
Returns
| Type | Description |
|---|---|
| int | Negative, zero or positive as this value sorts before, with or after |
Equals(object)
Returns true when other is a HSteamNetPollGroup with the same value.
Declaration
public override bool Equals(object other)
Parameters
| Type | Name | Description |
|---|---|---|
| object | other | The object to compare against. |
Returns
| Type | Description |
|---|---|
| bool | true when |
Overrides
Equals(HSteamNetPollGroup)
Returns true when this value equals other.
Declaration
public bool Equals(HSteamNetPollGroup other)
Parameters
| Type | Name | Description |
|---|---|---|
| HSteamNetPollGroup | other | The value to compare against. |
Returns
| Type | Description |
|---|---|
| bool | true when both hold the same underlying value. |
GetHashCode()
Returns the hash code of the underlying value.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | The underlying value's hash code. |
Overrides
ToString()
Returns the underlying value as a string.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | The underlying value formatted by its own |
Overrides
Operators
operator ==(HSteamNetPollGroup, HSteamNetPollGroup)
Returns true when both operands hold the same value.
Declaration
public static bool operator ==(HSteamNetPollGroup x, HSteamNetPollGroup y)
Parameters
| Type | Name | Description |
|---|---|---|
| HSteamNetPollGroup | x | The first value to compare. |
| HSteamNetPollGroup | y | The second value to compare. |
Returns
| Type | Description |
|---|---|
| bool | true when the two hold the same underlying value. |
explicit operator HSteamNetPollGroup(uint)
Converts a uint to a HSteamNetPollGroup. Explicit, so two handle types cannot convert into each other through the type they share.
Declaration
public static explicit operator HSteamNetPollGroup(uint value)
Parameters
| Type | Name | Description |
|---|---|---|
| uint | value | The underlying |
Returns
| Type | Description |
|---|---|
| HSteamNetPollGroup | A |
explicit operator uint(HSteamNetPollGroup)
Converts a HSteamNetPollGroup to its underlying uint.
Declaration
public static explicit operator uint(HSteamNetPollGroup that)
Parameters
| Type | Name | Description |
|---|---|---|
| HSteamNetPollGroup | that | The handle to unwrap. |
Returns
| Type | Description |
|---|---|
| uint | The underlying |
operator !=(HSteamNetPollGroup, HSteamNetPollGroup)
Returns true when the operands hold different values.
Declaration
public static bool operator !=(HSteamNetPollGroup x, HSteamNetPollGroup y)
Parameters
| Type | Name | Description |
|---|---|---|
| HSteamNetPollGroup | x | The first value to compare. |
| HSteamNetPollGroup | y | The second value to compare. |
Returns
| Type | Description |
|---|---|
| bool | true when the two hold different underlying values. |