Struct ARCameraFrameEventArgs | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct ARCameraFrameEventArgs

    A structure for camera-related information pertaining to a particular frame. This is used to communicate information in the event.

    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    public struct ARCameraFrameEventArgs : IEquatable<ARCameraFrameEventArgs>

    Properties

    displayMatrix

    Gets or sets the display matrix for use in the shader used by the ARFoundationBackgroundRenderer. Use displayMatrix.HasValue to determine if this data is available.

    Declaration
    public Matrix4x4? displayMatrix { get; set; }
    Property Value
    Type Description
    System.Nullable<Matrix4x4>

    lightEstimation

    The associated with this frame.

    Declaration
    public ARLightEstimationData lightEstimation { get; set; }
    Property Value
    Type Description
    ARLightEstimationData

    projectionMatrix

    Gets or sets the projection matrix for the AR Camera. Use projectionMatrix.HasValue to determine if this data is available.

    Declaration
    public Matrix4x4? projectionMatrix { get; set; }
    Property Value
    Type Description
    System.Nullable<Matrix4x4>

    propertyNameIds

    Ids of the property name associated with each texture. This is a parallel List to the textures list.

    Declaration
    public List<int> propertyNameIds { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<System.Int32>

    textures

    The textures associated with this camera frame. These are generally external textures, which exist only on the GPU. To use them on the CPU, e.g., for computer vision processing, you will need to read them back from the GPU.

    Declaration
    public List<Texture2D> textures { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<Texture2D>

    timestampNs

    The time, in nanoseconds, associated with this frame. Use timestampNs.HasValue to determine if this data is available.

    Declaration
    public long? timestampNs { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Int64>

    Methods

    Equals(Object)

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

    Equals(ARCameraFrameEventArgs)

    Declaration
    public bool Equals(ARCameraFrameEventArgs other)
    Parameters
    Type Name Description
    ARCameraFrameEventArgs other
    Returns
    Type Description
    System.Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    ToString()

    Generates a string representation of this struct suitable for debug logging.

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

    A string representation of this struct suitable for debug logging.

    Overrides
    System.ValueType.ToString()

    Operators

    Equality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

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

    Inequality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

    Declaration
    public static bool operator !=(ARCameraFrameEventArgs lhs, ARCameraFrameEventArgs rhs)
    Parameters
    Type Name Description
    ARCameraFrameEventArgs lhs
    ARCameraFrameEventArgs rhs
    Returns
    Type Description
    System.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