docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct XrSpatialReferenceImagePlaneEXT

    Describes a single plane of a reference image's pixel data. Provided by XR_EXT_spatial_image_tracking.

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.XR.OpenXR.NativeTypes
    Assembly: Unity.XR.OpenXR.dll
    Syntax
    public readonly struct XrSpatialReferenceImagePlaneEXT
    Remarks

    The buffer data must be supplied in a left-to-right and top-to-bottom pixel ordering by the application. Set rowStride and pixelStride such that only meaningful pixels of this plane are extracted by the runtime.

    Constructors

    XrSpatialReferenceImagePlaneEXT(uint, byte*, uint, uint)

    Construct an instance.

    Declaration
    public XrSpatialReferenceImagePlaneEXT(uint bufferSize, byte* buffer, uint rowStride, uint pixelStride)
    Parameters
    Type Name Description
    uint bufferSize

    The size of the buffer array. Must be greater than 0.

    byte* buffer

    An array of byte data representing the plane data. Must be non-null.

    uint rowStride

    The byte distance between two starting positions of consecutive pixel data rows.

    uint pixelStride

    The byte distance between two consecutive pixels.

    XrSpatialReferenceImagePlaneEXT(NativeArray<byte>, uint, uint)

    Construct an instance from a native array.

    Declaration
    public XrSpatialReferenceImagePlaneEXT(NativeArray<byte> buffer, uint rowStride, uint pixelStride)
    Parameters
    Type Name Description
    NativeArray<byte> buffer

    The plane data.

    uint rowStride

    The byte distance between two starting positions of consecutive pixel data rows.

    uint pixelStride

    The byte distance between two consecutive pixels.

    XrSpatialReferenceImagePlaneEXT(ReadOnly, uint, uint)

    Construct an instance from a read-only native array.

    Declaration
    public XrSpatialReferenceImagePlaneEXT(NativeArray<byte>.ReadOnly buffer, uint rowStride, uint pixelStride)
    Parameters
    Type Name Description
    NativeArray<byte>.ReadOnly buffer

    The plane data.

    uint rowStride

    The byte distance between two starting positions of consecutive pixel data rows.

    uint pixelStride

    The byte distance between two consecutive pixels.

    Properties

    buffer

    An array of byte data representing the plane data. Must be non-null.

    Declaration
    public byte* buffer { get; }
    Property Value
    Type Description
    byte*

    bufferSize

    The size of the buffer array. Must be greater than 0.

    Declaration
    public uint bufferSize { get; }
    Property Value
    Type Description
    uint

    pixelStride

    The byte distance between two consecutive pixels.

    Declaration
    public uint pixelStride { get; }
    Property Value
    Type Description
    uint

    rowStride

    The byte distance between two starting positions of consecutive pixel data rows.

    Declaration
    public uint rowStride { get; }
    Property Value
    Type Description
    uint
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)