docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRCameraParams

    Parameters of the Unity Camera that may be necessary/useful to the provider.

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

    Properties

    screenHeight

    Height, in pixels, of the screen resolution.

    Declaration
    public float screenHeight { get; set; }
    Property Value
    Type Description
    Single

    Height, in pixels, of the screen resolution.

    screenOrientation

    The orientation of the screen.

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

    The orientation of the screen.

    screenWidth

    Width, in pixels, of the screen resolution.

    Declaration
    public float screenWidth { get; set; }
    Property Value
    Type Description
    Single

    Width, in pixels, of the screen resolution.

    zFar

    Distance from the camera to the far plane.

    Declaration
    public float zFar { get; set; }
    Property Value
    Type Description
    Single

    Distance from the camera to the far plane.

    zNear

    Distance from the camera to the near plane.

    Declaration
    public float zNear { get; set; }
    Property Value
    Type Description
    Single

    Distance from the camera to the near plane.

    Methods

    Equals(Object)

    Tests 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 XRCameraParams and Equals(XRCameraParams) also returns true; otherwise false.

    Overrides
    ValueType.Equals(Object)

    Equals(XRCameraParams)

    Tests for equality.

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

    The other XRCameraParams to compare against.

    Returns
    Type Description
    Boolean

    True if every field in other is equal to this XRCameraParams, otherwise false.

    GetHashCode()

    Generates a hash suitable for use with containers like HashSet and Dictionary.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    A hash code generated from this object's fields.

    Overrides
    ValueType.GetHashCode()

    ToString()

    Generates a string representation of this XRCameraParams.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string representation of this XRCameraParams.

    Overrides
    ValueType.ToString()

    Operators

    Equality(XRCameraParams, XRCameraParams)

    Tests for equality. Same as Equals(XRCameraParams).

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

    The left-hand side of the comparison.

    XRCameraParams rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRCameraParams, XRCameraParams)

    Tests for inequality. Same as !Equals(XRCameraParams).

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

    The left-hand side of the comparison.

    XRCameraParams rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is not equal to rhs, otherwise false.

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023