Class PlatformProvider

The default implementation that defines the API for an PlatformProvider.

Inheritance

object

PlatformProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.XR.CompositionLayers.Provider

Assembly: Unity.XR.CompositionLayers.dll

Syntax

public abstract class PlatformProvider

Fields

DefaultCoordinateSystem

Default coordinate system string.

Declaration

public const string DefaultCoordinateSystem = "World"

Field Value

Type	Description
string

Properties

IsSupportedHDR

Supports HDR on the target platform.

Declaration

public virtual bool IsSupportedHDR { get; }

Property Value

Type	Description
bool

Remarks

This information is referenced from HDRTonemapping. If this value is false, HDRTonemapping is disabled on target platform.

IsSupportedUnderlayLayers

Supports underlay layers.

Declaration

public virtual bool IsSupportedUnderlayLayers { get; }

Property Value

Type	Description
bool

LayerProviderType

Supporting LayerProvider.

Declaration

public abstract Type LayerProviderType { get; }

Property Value

Type	Description
Type

PlatformLayerDataType

PlatformLayerData type. This property is null if it's unsupported.

Declaration

public virtual Type PlatformLayerDataType { get; }

Property Value

Type	Description
Type

SupportedBlendTypes

Supported BlendType values. null means all supported.

Declaration

public virtual BlendType[] SupportedBlendTypes { get; }

Property Value

Type	Description
BlendType[]

SupportedCoordinateSystems

Supported coordinate system names.

Declaration

public virtual string[] SupportedCoordinateSystems { get; }

Property Value

Type	Description
string[]

SupportedLayerDataTypes

Supported LayerData types. null means all supported.

Declaration

public virtual Type[] SupportedLayerDataTypes { get; }

Property Value

Type	Description
Type[]

XRLoaderType

Supporting XRLoader.

Declaration

public abstract Type XRLoaderType { get; }

Property Value

Type	Description
Type

Methods

GetCustomTransformData(CompositionLayer, CustomTransformCameraData)

Get custom transform data from the target layer.

Declaration

public virtual CustomTransformData GetCustomTransformData(CompositionLayer compositionLayer, CustomTransformCameraData cameraData)

Parameters

Type	Name	Description
CompositionLayer	compositionLayer	Target composition layer.
CustomTransformCameraData	cameraData	Camera data for custom transforming.

Returns

Type	Description
CustomTransformData	Custom transform data. It contains matrix and matrixType.

GetPreferredHDRParams()

Prefered HDR Params on the target platform. (Optional)

Declaration

public virtual PlatformProvider.HDRParams GetPreferredHDRParams()

Returns

Type	Description
PlatformProvider.HDRParams	New HDR parameters with default settings.

Remarks

This information is referenced from HDRTonemapping. This class can give hints to set proper settings.

GetSelectedCoordinateSystem(CompositionLayer)

Get selected coordinate system name for the target layer.

Declaration

public virtual string GetSelectedCoordinateSystem(CompositionLayer compositionLayer)

Parameters

Type	Name	Description
CompositionLayer	compositionLayer	Target composition layer.

Returns

Type	Description
string	Coordinate system name. This name matches any of the SupportedCoordinateSystems.

IsEnabledCustomTransform(CompositionLayer)

Check the target layer whether to use a custom transform.

Declaration

public virtual bool IsEnabledCustomTransform(CompositionLayer compositionLayer)

Parameters

Type	Name	Description
CompositionLayer	compositionLayer	Target composition layer.

Returns

Type	Description
bool	The flag whether custom transforming is supported.