1. Epic GamesDeveloper
  3. IOpenXRExtensionPlugin

IOpenXRExtensionPlugin

API > API/Plugins > API/Plugins/OpenXRHMD

Inheritance Hierarchy

References

   
Module OpenXRHMD
Header /Engine/Plugins/Runtime/OpenXR/Source/OpenXRHMD/Public/IOpenXRExtensionPlugin.h
Include #include "IOpenXRExtensionPlugin.h"

Syntax

class IOpenXRExtensionPlugin : public IModularFeature

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AttachActionSets ( TSet< XrActionSet >& OutActionSets
)

 Add any action sets provided by the plugin to be attached as active to the session This allows a plugin to manage a custom actionset that will be active in xrSyncActions
Public function Virtual void  
Public function Virtual void

GetActiveActionSetsForSync ( TArray< XrActiveActionSet >& OutActiveSets
)

 Specify action sets to be included in XrActionsSyncInfo::activeActionSets.
Public function Virtual bool

GetControllerModel ( XrInstance InInstance,
XrPath InInteractionProfile,
XrPath InDevicePath,
FSoftObjectPath& OutPath
)

 Set the output parameters to provide a path to an asset in the plugin content folder that visualizes the controller in the hand represented by the user path.
Public function Virtual void Add all asset paths that need to be packaged for cooking.
Public function Virtual IOpenXRCustomAnchorSupport * Get custom anchor interface if provided by this extension.
Public function Virtual IOpenXRCustomCaptureSupport *

GetCustomCaptureSupport ( const EARCaptureType CaptureType
)

 Get custom capture interface if provided by this extension.
Public function Virtual bool

GetCustomLoader ( PFN_xrGetInstanceProcAddr* OutGetProcAddr
)

 Optionally use a custom loader (via GetInstanceProcAddr) for the OpenXR plugin.
Public function Virtual FOpenXRRenderBridge *

GetCustomRenderBridge ( XrInstance InInstance
)

 Optionally provide a custom render bridge for the OpenXR plugin.
Public function Virtual FString  
Public function Virtual bool

GetInteractionProfile ( XrInstance InInstance,
FString& OutKeyPrefix,
XrPath& OutPath,
bool& OutHasHaptics
)

 Set the output parameters to add an interaction profile to OpenXR Input
Public function Static FName  
Public function Virtual bool

GetOptionalExtensions ( TArray< const ANSICHAR* >& OutExtensions
)

 Fill the array with extensions optionally supported by the plugin If false is returned the plugin and its extensions will be ignored
Public function Virtual bool

GetRequiredExtensions ( TArray< const ANSICHAR* >& OutExtensions
)

 Fill the array with extensions required by the plugin If false is returned the plugin and its extensions will be ignored
Public function Virtual bool Set a spectator screen controller specific to the platform If true is returned and OutSpectatorScreenController is nullptr, spectator screen will be disabled If false is returned a default spectator screen controller will be created
Public function Virtual bool

InsertOpenXRAPILayer ( PFN_xrGetInstanceProcAddr& InOutGetProcAddr
)

 Experimental: Optionally hand off the loader/plugin GetInstanceProcAddr to an extension plugin to support API layering.
Public function Virtual bool Indicates that the device we're currently running does not support a spectator view.
Public function Virtual const void *

OnBeginDepthInfo ( XrSession InSession,
int32 InLayerIndex,
int32 InViewIndex,
const void* InNext
)

  
Public function Virtual const void *

OnBeginFrame ( XrSession InSession,
XrTime DisplayTime,
const void* InNext
)

 OpenXRHMD::OnBeginRendering_RHIThread.
Public function Virtual const void *

OnBeginProjectionView ( XrSession InSession,
int32 InLayerIndex,
int32 InViewIndex,
const void* InNext
)

  
Public function Virtual void

OnBeginRendering_RenderThread ( XrSession InSession
)

 OpenXRHMD::OnBeginRendering_RenderThread.
Public function Virtual const void *

OnBeginSession ( XrSession InSession,
const void* InNext
)

  
Public function Virtual const void *

OnCreateInstance ( IOpenXRHMDModule* InModule,
const void* InNext
)

 Callbacks with returned pointer added to next chain, do not return pointers to structs on the stack.
Public function Virtual const void *

OnCreateSession ( XrInstance InInstance,
XrSystemId InSystem,
const void* InNext
)

  
Public function Virtual void

OnDestroySession ( XrSession InSession
)

  
Public function Virtual const void *

OnEndFrame ( XrSession InSession,
XrTime DisplayTime,
const void* InNext
)

 FOpenXRRenderBridge::Present, RHI thread.
Public function Virtual const void *

OnEndProjectionLayer ( XrSession InSession,
int32 InLayerIndex,
const void* InNext,
XrCompositionLayerFlags& OutFlags
)

  
Public function Virtual void *

OnEnumerateViewConfigurationViews ( XrInstance InInstance,
XrSystemId InSystem,
XrViewConfigurationType InViewConfigurationType,
uint32_t InViewIndex,
void* InNext
)

  
Public function Virtual void

OnEvent ( XrSession InSession,
const XrEventDataBaseHeader* InHeader
)

 Use this callback to handle events that the OpenXR plugin doesn't handle itself
Public function Virtual const void *

OnGetSystem ( XrInstance InInstance,
const void* InNext
)

  
Public function Virtual const void *

OnLocateViews ( XrSession InSession,
XrTime InDisplayTime,
const void* InNext
)

  
Public function Virtual void Stop the AR system but leave its internal state intact.
Public function Virtual void

OnSetDeviceProperty ( XrSession InSession,
int32 ControllerId,
const FInputDeviceProperty* Property
)

  
Public function Virtual void

OnSetupLayers_RenderThread ( XrSession InSession,
const TArray< uint32 >& LayerIds
)

 FOpenXRHMD::OnBeginRendering_RenderThread.
Public function Virtual void

OnStartARSession ( UARSessionConfig* SessionConfig
)

 Start the AR system.
Public function Virtual void Stop the AR system and reset its internal state; this task must succeed.
Public function Virtual const void *

OnSyncActions ( XrSession InSession,
const void* InNext
)

 FOpenXRInput::Tick, game thread, setting up for xrSyncActions. This happens near the start of the game frame.
Public function Virtual void *

OnWaitFrame ( XrSession InSession,
void* InNext
)

 OpenXRHMD::OnBeginRendering_GameThread.
Public function Virtual void

PostCreateInstance ( XrInstance InInstance
)

  
Public function Virtual void

PostCreateSession ( XrSession InSession
)

  
Public function Virtual void

PostGetSystem ( XrInstance InInstance,
XrSystemId InSystem
)

  
Public function Virtual void

PostSyncActions ( XrSession InSession
)

 FOpenXRInput::Tick, game thread, after xrSyncActions.
Public function void Register module as an extension on startup.
Public function void  
Public function Virtual void

UpdateCompositionLayers ( XrSession InSession,
TArray< const XrCompositionLayerBaseHeader* >& Headers
)

 FOpenXRHMD::OnFinishRendering_RHIThread.
Public function Virtual void

UpdateDeviceLocations ( XrSession InSession,
XrTime DisplayTime,
XrSpace TrackingSpace
)

 OpenXRHMD::OnStartGameFrame.
Public function Virtual bool

UseCustomReferenceSpaceType ( XrReferenceSpaceType& OutReferenceSpaceType
)

 Update OpenXRHMD to use reference space types other than view, local, and stage.

Deprecated Functions

  Type Name Description
Public function Virtual void

AddActions ( XrInstance Instance,
TFunction< XrAction(XrActionType InActionType, const FName&InName, const TArray< XrPath >&InSubact...
)

 Use Enhanced Input through IMotionController::SetPlayerMappableInputConfig instead.
Public function Virtual void

AddActionSets ( TArray< XrActiveActionSet >& OutActionSets
)

 Functionality moved to AttachActionSets().

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page