Struct XRCpuImage.Plane
Information about the camera image planes. An image plane refers to an image channel used in video encoding.
Implements
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRCpuImage.Plane : IEquatable<XRCpuImage.Plane>
Constructors
Plane(int, int, NativeArray<byte>)
Constructs an XRCpuImage.Plane.
Declaration
public Plane(int rowStride, int pixelStride, NativeArray<byte> data)
Parameters
Type | Name | Description |
---|---|---|
int | rowStride | The number of bytes per row for this plane. |
int | 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 readonly NativeArray<byte> data { get; }
Property Value
Type | Description |
---|---|
NativeArray<byte> | The platform-specific plane data. |
pixelStride
The number of bytes per pixel for this plane.
Declaration
public readonly int pixelStride { get; }
Property Value
Type | Description |
---|---|
int | The number of bytes per pixel for this plane. |
rowStride
The number of bytes per row for this plane.
Declaration
public readonly int rowStride { get; }
Property Value
Type | Description |
---|---|
int | 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 |
Returns
Type | Description |
---|---|
bool |
|
Overrides
Equals(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 |
---|---|
bool |
|
GetHashCode()
Generates a hash suitable for use with containers like HashSet
and Dictionary
.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | A hash code generated from this object's fields. |
Overrides
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
Operators
operator ==(Plane, Plane)
Tests for equality. Same as Equals(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 |
XRCpuImage.Plane | rhs | The XRCpuImage.Plane to compare with |
Returns
Type | Description |
---|---|
bool |
|
operator !=(Plane, Plane)
Tests for inequality. Same as !
Equals(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 |
XRCpuImage.Plane | rhs | The XRCpuImage.Plane to compare with |
Returns
Type | Description |
---|---|
bool |
|