docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRCameraConfiguration

    Contains information regarding the camera configuration. Different devices support different camera configurations. This includes the resolution of the image and may include framerate on some platforms.

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

    Properties

    framerate

    The framerate, if this camera configuration specifies one.

    Declaration
    public readonly int? framerate { get; }
    Property Value
    Type Description
    Nullable<Int32>

    The framerate, if this camera configuration specifies one. Otherwise, null.

    Remarks

    On some platforms, different resolutions may affect the available framerate.

    height

    The height of the camera resolution

    Declaration
    public readonly int height { get; }
    Property Value
    Type Description
    Int32

    The height, in pixels, of the camera resolution

    resolution

    The camera resolution.

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

    The camera resolution in pixels.

    width

    The width of the camera resolution

    Declaration
    public readonly int width { get; }
    Property Value
    Type Description
    Int32

    The width, in pixels, of the camera resolution

    Methods

    Equals(System.Object)

    Declaration
    public override bool Equals(System.Object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    Boolean

    Equals(XRCameraConfiguration)

    Declaration
    public bool Equals(XRCameraConfiguration other)
    Parameters
    Type Name Description
    XRCameraConfiguration other
    Returns
    Type Description
    Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    ToString()

    Converts the configuration to a string, suitable for debug logging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Operators

    Equality(XRCameraConfiguration, XRCameraConfiguration)

    Declaration
    public static bool operator ==(XRCameraConfiguration lhs, XRCameraConfiguration rhs)
    Parameters
    Type Name Description
    XRCameraConfiguration lhs
    XRCameraConfiguration rhs
    Returns
    Type Description
    Boolean

    Inequality(XRCameraConfiguration, XRCameraConfiguration)

    Declaration
    public static bool operator !=(XRCameraConfiguration lhs, XRCameraConfiguration rhs)
    Parameters
    Type Name Description
    XRCameraConfiguration lhs
    XRCameraConfiguration rhs
    Returns
    Type Description
    Boolean
    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Friday, January 7, 2022
    Terms of use