Class ViveCompositionLayer

Inheritance

object

Object

ScriptableObject

OpenXRFeature

ViveCompositionLayer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VIVE.OpenXR.CompositionLayer

Assembly: VIVE.OpenXR.dll

Syntax

public class ViveCompositionLayer : OpenXRFeature

Fields

enableAutoFallback

Enable auto fallback or Not.

Declaration

public bool enableAutoFallback

Field Value

Type	Description
bool

featureId

The feature id string. This is used to give the feature a well known id for reference.

Declaration

public const string featureId = "vive.openxr.feature.compositionlayer"

Field Value

Type	Description
string

kOpenxrExtensionStrings

Declaration

public const string kOpenxrExtensionStrings = ""

Field Value

Type	Description
string

Properties

HeadLockSpace

The XrSpace of head lock space.

Declaration

public XrSpace HeadLockSpace { get; }

Property Value

Type	Description
XrSpace

WorldLockSpaceOriginOnFloor

The XrSpace of world lock space origin on floor.

Declaration

public XrSpace WorldLockSpaceOriginOnFloor { get; }

Property Value

Type	Description
XrSpace

WorldLockSpaceOriginOnHead

The XrSpace of world lock space origin on head.

Declaration

public XrSpace WorldLockSpaceOriginOnHead { get; }

Property Value

Type	Description
XrSpace

XrInstanceCreated

The XR instance is created or not.

Declaration

public bool XrInstanceCreated { get; }

Property Value

Type	Description
bool

XrSessionCreated

The XR session is created or not.

Declaration

public bool XrSessionCreated { get; }

Property Value

Type	Description
bool

XrSessionCurrentState

The current XR Session state.

Declaration

public XrSessionState XrSessionCurrentState { get; }

Property Value

Type	Description
XrSessionState

XrSessionEnding

The XR session is ending or not.

Declaration

public bool XrSessionEnding { get; }

Property Value

Type	Description
bool

Methods

CompositionLayer_Destroy(int)

destroy composition layer.

Declaration

public bool CompositionLayer_Destroy(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
bool

CompositionLayer_GetFuncAddrs(XrInstance, IntPtr)

get function address of composition layer.

Declaration

public XrResult CompositionLayer_GetFuncAddrs(XrInstance xrInstance, IntPtr xrGetInstanceProcAddrFuncPtr)

Parameters

Type	Name	Description
XrInstance	xrInstance
IntPtr	xrGetInstanceProcAddrFuncPtr

Returns

Type	Description
XrResult

CompositionLayer_GetTexture(int, out uint)

Get composition layer texture.

Declaration

public IntPtr CompositionLayer_GetTexture(int layerID, out uint imageIndex)

Parameters

Type	Name	Description
int	layerID
uint	imageIndex

Returns

Type	Description
IntPtr

CompositionLayer_Init(uint, uint, GraphicsAPI, bool, bool, out uint, bool)

Init composion layer.

Declaration

public int CompositionLayer_Init(uint textureWidth, uint textureHeight, GraphicsAPI graphicsAPI, bool isDynamic, bool isProtected, out uint imageCount, bool isExternal = false)

Parameters

Type	Name	Description
uint	textureWidth
uint	textureHeight
GraphicsAPI	graphicsAPI
bool	isDynamic
bool	isProtected
uint	imageCount
bool	isExternal

Returns

Type	Description
int

CompositionLayer_ReleaseTexture(int)

release composition layer texture.

Declaration

public bool CompositionLayer_ReleaseTexture(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
bool

Compositionlayer_GetExternalSurfaceObj()

Declaration

public IntPtr Compositionlayer_GetExternalSurfaceObj()

Returns

Type	Description
IntPtr

Compositionlayer_GetExternalSurfaceObj2(int)

Declaration

public IntPtr Compositionlayer_GetExternalSurfaceObj2(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
IntPtr

CreateReferenceSpace(ref XrReferenceSpaceCreateInfo, out XrSpace)

Creates a reference space See xrCreateReferenceSpace

Declaration

public XrResult CreateReferenceSpace(ref XrReferenceSpaceCreateInfo createInfo, out XrSpace space)

Parameters

Type	Name	Description
XrReferenceSpaceCreateInfo	createInfo
XrSpace	space

Returns

Type	Description
XrResult

DestroySpace(XrSpace)

Destroys an XrSpace See xrDestroySpace

Declaration

public XrResult DestroySpace(XrSpace space)

Parameters

Type	Name	Description
XrSpace	space

Returns

Type	Description
XrResult

EnumerateReferenceSpaces(uint, out uint, out XrReferenceSpaceType)

Enumerate available reference spaces See xrEnumerateReferenceSpaces

Declaration

public XrResult EnumerateReferenceSpaces(uint spaceCapacityInput, out uint spaceCountOutput, out XrReferenceSpaceType spaces)

Parameters

Type	Name	Description
uint	spaceCapacityInput
uint	spaceCountOutput
XrReferenceSpaceType	spaces

Returns

Type	Description
XrResult

GetSystemProperties(ref XrSystemProperties)

Helper function to get this feature' properties. See xrGetSystemProperties

Declaration

public XrResult GetSystemProperties(ref XrSystemProperties properties)

Parameters

Type	Name	Description
XrSystemProperties	properties

Returns

Type	Description
XrResult

HookGetInstanceProcAddr(IntPtr)

Declaration

protected override IntPtr HookGetInstanceProcAddr(IntPtr func)

Parameters

Type	Name	Description
IntPtr	func

Returns

Type	Description
IntPtr

Overrides

OpenXRFeature.HookGetInstanceProcAddr(IntPtr)

OnInstanceCreate(ulong)

Declaration

protected override bool OnInstanceCreate(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance

Returns

Type	Description
bool

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

OnInstanceDestroy(ulong)

Declaration

protected override void OnInstanceDestroy(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance

Overrides

OpenXRFeature.OnInstanceDestroy(ulong)

OnSessionBegin(ulong)

Declaration

protected override void OnSessionBegin(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionBegin(ulong)

OnSessionCreate(ulong)

Declaration

protected override void OnSessionCreate(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionCreate(ulong)

OnSessionDestroy(ulong)

Declaration

protected override void OnSessionDestroy(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionDestroy(ulong)

OnSessionEnd(ulong)

Declaration

protected override void OnSessionEnd(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Overrides

OpenXRFeature.OnSessionEnd(ulong)

OnSessionStateChange(int, int)

Declaration

protected override void OnSessionStateChange(int oldState, int newState)

Parameters

Type	Name	Description
int	oldState
int	newState

Overrides

OpenXRFeature.OnSessionStateChange(int, int)

OnSystemChange(ulong)

Declaration

protected override void OnSystemChange(ulong xrSystem)

Parameters

Type	Name	Description
ulong	xrSystem

Overrides

OpenXRFeature.OnSystemChange(ulong)

Submit_CompositionLayerQuad(XrCompositionLayerQuad, LayerType, uint, int)

submit compostion layer of type quad.

Declaration

public void Submit_CompositionLayerQuad(XrCompositionLayerQuad quad, LayerType layerType, uint compositionDepth, int layerID)

Parameters

Type	Name	Description
XrCompositionLayerQuad	quad
LayerType	layerType
uint	compositionDepth
int	layerID

VIVEOpenXR_CompositionLayer_Destroy(int)

Declaration

public static extern bool VIVEOpenXR_CompositionLayer_Destroy(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
bool

VIVEOpenXR_CompositionLayer_GetFuncAddrs(XrInstance, IntPtr)

Declaration

public static extern XrResult VIVEOpenXR_CompositionLayer_GetFuncAddrs(XrInstance xrInstance, IntPtr xrGetInstanceProcAddrFuncPtr)

Parameters

Type	Name	Description
XrInstance	xrInstance
IntPtr	xrGetInstanceProcAddrFuncPtr

Returns

Type	Description
XrResult

VIVEOpenXR_CompositionLayer_GetTexture(int, out uint)

Declaration

public static extern IntPtr VIVEOpenXR_CompositionLayer_GetTexture(int layerID, out uint imageIndex)

Parameters

Type	Name	Description
int	layerID
uint	imageIndex

Returns

Type	Description
IntPtr

VIVEOpenXR_CompositionLayer_Init(XrSession, uint, uint, GraphicsAPI, bool, bool, out uint, bool)

Declaration

public static extern int VIVEOpenXR_CompositionLayer_Init(XrSession session, uint textureWidth, uint textureHeight, GraphicsAPI graphicsAPI, bool isDynamic, bool isProtected, out uint imageCount, bool isExternal)

Parameters

Type	Name	Description
XrSession	session
uint	textureWidth
uint	textureHeight
GraphicsAPI	graphicsAPI
bool	isDynamic
bool	isProtected
uint	imageCount
bool	isExternal

Returns

Type	Description
int

VIVEOpenXR_CompositionLayer_ReleaseTexture(int)

Declaration

public static extern bool VIVEOpenXR_CompositionLayer_ReleaseTexture(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
bool

VIVEOpenXR_Compositionlayer_GetExternalSurfaceObj()

Declaration

public static extern IntPtr VIVEOpenXR_Compositionlayer_GetExternalSurfaceObj()

Returns

Type	Description
IntPtr

VIVEOpenXR_Compositionlayer_GetExternalSurfaceObj2(int)

Declaration

public static extern IntPtr VIVEOpenXR_Compositionlayer_GetExternalSurfaceObj2(int layerID)

Parameters

Type	Name	Description
int	layerID

Returns

Type	Description
IntPtr

VIVEOpenXR_Submit_CompositionLayerQuad(XrCompositionLayerQuad, LayerType, uint, int)

Declaration

public static extern void VIVEOpenXR_Submit_CompositionLayerQuad(XrCompositionLayerQuad quad, LayerType layerType, uint compositionDepth, int layerID)

Parameters

Type	Name	Description
XrCompositionLayerQuad	quad
LayerType	layerType
uint	compositionDepth
int	layerID