Struct XRTextureDescriptor

Encapsulates a native texture object and includes various metadata about the texture.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XRTextureDescriptor : IEquatable<XRTextureDescriptor>

Properties

depth

This specifies the depth dimension of the native texture. For a 3D texture, depth would be greater than zero. For any other kind of valid texture, depth is one.

Declaration

public int depth { get; }

Property Value

Type	Description
Int32	The depth dimension of the native texture object.

dimension

Specifies the texture dimension of the native texture object.

Declaration

public TextureDimension dimension { get; }

Property Value

Type	Description
TextureDimension	The texture dimension of the native texture object.

format

Specifies the texture format of the native texture object.

Declaration

public TextureFormat format { get; }

Property Value

Type	Description
TextureFormat	The format of the native texture object.

height

Specifies the height dimension of the native texture object.

Declaration

public int height { get; }

Property Value

Type	Description
Int32	The height of the native texture object.

mipmapCount

Specifies the number of mipmap levels in the native texture object.

Declaration

public int mipmapCount { get; }

Property Value

Type	Description
Int32	The number of mipmap levels in the native texture object.

nativeTexture

A pointer to the native texture object.

Declaration

public IntPtr nativeTexture { get; }

Property Value

Type	Description
IntPtr	A pointer to the native texture object.

propertyNameId

Specifies the unique shader property name ID for the material shader texture.

Declaration

public int propertyNameId { get; }

Property Value

Type	Description
Int32	The unique shader property name ID for the material shader texture.

Remarks

Use the static method Shader.PropertyToID(string name) to get the unique identifier.

valid

Determines whether the texture data references a valid texture object with positive width and height.

Declaration

public readonly bool valid { get; }

Property Value

Type	Description
Boolean	true if the texture data references a valid texture object with positive width and height. Otherwise, false.

width

Specifies the width dimension of the native texture object.

Declaration

public int width { get; }

Property Value

Type	Description
Int32	The width of the native texture object.

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

Overrides

ValueType.Equals(Object)

Equals(XRTextureDescriptor)

Tests for equality.

Declaration

public bool Equals(XRTextureDescriptor other)

Parameters

Type	Name	Description
XRTextureDescriptor	other	The other XRTextureDescriptor to compare against.

Returns

Type	Description
Boolean	True if every field in other is equal to this XRTextureDescriptor, 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()

hasIdenticalTextureMetadata(XRTextureDescriptor)

Determines whether the given texture descriptor has identical texture metadata (dimension, mipmap count, and format).

Declaration

public bool hasIdenticalTextureMetadata(XRTextureDescriptor other)

Parameters

Type	Name	Description
XRTextureDescriptor	other	The given texture descriptor with which to compare.

Returns

Type	Description
Boolean	true if the texture metadata (dimension, mipmap count, and format) are identical between the current and other texture descriptors. Otherwise, false.

Reset()

Reset the texture descriptor back to default values.

Declaration

public void Reset()

ToString()

Generates a string suitable for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
String	A string suitable for debug logging.

Overrides

ValueType.ToString()

Operators

Equality(XRTextureDescriptor, XRTextureDescriptor)

Tests for equality. Same as Equals(XRTextureDescriptor).

Declaration

public static bool operator ==(XRTextureDescriptor lhs, XRTextureDescriptor rhs)

Parameters

Type	Name	Description
XRTextureDescriptor	lhs	The left-hand side of the comparison.
XRTextureDescriptor	rhs	The right-hand side of the comparison.

Returns

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

Inequality(XRTextureDescriptor, XRTextureDescriptor)

Tests for inequality. Same as !Equals(XRTextureDescriptor).

Declaration

public static bool operator !=(XRTextureDescriptor lhs, XRTextureDescriptor rhs)

Parameters

Type	Name	Description
XRTextureDescriptor	lhs	The left-hand side of the comparison.
XRTextureDescriptor	rhs	The right-hand side of the comparison.

Returns

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