Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OpenXRHMD > IOpenXRExtensionPlugin

Light Theme

Dark Theme

IOpenXRExtensionPlugin

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

IOpenXRExtensionPlugin

	FOpenXRMsftHandInteraction
	IOculusOpenXRHMDPlugin

References

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

Syntax

class IOpenXRExtensionPlugin : public IModularFeature

Destructors

	Name	Description
	~IOpenXRExtensionPlugin()

Functions

	Name	Description
void	AddActions ( XrInstance Instance, TFunction< XrAction(XrActionType In... )	Add any actions provided by the plugin to Actions with suggested bindings.
IOpenXRCusto...	GetCustomAnchorSupport()	Get custom anchor interface if provided by this extension.
IOpenXRCusto...	GetCustomCaptureSupport ( const EARCaptureType CaptureType )	Get custom capture interface if provided by this extension.
bool	GetCustomLoader ( PFN_xrGetInstanceProcAddr* Out... )	Optionally provide a custom loader for the OpenXR plugin.
FOpenXRRende...	GetCustomRenderBridge ( XrInstance InInstance, XrSystemId InSystem )	Optionally provide a custom render bridge for the OpenXR plugin.
bool	GetInteractionProfile ( XrInstance InInstance, FString& OutKeyPrefix, XrPath& OutPath, bool& OutHasHaptics )	Set the output parameters to add an interaction profile to OpenXR Input
FName	GetModularFeatureName()
bool	GetOptionalExtensions ( TArray< const ANSICHAR* >& Ou... )	Fill the array with extensions optionally supported by the plugin If false is returned the plugin and its extensions will be ignored
bool	GetRequiredExtensions ( TArray< const ANSICHAR* >& Ou... )	Fill the array with extensions required by the plugin If false is returned the plugin and its extensions will be ignored
bool	GetSpectatorScreenController ( FHeadMountedDisplayBase* InHMD..., TUniquePtr< FDefaultSpectatorScreen... )	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
void	GetViewConfigurations ( XrSystemId InSystem, TArray< XrViewConfigurationView >&... )	Callback to provide extra view configurations that should be rendered in the main render pass
void	GetViewLocations ( XrSession InSession, XrTime InDisplayTime, XrSpace InViewSpace, TArray< XrView >& OutViews )	Callback to provide the pose and fov of each view that was provided in GetViewConfigurations
bool	IsStandaloneStereoOnlyDevice()	Indicates that the device we're currently running does not support a spectator view.
void	OnAcquireSwapchainImage ( XrSession InSession )	OpenXRHMD::OnBeginRendering_RenderThread, before acquiring swapchain.
const void &...	OnBeginDepthInfo ( XrSession InSession, int32 InLayerIndex, int32 InViewIndex, const void* InNext )
const void &...	OnBeginFrame ( XrSession InSession, XrTime DisplayTime, const void* InNext )	OpenXRHMD::OnBeginRendering_RHIThread.
const void &...	OnBeginProjectionView ( XrSession InSession, int32 InLayerIndex, int32 InViewIndex, const void* InNext )
const void &...	OnBeginSession ( XrSession InSession, const void* InNext )
const void &...	OnCreateInstance ( IOpenXRHMDPlugin* InPlugin, const void* InNext )	Callbacks with returned pointer added to next chain, do not return pointers to structs on the stack.
const void &...	OnCreateSession ( XrInstance InInstance, XrSystemId InSystem, const void* InNext )
const void &...	OnEndFrame ( XrSession InSession, XrTime DisplayTime, const TArray< XrSwapchainSubImage >..., const TArray< XrSwapchainSubImage >..., const void* InNext )	FOpenXRRenderBridge::Present, RHI thread.
const void &...	OnEndProjectionLayer ( XrSession InSession, int32 InLayerIndex, const void* InNext, XrCompositionLayerFlags& OutFlags )
void *	OnEnumerateViewConfigurationViews ( XrInstance InInstance, XrSystemId InSystem, XrViewConfigurationType InViewConfi..., uint32_t InViewIndex, void* InNext )
void	OnEvent ( XrSession InSession, const XrEventDataBaseHeader* I... )	Use this callback to handle events that the OpenXR plugin doesn't handle itself
const void &...	OnGetSystem ( XrInstance InInstance, const void* InNext )
const void &...	OnLocateViews ( XrSession InSession, XrTime InDisplayTime, const void* InNext )
void	OnPauseARSession()	Stop the AR system but leave its internal state intact.
void	OnStartARSession ( UARSessionConfig* SessionConfi... )	Start the AR system.
void	OnStopARSession()	Stop the AR system and reset its internal state; this task must succeed.
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.
void *	OnWaitFrame ( XrSession InSession, void* InNext )	OpenXRHMD::OnBeginRendering_GameThread.
void	PostCreateSession ( XrSession InSession )
void	PostGetSystem ( XrInstance InInstance, XrSystemId InSystem )
void	PostSyncActions ( XrSession InSession )	FOpenXRInput::Tick, game thread, after xrSyncActions.
void	RegisterOpenXRExtensionModularFeature()	Register module as an extension on startup.
void	UnregisterOpenXRExtensionModularFeature()
void	UpdateDeviceLocations ( XrSession InSession, XrTime DisplayTime, XrSpace TrackingSpace )	OpenXRHMD::OnStartGameFrame.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss