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

    Struct AsyncCameraImageConversion

    Holds information related to an asynchronous camera image conversion request. Returned by ConvertAsync(CameraImageConversionParams).

    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.XR.ARExtensions
    Syntax
    public struct AsyncCameraImageConversion : IDisposable, IEquatable<AsyncCameraImageConversion>

    Properties

    conversionParams

    The CameraImageConversionParams used during the conversion.

    Declaration
    public CameraImageConversionParams conversionParams { get; }
    Property Value
    Type Description
    CameraImageConversionParams

    status

    The status of the request.

    Declaration
    public AsyncCameraImageConversionStatus status { get; }
    Property Value
    Type Description
    AsyncCameraImageConversionStatus

    Methods

    Dispose()

    Dispose native resources associated with this request, including the raw image data. The NativeArray returned by GetData<T>() is invalidated immediately after calling Dispose.

    Declaration
    public void Dispose()

    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(AsyncCameraImageConversion)

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

    GetData<T>()

    Get the raw image data. The returned NativeArray is a direct "view" into the native memory. The memory is only valid until this AsyncCameraImageConversion is disposed.

    You should only call this method when status is equal to Ready. This method throws otherwise.

    Declaration
    public NativeArray<T> GetData<T>()where T : struct
    Returns
    Type Description
    NativeArray<T>

    A new NativeArray representing the raw image data. This method may fail; use NativeArray.IsCreated to determine the validity of the data.

    Type Parameters
    Name Description
    T

    The type of data to return. No conversion is performed based on the type; this is merely for access convenience.

    GetHashCode()

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

    ToString()

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

    Operators

    Equality(AsyncCameraImageConversion, AsyncCameraImageConversion)

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

    Inequality(AsyncCameraImageConversion, AsyncCameraImageConversion)

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