Struct ScreenshotHandle

Wraps the Steamworks ScreenshotHandle handle, a uint.

Implements

IEquatable<ScreenshotHandle>

IComparable<ScreenshotHandle>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

[Serializable]
public struct ScreenshotHandle : IEquatable<ScreenshotHandle>, IComparable<ScreenshotHandle>

Constructors

ScreenshotHandle(uint)

Initializes a new ScreenshotHandle from its underlying value.

Declaration

public ScreenshotHandle(uint value)

Parameters

Type	Name	Description
uint	value	The underlying uint value.

Fields

Invalid

The value the SDK reserves to mean "no ScreenshotHandle".

Declaration

public static readonly ScreenshotHandle Invalid

Field Value

Type	Description
ScreenshotHandle

m_ScreenshotHandle

The underlying uint value.

Declaration

public uint m_ScreenshotHandle

Field Value

Type	Description
uint

Methods

CompareTo(ScreenshotHandle)

Orders this value against other by their underlying values.

Declaration

public int CompareTo(ScreenshotHandle other)

Parameters

Type	Name	Description
ScreenshotHandle	other	The value to compare against.

Returns

Type	Description
int	Negative, zero or positive as this value sorts before, with or after other.

Equals(object)

Returns true when other is a ScreenshotHandle 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 other is a ScreenshotHandle holding the same value.

Overrides

ValueType.Equals(object)

Equals(ScreenshotHandle)

Returns true when this value equals other.

Declaration

public bool Equals(ScreenshotHandle other)

Parameters

Type	Name	Description
ScreenshotHandle	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

ValueType.GetHashCode()

ToString()

Returns the underlying value as a string.

Declaration

public override string ToString()

Returns

Type	Description
string	The underlying value formatted by its own ToString.

Overrides

ValueType.ToString()

Operators

operator ==(ScreenshotHandle, ScreenshotHandle)

Returns true when both operands hold the same value.

Declaration

public static bool operator ==(ScreenshotHandle x, ScreenshotHandle y)

Parameters

Type	Name	Description
ScreenshotHandle	x	The first value to compare.
ScreenshotHandle	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold the same underlying value.

explicit operator ScreenshotHandle(uint)

Converts a uint to a ScreenshotHandle. Explicit, so two handle types cannot convert into each other through the type they share.

Declaration

public static explicit operator ScreenshotHandle(uint value)

Parameters

Type	Name	Description
uint	value	The underlying uint value.

Returns

Type	Description
ScreenshotHandle	A ScreenshotHandle holding value.

explicit operator uint(ScreenshotHandle)

Converts a ScreenshotHandle to its underlying uint.

Declaration

public static explicit operator uint(ScreenshotHandle that)

Parameters

Type	Name	Description
ScreenshotHandle	that	The handle to unwrap.

Returns

Type	Description
uint	The underlying uint value.

operator !=(ScreenshotHandle, ScreenshotHandle)

Returns true when the operands hold different values.

Declaration

public static bool operator !=(ScreenshotHandle x, ScreenshotHandle y)

Parameters

Type	Name	Description
ScreenshotHandle	x	The first value to compare.
ScreenshotHandle	y	The second value to compare.

Returns

Type	Description
bool	true when the two hold different underlying values.

Implements

IEquatable<T>

IComparable<T>