API reference
API reference
Select your platform
No SDKs available
No versions available

IOculusXRFunctionLibrary Class

Member Functions

AddLoadingSplashScreen ( Texture , TranslationInMeters , Rotation , SizeInMeters , DeltaRotation , bClearBeforeAdd )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::AddLoadingSplashScreen(class UTexture2D *Texture, FVector TranslationInMeters, FRotator Rotation, FVector2D SizeInMeters, FRotator DeltaRotation, bool bClearBeforeAdd)=0
Parameters
Texture: class UTexture2D *
TranslationInMeters: FVector
Rotation: FRotator
SizeInMeters: FVector2D
DeltaRotation: FRotator
bClearBeforeAdd: bool
Returns
void
ClearLoadingSplashScreens ()
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::ClearLoadingSplashScreens()=0
Returns
void
EnableOrientationTracking ( bOrientationTracking )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::EnableOrientationTracking(bool bOrientationTracking)=0
Parameters
bOrientationTracking: bool
Returns
void
EnablePositionTracking ( bPositionTracking )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::EnablePositionTracking(bool bPositionTracking)=0
Parameters
bPositionTracking: bool
Returns
void
GetAppSpace ( OutAppSpace )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetAppSpace(uint64_t *OutAppSpace)=0
Parameters
OutAppSpace: uint64_t *
Returns
void
GetAvailableDisplayFrequencies ()
Signature
virtual TArray< float > OculusXRHMD::IOculusXRFunctionLibrary::GetAvailableDisplayFrequencies()=0
Returns
TArray< float >
GetBaseRotationAndBaseOffsetInMeters ( OutRotation , OutBaseOffsetInMeters )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetBaseRotationAndBaseOffsetInMeters(FRotator &OutRotation, FVector &OutBaseOffsetInMeters)=0
Parameters
OutRotation: FRotator &
OutBaseOffsetInMeters: FVector &
Returns
void
GetBaseRotationAndPositionOffset ( OutRot , OutPosOffset )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetBaseRotationAndPositionOffset(FRotator &OutRot, FVector &OutPosOffset)=0
Parameters
OutRot: FRotator &
OutPosOffset: FVector &
Returns
void
GetControllerType ( deviceHand )
Signature
virtual EOculusXRControllerType OculusXRHMD::IOculusXRFunctionLibrary::GetControllerType(EControllerHand deviceHand)=0
Parameters
deviceHand: EControllerHand
GetCurrentDisplayFrequency ()
Signature
virtual float OculusXRHMD::IOculusXRFunctionLibrary::GetCurrentDisplayFrequency()=0
Returns
float
GetDeviceName ()
Signature
virtual FString OculusXRHMD::IOculusXRFunctionLibrary::GetDeviceName()=0
Returns
FString
GetDeviceType ()
Signature
virtual EOculusXRDeviceType OculusXRHMD::IOculusXRFunctionLibrary::GetDeviceType()=0
GetEyeTrackedFoveatedRenderingSupported ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::GetEyeTrackedFoveatedRenderingSupported()=0
Returns
bool
GetFoveatedRenderingLevel ()
Signature
virtual EOculusXRFoveatedRenderingLevel OculusXRHMD::IOculusXRFunctionLibrary::GetFoveatedRenderingLevel()=0
GetFoveatedRenderingMethod ()
Signature
virtual EOculusXRFoveatedRenderingMethod OculusXRHMD::IOculusXRFunctionLibrary::GetFoveatedRenderingMethod()=0
GetGPUFrameTime ()
Signature
virtual float OculusXRHMD::IOculusXRFunctionLibrary::GetGPUFrameTime()=0
Returns
float
GetGPUUtilization ( IsGPUAvailable , GPUUtilization )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetGPUUtilization(bool &IsGPUAvailable, float &GPUUtilization)=0
Parameters
IsGPUAvailable: bool &
GPUUtilization: float &
Returns
void
GetGuardianDimensions ( BoundaryType )
Signature
virtual FVector OculusXRHMD::IOculusXRFunctionLibrary::GetGuardianDimensions(EOculusXRBoundaryType BoundaryType)=0
Parameters
BoundaryType: EOculusXRBoundaryType
Returns
FVector
GetGuardianPoints ( BoundaryType , UsePawnSpace )
Signature
virtual TArray< FVector > OculusXRHMD::IOculusXRFunctionLibrary::GetGuardianPoints(EOculusXRBoundaryType BoundaryType, bool UsePawnSpace)=0
Parameters
BoundaryType: EOculusXRBoundaryType
UsePawnSpace: bool
Returns
TArray< FVector >
GetHmdColorDesc ()
Signature
virtual EOculusXRColorSpace OculusXRHMD::IOculusXRFunctionLibrary::GetHmdColorDesc()=0
GetNativeOpenXRHandles ( OutXrInstance , OutXrSession )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetNativeOpenXRHandles(uint64_t *OutXrInstance, uint64_t *OutXrSession)=0
Parameters
OutXrInstance: uint64_t *
OutXrSession: uint64_t *
Returns
void
GetNextPredictedDisplayTime ( NextPredictedDisplayTime )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetNextPredictedDisplayTime(uint64_t *NextPredictedDisplayTime)=0
Parameters
NextPredictedDisplayTime: uint64_t *
Returns
void
GetNodeGuardianIntersection ( DeviceType , BoundaryType )
Signature
virtual FOculusXRGuardianTestResult OculusXRHMD::IOculusXRFunctionLibrary::GetNodeGuardianIntersection(EOculusXRTrackedDeviceType DeviceType, EOculusXRBoundaryType BoundaryType)=0
Parameters
GetOpenXRInstanceProcAddrFunc ( Func )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetOpenXRInstanceProcAddrFunc(void **Func)=0
Parameters
Func: void **
Returns
void
GetPerformanceMetrics ( PerformanceMetrics )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetPerformanceMetrics(FOculusXRPerformanceMetrics &PerformanceMetrics)=0
Parameters
PerformanceMetrics: FOculusXRPerformanceMetrics &
Returns
void
GetPlayAreaTransform ()
Signature
virtual FTransform OculusXRHMD::IOculusXRFunctionLibrary::GetPlayAreaTransform()=0
Returns
FTransform
GetPointGuardianIntersection ( Point , BoundaryType )
Signature
virtual FOculusXRGuardianTestResult OculusXRHMD::IOculusXRFunctionLibrary::GetPointGuardianIntersection(const FVector Point, EOculusXRBoundaryType BoundaryType)=0
Parameters
Point: const FVector
BoundaryType: EOculusXRBoundaryType
GetPose ( DeviceRotation , DevicePosition , NeckPosition )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetPose(FRotator &DeviceRotation, FVector &DevicePosition, FVector &NeckPosition)=0
Parameters
DeviceRotation: FRotator &
DevicePosition: FVector &
NeckPosition: FVector &
Returns
void
GetRawSensorData ( AngularAcceleration , LinearAcceleration , AngularVelocity , LinearVelocity , TimeInSeconds , DeviceType )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetRawSensorData(FVector &AngularAcceleration, FVector &LinearAcceleration, FVector &AngularVelocity, FVector &LinearVelocity, float &TimeInSeconds, EOculusXRTrackedDeviceType DeviceType)=0
Parameters
AngularAcceleration: FVector &
LinearAcceleration: FVector &
AngularVelocity: FVector &
LinearVelocity: FVector &
TimeInSeconds: float &
Returns
void
GetStereoLayers ()
Signature
virtual class IStereoLayers * OculusXRHMD::IOculusXRFunctionLibrary::GetStereoLayers()=0
Returns
class IStereoLayers *
GetSuggestedCpuAndGpuPerformanceLevels ( CpuPerfLevel , GpuPerfLevel )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::GetSuggestedCpuAndGpuPerformanceLevels(EOculusXRProcessorPerformanceLevel &CpuPerfLevel, EOculusXRProcessorPerformanceLevel &GpuPerfLevel)=0
Returns
void
GetSystemHmd3DofModeEnabled ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::GetSystemHmd3DofModeEnabled()=0
Returns
bool
GetUserProfile ( Profile )
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::GetUserProfile(FOculusXRHmdUserProfile &Profile)=0
Parameters
Returns
bool
HasInputFocus ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::HasInputFocus()=0
Returns
bool
HasSystemOverlayPresent ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::HasSystemOverlayPresent()=0
Returns
bool
IsColorPassthroughSupported ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsColorPassthroughSupported()=0
Returns
bool
IsDeviceTracked ( DeviceType )
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsDeviceTracked(EOculusXRTrackedDeviceType DeviceType)=0
Parameters
Returns
bool
IsEnvironmentDepthStarted ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsEnvironmentDepthStarted()=0
Returns
bool
IsGuardianConfigured ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsGuardianConfigured()=0
Returns
bool
IsGuardianDisplayed ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsGuardianDisplayed()=0
Returns
bool
IsPassthroughRecommended ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsPassthroughRecommended()=0
Returns
bool
IsPassthroughSupported ()
Signature
virtual bool OculusXRHMD::IOculusXRFunctionLibrary::IsPassthroughSupported()=0
Returns
bool
RegisterOpenXrEventHandler ( OpenXrEventHandler , Context )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::RegisterOpenXrEventHandler(void(*OpenXrEventHandler)(void *data, void *context), void *Context)=0
Parameters
OpenXrEventHandler: void(*)(void *data, void *context)
Context: void *
Returns
void
SetBaseRotationAndBaseOffsetInMeters ( Rotation , BaseOffsetInMeters , Options )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetBaseRotationAndBaseOffsetInMeters(FRotator Rotation, FVector BaseOffsetInMeters, EOrientPositionSelector::Type Options)=0
Parameters
Rotation: FRotator
BaseOffsetInMeters: FVector
Options: EOrientPositionSelector::Type
Returns
void
SetBaseRotationAndPositionOffset ( BaseRot , PosOffset , Options )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetBaseRotationAndPositionOffset(FRotator BaseRot, FVector PosOffset, EOrientPositionSelector::Type Options)=0
Parameters
BaseRot: FRotator
PosOffset: FVector
Options: EOrientPositionSelector::Type
Returns
void
SetClientColorDesc ( ColorSpace )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetClientColorDesc(EOculusXRColorSpace ColorSpace)=0
Parameters
Returns
void
SetColorScaleAndOffset ( ColorScale , ColorOffset , bApplyToAllLayers )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetColorScaleAndOffset(FLinearColor ColorScale, FLinearColor ColorOffset, bool bApplyToAllLayers)=0
Parameters
ColorScale: FLinearColor
ColorOffset: FLinearColor
bApplyToAllLayers: bool
Returns
void
SetDisplayFrequency ( RequestedFrequency )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetDisplayFrequency(float RequestedFrequency)=0
Parameters
RequestedFrequency: float
Returns
void
SetEnvironmentDepthHandRemoval ( RemoveHands )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetEnvironmentDepthHandRemoval(bool RemoveHands)=0
Parameters
RemoveHands: bool
Returns
void
SetEyeBufferSharpenType ( EyeBufferSharpenType )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetEyeBufferSharpenType(EOculusXREyeBufferSharpenType EyeBufferSharpenType)=0
Parameters
EyeBufferSharpenType: EOculusXREyeBufferSharpenType
Returns
void
SetFoveatedRenderingLevel ( level , isDynamic )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetFoveatedRenderingLevel(EOculusXRFoveatedRenderingLevel level, bool isDynamic)=0
Parameters
isDynamic: bool
Returns
void
SetFoveatedRenderingMethod ( Method )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetFoveatedRenderingMethod(EOculusXRFoveatedRenderingMethod Method)=0
Returns
void
SetGuardianVisibility ( GuardianVisible )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetGuardianVisibility(bool GuardianVisible)=0
Parameters
GuardianVisible: bool
Returns
void
SetLocalDimmingOn ( LocalDimmingOn )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetLocalDimmingOn(bool LocalDimmingOn)=0
Parameters
LocalDimmingOn: bool
Returns
void
SetSuggestedCpuAndGpuPerformanceLevels ( CpuPerfLevel , GpuPerfLevel )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetSuggestedCpuAndGpuPerformanceLevels(EOculusXRProcessorPerformanceLevel CpuPerfLevel, EOculusXRProcessorPerformanceLevel GpuPerfLevel)=0
Returns
void
SetXROcclusionsMode ( WorldContextObject , Mode )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::SetXROcclusionsMode(UObject *WorldContextObject, EOculusXROcclusionsMode Mode)=0
Parameters
WorldContextObject: UObject *
Returns
void
StartEnvironmentDepth ()
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::StartEnvironmentDepth()=0
Returns
void
StopEnvironmentDepth ()
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::StopEnvironmentDepth()=0
Returns
void
UnregisterOpenXrEventHandler ( OpenXrEventHandler )
Signature
virtual void OculusXRHMD::IOculusXRFunctionLibrary::UnregisterOpenXrEventHandler(void(*OpenXrEventHandler)(void *data, void *context))=0
Parameters
OpenXrEventHandler: void(*)(void *data, void *context)
Returns
void