Struct CameraImageConversionParams

Describes a set of conversion parameters for use with CameraImage's conversion methods.

Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Namespace: UnityEngine.XR.ARExtensions
Syntax
public struct CameraImageConversionParams : IEquatable<CameraImageConversionParams>

Constructors

CameraImageConversionParams(CameraImage, TextureFormat, CameraImageTransformation)

Constructs a CameraImageConversionParams using the image's full resolution. That is, it sets inputRect to (0, 0, image.width, image.height) and outputDimensions to (image.width, image.height).

Declaration
public CameraImageConversionParams(CameraImage image, TextureFormat format, CameraImageTransformation transformation = CameraImageTransformation.None)
Parameters
Type Name Description
CameraImage image

The source CameraImage.
TextureFormat format

The TextureFormat to convert to.
CameraImageTransformation transformation

An CameraImageTransformation to apply (optional).

Properties

inputRect

The portion of the original image that will be converted to . The input rectangle must be completely contained inside the CameraImage's dimensions.

Declaration
public RectInt inputRect { get; set; }
Property Value
Type Description
RectInt

outputDimensions

The dimensions of the converted image. The dimensions must be less than or equal to the inputRect's width and height. If the dimensions are less than the inputRect's width and height, downsampling is performed using nearest neighbor.

Declaration
public Vector2Int outputDimensions { get; set; }
Property Value
Type Description
Vector2Int

outputFormat

The TextureFormat to convert to. See FormatSupported(TextureFormat) for a list of supported formats.

Declaration
public TextureFormat outputFormat { get; set; }
Property Value
Type Description
TextureFormat

transformation

The transformation to apply to the image during conversion.

Declaration
public CameraImageTransformation transformation { get; set; }
Property Value
Type Description
CameraImageTransformation

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)

Equals(CameraImageConversionParams)

Declaration
public bool Equals(CameraImageConversionParams other)
Parameters
Type Name Description
CameraImageConversionParams other
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()

Operators

Equality(CameraImageConversionParams, CameraImageConversionParams)

Declaration
public static bool operator ==(CameraImageConversionParams lhs, CameraImageConversionParams rhs)
Parameters
Type Name Description
CameraImageConversionParams lhs
CameraImageConversionParams rhs
Returns
Type Description
System.Boolean

Inequality(CameraImageConversionParams, CameraImageConversionParams)

Declaration
public static bool operator !=(CameraImageConversionParams lhs, CameraImageConversionParams rhs)
Parameters
Type Name Description
CameraImageConversionParams lhs
CameraImageConversionParams rhs
Returns
Type Description
System.Boolean