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 frameReceived event.

    Inherited Members
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    public struct ARCameraFrameEventArgs : IEquatable<ARCameraFrameEventArgs>

    Properties

    cameraGrainTexture

    The camera grain texture effect.

    Declaration
    public Texture cameraGrainTexture { readonly get; }
    Property Value
    Type Description
    UnityEngine.Texture

    disabledMaterialKeywords

    The list of keywords to be disabled for the material.

    Declaration
    public List<string> disabledMaterialKeywords { readonly get; }
    Property Value
    Type Description
    List<String>

    displayMatrix

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

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

    enabledMaterialKeywords

    The list of keywords to be enabled for the material.

    Declaration
    public List<string> enabledMaterialKeywords { readonly get; }
    Property Value
    Type Description
    List<String>

    exposureDuration

    The exposure duration in seconds with sub-millisecond precision. Used in calculating motion blur.

    Declaration
    public double? exposureDuration { readonly get; set; }
    Property Value
    Type Description
    Nullable<Double>
    Remarks

    exposureDuration can be null if platform does not support exposure duration.

    exposureOffset

    The offset of camera exposure. Used to scale scene lighting in post-processed lighting stage.

    Declaration
    public float? exposureOffset { readonly get; set; }
    Property Value
    Type Description
    Nullable<Single>
    Remarks

    exposureOffset can be null if platform does not support exposure offset.

    lightEstimation

    The ARLightEstimationData associated with this frame.

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

    noiseIntensity

    The camera grain noise intensity.

    Declaration
    public float noiseIntensity { readonly get; }
    Property Value
    Type Description
    Single

    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<UnityEngine.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<UnityEngine.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)

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

    Overrides
    ValueType.Equals(Object)

    Equals(ARCameraFrameEventArgs)

    Tests for equality.

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

    The other ARCameraFrameEventArgs to compare against.

    Returns
    Type Description
    Boolean

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

    Implements
    IEquatable<T>.Equals(T)

    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 struct suitable for debug logging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string representation of this struct suitable for debug logging.

    Overrides
    ValueType.ToString()

    Operators

    Equality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

    Tests for equality. Same as Equals(ARCameraFrameEventArgs).

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

    The left-hand side of the comparison.

    ARCameraFrameEventArgs rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

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

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

    The left-hand side of the comparison.

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