Class CompositionLayer
Inheritance
Object
Component
Behaviour
MonoBehaviour
CompositionLayer
Assembly: VIVE.OpenXR.dll
Syntax
public class CompositionLayer : MonoBehaviour
Fields
CylinderUnderlayMeshName
Declaration
public const string CylinderUnderlayMeshName = "Underlay Alpha Mesh (Cylinder)"
Field Value
FallbackMeshName
Declaration
public const string FallbackMeshName = "FallbackMeshGO"
Field Value
QuadUnderlayMeshName
Declaration
public const string QuadUnderlayMeshName = "Underlay Alpha Mesh (Quad)"
Field Value
angleOfArcLowerLimit
Declaration
public readonly float angleOfArcLowerLimit
Field Value
angleOfArcUpperLimit
Declaration
public readonly float angleOfArcUpperLimit
Field Value
applyColorScaleBias
Declaration
[SerializeField]
public bool applyColorScaleBias
Field Value
colorBias
Declaration
[SerializeField]
public Color colorBias
Field Value
colorScale
Declaration
[SerializeField]
public Color colorScale
Field Value
compositionDepth
Declaration
[SerializeField]
public uint compositionDepth
Field Value
customRects
Declaration
[SerializeField]
public CompositionLayer.CustomRectsType customRects
Field Value
externalSurfaceHeight
Declaration
[Tooltip("Height of external surface in pixels.")]
[SerializeField]
public uint externalSurfaceHeight
Field Value
externalSurfaceWidth
Declaration
[Tooltip("Width of external surface in pixels.")]
[SerializeField]
public uint externalSurfaceWidth
Field Value
generatedFallbackMesh
Declaration
public GameObject generatedFallbackMesh
Field Value
Type |
Description |
GameObject |
|
generatedUnderlayMesh
Declaration
public GameObject generatedUnderlayMesh
Field Value
Type |
Description |
GameObject |
|
isCustomRects
Declaration
[SerializeField]
public bool isCustomRects
Field Value
isDynamicLayer
Declaration
[SerializeField]
public bool isDynamicLayer
Field Value
isExternalSurface
Declaration
[SerializeField]
public bool isExternalSurface
Field Value
isProtectedSurface
Declaration
[SerializeField]
public bool isProtectedSurface
Field Value
layerShape
Declaration
[SerializeField]
public CompositionLayer.LayerShape layerShape
Field Value
layerType
Declaration
[SerializeField]
public CompositionLayer.LayerType layerType
Field Value
layerVisibility
Declaration
[SerializeField]
public CompositionLayer.Visibility layerVisibility
Field Value
solidEffect
Declaration
[SerializeField]
public bool solidEffect
Field Value
texture
Declaration
Field Value
textureRight
Declaration
public Texture textureRight
Field Value
trackingOrigin
Declaration
[SerializeField]
public GameObject trackingOrigin
Field Value
Type |
Description |
GameObject |
|
Properties
cylinderAngleOfArc
Declaration
public float cylinderAngleOfArc { get; }
Property Value
cylinderArcLength
Declaration
public float cylinderArcLength { get; }
Property Value
cylinderHeight
Declaration
public float cylinderHeight { get; }
Property Value
cylinderRadius
Declaration
public float cylinderRadius { get; }
Property Value
isRenderPriorityChanged
Declaration
public bool isRenderPriorityChanged { get; }
Property Value
quadHeight
Declaration
public float quadHeight { get; }
Property Value
quadWidth
Declaration
public float quadWidth { get; }
Property Value
textureLeft
Declaration
public Texture textureLeft { get; }
Property Value
Methods
AutoFallbackMeshGeneration()
Declaration
public void AutoFallbackMeshGeneration()
AutoFallbackMeshUpdate()
Declaration
public void AutoFallbackMeshUpdate()
ChangeBlitShadermode(BlitShaderMode, bool)
Declaration
public void ChangeBlitShadermode(CompositionLayer.BlitShaderMode shaderMode, bool enable)
Parameters
FallbackMeshIsValid()
Declaration
public bool FallbackMeshIsValid()
Returns
GetExternalSurfaceObj()
Declaration
public IntPtr GetExternalSurfaceObj()
Returns
Declaration
public Vector3 GetNormalizedLocalScale(Transform targetTransform, Vector3 targetGlobalScale)
Parameters
Type |
Name |
Description |
Transform |
targetTransform |
|
Vector3 |
targetGlobalScale |
|
Returns
GetRenderPriority()
Declaration
public uint GetRenderPriority()
Returns
LayerDimensionsChanged()
Declaration
public bool LayerDimensionsChanged()
Returns
RenderAsLayer()
Declaration
public bool RenderAsLayer()
Returns
RenderInGame()
Declaration
public void RenderInGame()
SetCylinderLayerArcAngleAndArcLength(float, float)
Use this function to update the arc angle and arc length of a Cylinder Layer.
A new radius will be calculated automatically.
Declaration
public bool SetCylinderLayerArcAngleAndArcLength(float inArcAngle, float inArcLength)
Parameters
Type |
Name |
Description |
float |
inArcAngle |
|
float |
inArcLength |
|
Returns
Type |
Description |
bool |
True if the parameters are valid and successfully updated.
|
SetCylinderLayerHeight(float)
Use this function to update the height of a Cylinder Layer.
Declaration
public bool SetCylinderLayerHeight(float inHeight)
Parameters
Type |
Name |
Description |
float |
inHeight |
|
Returns
SetCylinderLayerRadiusAndArcAngle(float, float)
Use this function to update the radius and arc angle of a Cylinder Layer.
A new arc length will be calculated automatically.
Declaration
public bool SetCylinderLayerRadiusAndArcAngle(float inRadius, float inArcAngle)
Parameters
Type |
Name |
Description |
float |
inRadius |
|
float |
inArcAngle |
|
Returns
Type |
Description |
bool |
True if the parameters are valid and successfully updated.
|
SetCylinderLayerRadiusAndArcLength(float, float)
Use this function to update the radius and arc length of a Cylinder Layer.
A new arc angle will be calculated automatically.
Declaration
public bool SetCylinderLayerRadiusAndArcLength(float inRadius, float inArcLength)
Parameters
Type |
Name |
Description |
float |
inRadius |
|
float |
inArcLength |
|
Returns
Type |
Description |
bool |
True if the parameters are valid and successfully updated.
|
SetQuadLayerHeight(float)
Use this function to update the height of a Quad Layer.
Declaration
public bool SetQuadLayerHeight(float inHeight)
Parameters
Type |
Name |
Description |
float |
inHeight |
|
Returns
SetQuadLayerWidth(float)
Use this function to update the width of a Quad Layer.
Declaration
public bool SetQuadLayerWidth(float inWidth)
Parameters
Type |
Name |
Description |
float |
inWidth |
|
Returns
SetRenderPriority(uint)
Declaration
public void SetRenderPriority(uint newRenderPriority)
Parameters
Type |
Name |
Description |
uint |
newRenderPriority |
|
TerminateLayer()
Declaration
public void TerminateLayer()
TextureParamsChanged()
Declaration
public bool TextureParamsChanged()
Returns
UnderlayMeshGeneration()
Declaration
public void UnderlayMeshGeneration()
UnderlayMeshIsValid()
Declaration
public bool UnderlayMeshIsValid()
Returns
UnderlayMeshUpdate()
Declaration
public void UnderlayMeshUpdate()
Events
OnDestroyCompositionLayerDelegate
Declaration
public event CompositionLayer.OnDestroyCompositionLayer OnDestroyCompositionLayerDelegate
Event Type