Struct XRSessionUpdateParams

Update parameters for Update(XRSessionUpdateParams).

Namespace: UnityEngine.XR.ARSubsystems
Syntax
public struct XRSessionUpdateParams : IEquatable<XRSessionUpdateParams>

Properties

screenDimensions

The current screen dimensions.

Declaration
public Vector2Int screenDimensions { readonly get; set; }
Property Value
Type Description
Vector2Int

screenOrientation

The current screen orientation

Declaration
public ScreenOrientation screenOrientation { readonly get; set; }
Property Value
Type Description
ScreenOrientation

Methods

Equals(Object)

Compares for equality.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The object to compare against.
Returns
Type Description
Boolean

true if obj is of type XRSessionUpdateParams and Equals(XRSessionUpdateParams) is true.
Overrides

Equals(XRSessionUpdateParams)

Compares for equality.

Declaration
public bool Equals(XRSessionUpdateParams other)
Parameters
Type Name Description
XRSessionUpdateParams other

The other XRSessionUpdateParams to compare against.
Returns
Type Description
Boolean

true if the other XRSessionUpdateParams is equal to this one.

GetHashCode()

Generates a hash code suitable for use in a Dictionary or HashSet.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

A hash code of this XRSessionUpdateParams.
Overrides

ToString()

Generates a string suitable for debugging.

Declaration
public override string ToString()
Returns
Type Description
String

A string representation of the update parameters.
Overrides

Operators

Equality(XRSessionUpdateParams, XRSessionUpdateParams)

Compares for equality.

Declaration
public static bool operator ==(XRSessionUpdateParams lhs, XRSessionUpdateParams rhs)
Parameters
Type Name Description
XRSessionUpdateParams lhs

The left-hand side of the comparison.
XRSessionUpdateParams rhs

The right-hand side of the comparison.
Returns
Type Description
Boolean

The same as Equals(XRSessionUpdateParams).

Inequality(XRSessionUpdateParams, XRSessionUpdateParams)

Compares for inequality.

Declaration
public static bool operator !=(XRSessionUpdateParams lhs, XRSessionUpdateParams rhs)
Parameters
Type Name Description
XRSessionUpdateParams lhs

The left-hand side of the comparison.
XRSessionUpdateParams rhs

The right-hand side of the comparison.
Returns
Type Description
Boolean

The negation of Equals(XRSessionUpdateParams).