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 { readonly get; set; }
    Property Value
    Type Description
    Nullable<Matrix4x4>

    lightEstimation

    The associated with this frame.

    Declaration
    public ARLightEstimationData lightEstimation { readonly 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 { readonly get; set; }
    Property Value
    Type Description
    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 { readonly get; set; }
    Property Value
    Type Description
    List<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 { readonly get; set; }
    Property Value
    Type Description
    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 { readonly get; set; }
    Property Value
    Type Description
    Nullable<Int64>

    Methods

    Equals(Object)

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

    Equals(ARCameraFrameEventArgs)

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

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    ToString()

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

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string representation of this struct suitable for debug logging.

    Operators

    Equality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

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

    Inequality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

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