IAndroidXRModule

This is an abstract class.

#include <IAndroidXRModule.h>

The public interface to this module.

In most cases, this interface is only public to sibling modules within this plugin.

Summary

Inheritance

Inherits from: IModuleInterface

Public static functions
Get()
Singleton-like access to this module's interface.
IsAvailable()
bool
Checks to see if this module is loaded and ready.

Public functions
BeginDebugUtilsLabelRegion(const XrDebugUtilsLabelEXT & LabelInfo)=0
virtual bool
CreateDebugUtilsMessenger(const XrDebugUtilsMessengerCreateInfoEXT & CreateInfo, XrDebugUtilsMessengerEXT & Messenger)=0
virtual bool
DestroyDebugUtilsMessenger(XrDebugUtilsMessengerEXT & Messenger)=0
virtual bool
EndDebugUtilsLabelRegion()=0
virtual bool
EnumerateDisplayRefreshRates(TArray< float > & DisplayRefreshRates)=0
virtual bool
GetCameraPassthroughSupported()=0
virtual bool
GetDisplayRefreshRate(float & DisplayRefreshRate)=0
virtual bool
GetPassthroughCameraState(EAndroidXRPassthroughCameraState & CameraState)=0
virtual bool
InsertDebugUtilsLabel(const XrDebugUtilsLabelEXT & LabelInfo)=0
virtual bool
PerfSettingsSetPerformanceLevel(EAndroidXRPerfSettingsDomain SettingsDomain, EAndroidXRPerfSettingsLevel SettingsLevel)=0
virtual bool
RequestDisplayRefreshRate(float DisplayRefreshRate)=0
virtual bool
SetAndroidApplicationThread(EAndroidXRAndroidThreadType ThreadType, uint32 ThreadID)=0
virtual bool
SetDebugUtilsObjectName(XrObjectType ObjectType, uint64 ObjectHandle, FString ObjectName)=0
virtual bool
SubmitDebugUtilsMessage(XrDebugUtilsMessageSeverityFlagsEXT SeverityFlags, XrDebugUtilsMessageTypeFlagsEXT TypeFlags, const XrDebugUtilsMessengerCallbackDataEXT & CallbackData)=0
virtual bool

Public static functions

Get

IAndroidXRModule & Get()

Singleton-like access to this module's interface.

This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Details
Returns
Returns singleton instance, loading the module on demand if needed

IsAvailable

bool IsAvailable()

Checks to see if this module is loaded and ready.

It is only valid to call Get() if IsAvailable() returns true.

Details
Returns
True if the module is loaded and ready to use

Public functions

BeginDebugUtilsLabelRegion

virtual bool BeginDebugUtilsLabelRegion(
  const XrDebugUtilsLabelEXT & LabelInfo
)=0

CreateDebugUtilsMessenger

virtual bool CreateDebugUtilsMessenger(
  const XrDebugUtilsMessengerCreateInfoEXT & CreateInfo,
  XrDebugUtilsMessengerEXT & Messenger
)=0

DestroyDebugUtilsMessenger

virtual bool DestroyDebugUtilsMessenger(
  XrDebugUtilsMessengerEXT & Messenger
)=0

EndDebugUtilsLabelRegion

virtual bool EndDebugUtilsLabelRegion()=0

EnumerateDisplayRefreshRates

virtual bool EnumerateDisplayRefreshRates(
  TArray< float > & DisplayRefreshRates
)=0

GetCameraPassthroughSupported

virtual bool GetCameraPassthroughSupported()=0

GetDisplayRefreshRate

virtual bool GetDisplayRefreshRate(
  float & DisplayRefreshRate
)=0

GetPassthroughCameraState

virtual bool GetPassthroughCameraState(
  EAndroidXRPassthroughCameraState & CameraState
)=0

InsertDebugUtilsLabel

virtual bool InsertDebugUtilsLabel(
  const XrDebugUtilsLabelEXT & LabelInfo
)=0

PerfSettingsSetPerformanceLevel

virtual bool PerfSettingsSetPerformanceLevel(
  EAndroidXRPerfSettingsDomain SettingsDomain,
  EAndroidXRPerfSettingsLevel SettingsLevel
)=0

RequestDisplayRefreshRate

virtual bool RequestDisplayRefreshRate(
  float DisplayRefreshRate
)=0

SetAndroidApplicationThread

virtual bool SetAndroidApplicationThread(
  EAndroidXRAndroidThreadType ThreadType,
  uint32 ThreadID
)=0

SetDebugUtilsObjectName

virtual bool SetDebugUtilsObjectName(
  XrObjectType ObjectType,
  uint64 ObjectHandle,
  FString ObjectName
)=0

SubmitDebugUtilsMessage

virtual bool SubmitDebugUtilsMessage(
  XrDebugUtilsMessageSeverityFlagsEXT SeverityFlags,
  XrDebugUtilsMessageTypeFlagsEXT TypeFlags,
  const XrDebugUtilsMessengerCallbackDataEXT & CallbackData
)=0