Struct XRCpuImage.Plane

Information about the camera image planes. An image "plane" refers to an image channel used in video encoding.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct Plane : IEquatable<XRCpuImage.Plane>

Constructors

Plane(Int32, Int32, NativeArray<Byte>)

Constructs an XRCpuImage.Plane.

Declaration

public Plane(int rowStride, int pixelStride, NativeArray<byte> data)

Parameters

Type	Name	Description
Int32	rowStride	The number of bytes per row for this plane.
Int32	pixelStride	The number of bytes per pixel for this plane.
NativeArray<Byte>	data	The platform-specific plane data.

Properties

data

A "view" into the platform-specific plane data. It is an error to access data after the owning XRCpuImage has been disposed.

Declaration

public NativeArray<byte> data { readonly get; }

Property Value

Type	Description
NativeArray<Byte>	The platform-specific plane data.

pixelStride

The number of bytes per pixel for this plane.

Declaration

public int pixelStride { readonly get; }

Property Value

Type	Description
Int32	The number of bytes per pixel for this plane.

rowStride

The number of bytes per row for this plane.

Declaration

public int rowStride { readonly get; }

Property Value

Type	Description
Int32	The number of bytes per row for this plane.

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

Overrides

ValueType.Equals(Object)

Equals(XRCpuImage.Plane)

Tests for equality.

Declaration

public bool Equals(XRCpuImage.Plane other)

Parameters

Type	Name	Description
XRCpuImage.Plane	other	The other XRCpuImage.Plane to compare against.

Returns

Type	Description
Boolean	True if every field in other is equal to this XRCpuImage.Plane, 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 XRCpuImage.Plane.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of this XRCpuImage.Plane.

Overrides

ValueType.ToString()

Operators

Equality(XRCpuImage.Plane, XRCpuImage.Plane)

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

Declaration

public static bool operator ==(XRCpuImage.Plane lhs, XRCpuImage.Plane rhs)

Parameters

Type	Name	Description
XRCpuImage.Plane	lhs	The XRCpuImage.Plane to compare with rhs.
XRCpuImage.Plane	rhs	The XRCpuImage.Plane to compare with lhs.

Returns

Type	Description
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(XRCpuImage.Plane, XRCpuImage.Plane)

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

Declaration

public static bool operator !=(XRCpuImage.Plane lhs, XRCpuImage.Plane rhs)

Parameters

Type	Name	Description
XRCpuImage.Plane	lhs	The XRCpuImage.Plane to compare with rhs.
XRCpuImage.Plane	rhs	The XRCpuImage.Plane to compare with lhs.

Returns

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