docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRCpuImage.Plane.Cinfo

    Container for the metadata that describes access to the raw camera image plane data.

    Inherited Members
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public struct Cinfo : IEquatable<XRCpuImage.Plane.Cinfo>

    Constructors

    Cinfo(IntPtr, Int32, Int32, Int32)

    Constructs the camera image plane cinfo.

    Declaration
    public Cinfo(IntPtr dataPtr, int dataLength, int rowStride, int pixelStride)
    Parameters
    Type Name Description
    IntPtr dataPtr

    The pointer to the raw native image data.

    Int32 dataLength

    The length of the native image data.

    Int32 rowStride

    The stride for iterating through the rows of the native image data.

    Int32 pixelStride

    The stride for iterating through the pixels of the native image data.

    Properties

    dataLength

    The length of the native image data.

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

    The length of the native image data.

    dataPtr

    The pointer to the raw native image data.

    Declaration
    public readonly IntPtr dataPtr { get; }
    Property Value
    Type Description
    IntPtr

    The pointer to the raw native image data.

    pixelStride

    The stride for iterating through the pixels of the native image data.

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

    The stride for iterating through the pixels of the native image data.

    rowStride

    The stride for iterating through the rows of the native image data.

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

    The stride for iterating through the rows of the native image data.

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

    Overrides
    ValueType.Equals(Object)

    Equals(XRCpuImage.Plane.Cinfo)

    Tests for equality.

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

    The other XRCpuImage.Plane.Cinfo to compare against.

    Returns
    Type Description
    Boolean

    True if every field in other is equal to this XRCpuImage.Plane.Cinfo, 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 suitable for debugging.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string representation of this XRCpuImage.Plane.Cinfo.

    Overrides
    ValueType.ToString()

    Operators

    Equality(XRCpuImage.Plane.Cinfo, XRCpuImage.Plane.Cinfo)

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

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

    The left-hand side of the comparison.

    XRCpuImage.Plane.Cinfo rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRCpuImage.Plane.Cinfo, XRCpuImage.Plane.Cinfo)

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

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

    The left-hand side of the comparison.

    XRCpuImage.Plane.Cinfo 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