docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRCpuImage.Cinfo

    Container for native camera image construction metadata.

    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public struct Cinfo : IEquatable<XRCpuImage.Cinfo>

    Constructors

    Cinfo(Int32, Vector2Int, Int32, Double, XRCpuImage.Format)

    Constructs the camera image cinfo.

    Declaration
    public Cinfo(int nativeHandle, Vector2Int dimensions, int planeCount, double timestamp, XRCpuImage.Format format)
    Parameters
    Type Name Description
    Int32 nativeHandle

    The handle representing the camera image on the native level.

    Vector2Int dimensions

    The dimensions of the camera image.

    Int32 planeCount

    The number of video planes in the camera image.

    Double timestamp

    The timestamp for when the camera image was captured.

    XRCpuImage.Format format

    The format of the camera image.

    Properties

    dimensions

    The dimensions of the camera image.

    Declaration
    public readonly Vector2Int dimensions { get; }
    Property Value
    Type Description
    Vector2Int

    The dimensions of the camera image.

    format

    The format of the camera image.

    Declaration
    public readonly XRCpuImage.Format format { get; }
    Property Value
    Type Description
    XRCpuImage.Format

    The format of the camera image.

    nativeHandle

    The handle representing the camera image on the native level.

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

    The handle representing the camera image on the native level.

    planeCount

    The number of video planes in the camera image.

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

    The number of video planes in the camera image.

    timestamp

    The timestamp for when the camera image was captured.

    Declaration
    public readonly double timestamp { get; }
    Property Value
    Type Description
    Double

    The timestamp for when the camera image was captured.

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

    Overrides
    ValueType.Equals(Object)

    Equals(XRCpuImage.Cinfo)

    Tests for equality.

    Declaration
    public bool Equals(XRCpuImage.Cinfo other)
    Parameters
    Type Name Description
    XRCpuImage.Cinfo other

    The other XRCpuImage.Cinfo to compare against.

    Returns
    Type Description
    Boolean

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

    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 object suitable for debugging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Returns a string representation of this XRCpuImage.Cinfo.

    Overrides
    ValueType.ToString()

    Operators

    Equality(XRCpuImage.Cinfo, XRCpuImage.Cinfo)

    Tests for equality. Same as Equals(XRCpuImage.Cinfo).

    Declaration
    public static bool operator ==(XRCpuImage.Cinfo lhs, XRCpuImage.Cinfo rhs)
    Parameters
    Type Name Description
    XRCpuImage.Cinfo lhs

    The XRCpuImage.Cinfo to compare with rhs.

    XRCpuImage.Cinfo rhs

    The XRCpuImage.Cinfo to compare with lhs.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRCpuImage.Cinfo, XRCpuImage.Cinfo)

    Tests for inequality. Same as !Equals(XRCpuImage.Cinfo).

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

    The XRCpuImage.Cinfo to compare with rhs.

    XRCpuImage.Cinfo rhs

    The XRCpuImage.Cinfo to compare with lhs.

    Returns
    Type Description
    Boolean

    True if lhs is not equal to rhs, otherwise false.

    Back to top
    Terms of use
    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