Struct XRCameraConfiguration | AR Subsystems | 3.1.10
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 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 int height { get; }
    Property Value
    Type Description
    Int32

    The height, in pixels, of the camera resolution

    resolution

    The camera resolution.

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

    The camera resolution in pixels.

    width

    The width of the camera resolution

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

    The width, in pixels, of the camera resolution

    Methods

    Equals(Object)

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

    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
    Overrides
    ValueType.GetHashCode()

    ToString()

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

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    ValueType.ToString()

    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 © 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