className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
3
36
code
stringlengths
0
11.4k
variables
listlengths
0
395
FDefaultSpectatorScreenController::Helpers::GetEyeCroppedToFitRect
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
static FIntRect GetEyeCroppedToFitRect &40; FVector2D EyeCenterPoint, const FIntRect & EyeRect, const FIntRect & TargetRect &41;
[]
FDefaultSpectatorScreenController::Helpers::GetLetterboxedDestRect
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
static FIntRect GetLetterboxedDestRect &40; const FIntRect & SrcRect, const FIntRect & TargetRect &41;
[]
Helpers
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
class Helpers
[]
FDefaultSpectatorScreenController::QueueDebugCanvasLayerID
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void QueueDebugCanvasLayerID ( int32 LayerID )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeSingleEyeLetterboxed
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeSingleEyeLetterboxed ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeUndistorted
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeUndistorted ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeMirrorAndTexture
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeMirrorAndTexture ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeSingleEyeCroppedToFill
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeSingleEyeCroppedToFill ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeDistorted
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeDistorted ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeSingleEye
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeSingleEye ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorModeTexture
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorModeTexture ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorScreen_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorScreen_RenderThread ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * BackBuffer, FTexture2DRHIRef SrcTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::RenderSpectatorScreen_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void RenderSpectatorScreen_RenderThread ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * BackBuffer, FTexture2DRHIRef SrcTexture, FTexture2DRHIRef LayersTexture, FVector2D WindowSize )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenModeTexturePlusEyeLayout
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
Setup the layout for ESpectatorScreenMode::TexturePlusEye.
XRBase
virtual void SetSpectatorScreenModeTexturePlusEyeLayout ( const [FSpectatorScreenModeTexturePlusEyeLayout](API\Runtime\HeadMountedDisplay\FSpectatorScreenModeTexturePlusE-) & Layout )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenTextureRenderCommand
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void SetSpectatorScreenTextureRenderCommand ( [UTexture](API\Runtime\Engine\Engine\UTexture) * SrcTexture )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenTexture_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void SetSpectatorScreenTexture_RenderThread ( FTexture2DRHIRef & InTexture )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenModeTexturePlusEyeLayoutRenderCommand
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void SetSpectatorScreenModeTexturePlusEyeLayoutRenderCommand ( const [FSpectatorScreenModeTexturePlusEyeLayout](API\Runtime\HeadMountedDisplay\FSpectatorScreenModeTexturePlusE-) & Layout )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenModeTexturePlusEyeLayout_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void SetSpectatorScreenModeTexturePlusEyeLayout_RenderThread ( const [FSpectatorScreenModeTexturePlusEyeLayout](API\Runtime\HeadMountedDisplay\FSpectatorScreenModeTexturePlusE-) & Layout )
[]
FDefaultSpectatorScreenController::SetSpectatorScreenMode
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
Sets the social screen mode.
XRBase
virtual void SetSpectatorScreenMode ( ESpectatorScreenMode Mode )
[]
FDefaultSpectatorScreenController::UpdateSpectatorScreenMode_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual void UpdateSpectatorScreenMode_RenderThread()
[]
FDefaultSpectatorScreenController::SetSpectatorScreenTexture
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
Change the texture displayed on the social screen
XRBase
virtual void SetSpectatorScreenTexture ( [UTexture](API\Runtime\Engine\Engine\UTexture) * InTexture )
[]
FDefaultSpectatorScreenController::FDefaultSpectatorScreenController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
FDefaultSpectatorScreenController ( [FHeadMountedDisplayBase](API\Plugins\XRBase\FHeadMountedDisplayBase) * InHMDDevice )
[]
FDefaultSpectatorScreenController::~FDefaultSpectatorScreenController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
virtual ~FDefaultSpectatorScreenController()
[]
FDefaultSpectatorScreenController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
Default implementation of spectator screen controller.
XRBase
class FDefaultSpectatorScreenController : public [ISpectatorScreenController](API\Runtime\HeadMountedDisplay\ISpectatorScreenController), public [TSharedFromThis< FDefaultSpectatorScreenController, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)
[ { "type": "TArray< int32 >", "name": "DebugCanvasLayerIDs", "description": "" }, { "type": "ESpectatorScree...", "name": "NewSpectatorScreenMode", "description": "" }, { "type": "FCriticalSectio...", "name": "NewSpectatorScreenModeLock", "description": "" }, { "type": "FSpectatorScree...", "name": "SpectatorScreenDelegate_RenderThread", "description": "" }, { "type": "ESpectatorScree...", "name": "SpectatorScreenMode_RenderThread", "description": "" }, { "type": "FSpectatorScree...", "name": "SpectatorScreenModeTexturePlusEyeLayout_RenderThread", "description": "" }, { "type": "TWeakObjectPtr<...", "name": "SpectatorScreenTexture", "description": "" }, { "type": "FTexture2DRHIRe...", "name": "SpectatorScreenTexture_RenderThread", "description": "" } ]
FDefaultStereoLayers::BeginRenderViewFamily
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Called on game thread when view family is about to be rendered.
XRBase
virtual void BeginRenderViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultStereoLayers::PostRenderView_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Allows to render content after the 3D content scene, useful for debugging
XRBase
virtual void PostRenderView_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneView](API\Runtime\Engine\FSceneView) & InView )
[]
FDefaultStereoLayers::PreRenderViewFamily_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Called on render thread at the start of rendering.
XRBase
virtual void PreRenderViewFamily_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultStereoLayers::SetupView
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Called on game thread when creating the view.
XRBase
virtual void SetupView ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily, [FSceneView](API\Runtime\Engine\FSceneView) & InView )
[]
FDefaultStereoLayers::PreRenderView_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Called on render thread at the start of rendering, for each view, after PreRenderViewFamily_RenderThread call.
XRBase
virtual void PreRenderView_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneView](API\Runtime\Engine\FSceneView) & InView )
[]
FDefaultStereoLayers::SetupViewFamily
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
ISceneViewExtensioninterface
XRBase
virtual void SetupViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultStereoLayers::ShouldCopyDebugLayersToSpectatorScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
If true the debug layers are copied to the spectator screen, because they do not naturally end up on the spectator screen as part of the 3d view.
XRBase
virtual bool ShouldCopyDebugLayersToSpectatorScreen() const
[]
FDefaultStereoLayers::StereoLayerRender
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Experimental method
XRBase
static void StereoLayerRender ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, const [TArray](API\Runtime\Core\Containers\TArray)< [FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) > & LayersToRender, const [FDefaultStereoLayers_LayerRenderParams](API\Plugins\XRBase\FDefaultStereoLayers_LayerRender-) & RenderParams )
[]
FDefaultStereoLayers::UpdateHmdTransform
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Invoked byFHeadMountedDisplayBaseto update the HMD position during the late update.
XRBase
void UpdateHmdTransform ( const FTransform & InHmdTransform )
[]
FDefaultStereoLayers::FDefaultStereoLayers
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
XRBase
FDefaultStereoLayers ( const [FAutoRegister](API\Runtime\Engine\FAutoRegister) & AutoRegister, [FHeadMountedDisplayBase](API\Plugins\XRBase\FHeadMountedDisplayBase) * InHMDDevice )
[]
FDefaultStereoLayers
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
FHeadmountedDisplayBase subclasses will use this implementation by default unless overridden.
XRBase
class FDefaultStereoLayers : public [FSimpleLayerManager](API\Plugins\XRBase\FSimpleLayerManager), public [FHMDSceneViewExtension](API\Runtime\Engine\FHMDSceneViewExtension)
[ { "type": "FHeadMountedDis...", "name": "HMDDevice", "description": "" }, { "type": "FTransform", "name": "HmdTransform", "description": "" }, { "type": "TArray<FLayerD...", "name": "SortedOverlayLayers", "description": "" }, { "type": "TArray<FLayerD...", "name": "SortedSceneLayers", "description": "" } ]
FDefaultStereoLayers_LayerRenderParams
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultStereoLayers.h
Experimental struct
XRBase
struct FDefaultStereoLayers_LayerRenderParams
[ { "type": "FMatrix[3]", "name": "RenderMatrices", "description": "" }, { "type": "FIntRect", "name": "Viewport", "description": "" } ]
FDefaultXRCamera::ApplyHMDRotation
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Optionally called byAPlayerControllerto apply the orientation of the headset to the PC's rotation. If this is not done then the PC will face differently than the camera, which might be good (depending on the game).
XRBase
virtual void ApplyHMDRotation ( [APlayerController](API\Runtime\Engine\GameFramework\APlayerController) * PC, FRotator & ViewRotation )
[]
FDefaultXRCamera::BeginRenderViewFamily
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Called on game thread when view family is about to be rendered.
XRBase
virtual void BeginRenderViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultXRCamera::CalculateStereoCameraOffset
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Calculates the offset for the camera position, given the specified eye pass, position and rotation. An XR plugin implementing stereo rendering should forward all calls of CalculateStereoViewOffset to this method.
XRBase
virtual void CalculateStereoCameraOffset ( const int32 ViewIndex, FRotator & ViewRotation, FVector & ViewLocation )
[]
FDefaultXRCamera::GetSystemDeviceId
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
IIdentifiableXRDeviceinterface:
XRBase
virtual int32 GetSystemDeviceId() const
[]
FDefaultXRCamera::GetSystemName
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Returns a unique identifier that's supposed to represent the third party system that this object is part of (Vive, Oculus, PSVR, etc.). A name unique to the system which this object belongs to.
XRBase
virtual [FName](API\Runtime\Core\UObject\FName) GetSystemName() const
[]
FDefaultXRCamera::GetUseImplicitHMDPosition
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Returns current setting controlling whether to assume an implied hmd position
XRBase
virtual bool GetUseImplicitHMDPosition() const
[]
FDefaultXRCamera::IsActiveThisFrame_Internal
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
FWorldSceneViewExtensioninterface:
XRBase
virtual bool IsActiveThisFrame_Internal ( const [FSceneViewExtensionContext](API\Runtime\Engine\FSceneViewExtensionContext) & Context ) const
[]
FDefaultXRCamera::OverrideFOV
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Override the Field of View for the player camera component.
XRBase
virtual void OverrideFOV ( float & InOutFOV )
[]
FDefaultXRCamera::PreRenderViewFamily_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Called on render thread at the start of rendering.
XRBase
virtual void PreRenderViewFamily_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultXRCamera::PreRenderView_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Called on render thread at the start of rendering, for each view, after PreRenderViewFamily_RenderThread call.
XRBase
virtual void PreRenderView_RenderThread ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FSceneView](API\Runtime\Engine\FSceneView) & InView )
[]
FDefaultXRCamera::SetupLateUpdate
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Setup state for applying the render thread late update
XRBase
virtual void SetupLateUpdate ( const FTransform & ParentToWorld, [USceneComponent](API\Runtime\Engine\Components\USceneComponent) * Component, bool bSkipLateUpdate )
[]
FDefaultXRCamera::SetupView
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Called on game thread when creating the view.
XRBase
virtual void SetupView ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily, [FSceneView](API\Runtime\Engine\FSceneView) & InView )
[]
FDefaultXRCamera::SetupViewFamily
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
ISceneViewExtensioninterface:
XRBase
virtual void SetupViewFamily ( [FSceneViewFamily](API\Runtime\Engine\FSceneViewFamily) & InViewFamily )
[]
FDefaultXRCamera::UpdatePlayerCamera
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Apply the orientation and position of the headset to the Camera.
XRBase
virtual bool UpdatePlayerCamera ( FQuat & CurrentOrientation, FVector & CurrentPosition )
[]
FDefaultXRCamera::UseImplicitHMDPosition
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Set the view offset mode to assume an implied HMD position
XRBase
virtual void UseImplicitHMDPosition ( bool bInImplicitHMDPosition )
[]
FDefaultXRCamera::FDefaultXRCamera
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
XRBase
FDefaultXRCamera ( const [FAutoRegister](API\Runtime\Engine\FAutoRegister) &, [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) * InTrackingSystem, int32 InDeviceId )
[]
FDefaultXRCamera::~FDefaultXRCamera
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
XRBase
virtual ~FDefaultXRCamera()
[]
FDefaultXRCamera
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRCamera.h
Default base implementation ofIXRCamera. Can either be used directly by implementations or extended with platform-specific features.
XRBase
class FDefaultXRCamera : public [IXRCamera](API\Runtime\HeadMountedDisplay\IXRCamera), public [FHMDSceneViewExtension](API\Runtime\Engine\FHMDSceneViewExtension)
[ { "type": "FQuat", "name": "DeltaControlOrientation", "description": "" }, { "type": "FRotator", "name": "DeltaControlRotation", "description": "" }, { "type": "const int32", "name": "DeviceId", "description": "" }, { "type": "IXRTrackingSyst...", "name": "TrackingSystem", "description": "" } ]
FDefaultXRLoadingScreen::ApplyDeltaRotation
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
virtual void ApplyDeltaRotation ( const [FSplashData](API\Plugins\XRBase\FSplashData) & Splash )
[]
FDefaultXRLoadingScreen::DoAddSplash
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
virtual void DoAddSplash ( [FSplashData](API\Plugins\XRBase\FSplashData) & Splash )
[]
FDefaultXRLoadingScreen::DoDeleteSplash
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
virtual void DoDeleteSplash ( [FSplashData](API\Plugins\XRBase\FSplashData) & Splash )
[]
FDefaultXRLoadingScreen::DoHideSplash
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
virtual void DoHideSplash ( [FSplashData](API\Plugins\XRBase\FSplashData) & Splash )
[]
FDefaultXRLoadingScreen::DoShowSplash
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
virtual void DoShowSplash ( [FSplashData](API\Plugins\XRBase\FSplashData) & Splash )
[]
FDefaultXRLoadingScreen::HideLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
Hides the loading screen.
XRBase
virtual void HideLoadingScreen()
[]
FDefaultXRLoadingScreen::IsPlayingLoadingMovie
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
Returns whether a loading movie is playing or not.
XRBase
virtual bool IsPlayingLoadingMovie() const
[]
FDefaultXRLoadingScreen::ShowLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
IXRLoadingScreeninterface
XRBase
virtual void ShowLoadingScreen()
[]
FDefaultXRLoadingScreen::FDefaultXRLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
FDefaultXRLoadingScreen ( class [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) * InTrackingSystem )
[]
FDefaultXRLoadingScreen
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
class FDefaultXRLoadingScreen : public [TXRLoadingScreenBase< FSplashData >](API\Plugins\XRBase\TXRLoadingScreenBase)
[]
FDeviceModelLoadedDelegate
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h
UAsyncTask_LoadXRDeviceVisComponent
XRBase
class FDeviceModelLoadedDelegate
[]
FHeadMountedDisplayBase::CalculateStereoViewOffset
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Calculates the offset for the camera position, given the specified position, rotation, and world scale Specifying eSSE_MONOSCOPIC for the view index returns a center offset behind the stereo views
XRBase
virtual void CalculateStereoViewOffset ( const int32 ViewIndex, FRotator & ViewRotation, const float WorldToMeters, FVector & ViewLocation )
[]
FHeadMountedDisplayBase::CopyTexture_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Helper to copy one render target into another for spectator screen display.
XRBase
virtual void CopyTexture_RenderThread ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, FRHITexture2D * SrcTexture, FIntRect SrcRect, FRHITexture2D * DstTexture, FIntRect DstRect, bool bClearBlack, bool bNoAlpha ) const
[]
CVarSink
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
XRBase
static [FAutoConsoleVariableSink](API\Runtime\Core\HAL\FAutoConsoleVariableSink) CVarSink;
[]
FHeadMountedDisplayBase::CVarSinkHandler
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
CVar sink for pixel density
XRBase
static void CVarSinkHandler()
[]
FHeadMountedDisplayBase::GetEyeCenterPoint_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Spectator Screen Hooks into specific implementations Get the point on the left eye render target which the viewers eye is aimed directly at when looking straight forward. 0,0 is top left.
XRBase
virtual FVector2D GetEyeCenterPoint_RenderThread ( const int32 ViewIndex ) const
[]
FHeadMountedDisplayBase::GetFullFlatEyeRect_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Get the rectangle of the HMD rendertarget for the left eye which seems undistorted enough to be cropped and displayed on the spectator screen.
XRBase
virtual FIntRect GetFullFlatEyeRect_RenderThread ( FTexture2DRHIRef EyeTexture ) const
[]
FHeadMountedDisplayBase::GetHMDDistortionEnabled
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Whether HMDDistortion post processing is enabled or not
XRBase
virtual bool GetHMDDistortionEnabled ( EShadingPath ShadingPath ) const
[]
FHeadMountedDisplayBase::GetHMDName
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Retrieves the HMD name, by default this is the same as the system name.
XRBase
virtual [FName](API\Runtime\Core\UObject\FName) GetHMDName() const
[]
FHeadMountedDisplayBase::GetOverlayLayerTarget_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Return a FTexture2DRHIRef pointing to a texture that can be composed on top of each eye without applying reprojection to it. Return nullptr to render head locked stereo layers into the same render target as other layer types, in which case InOutViewport must not be modified.
XRBase
virtual FTexture2DRHIRef GetOverlayLayerTarget_RenderThread ( int32 ViewIndex, FIntRect & InOutViewport )
[]
FHeadMountedDisplayBase::GetSceneLayerTarget_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Implement this method to override the render target for scene based stereo layers. Return nullptr to render stereo layers into the normal render target passed to the stereo layers scene view extension, in which case OutViewport must not be modified.
XRBase
virtual FTexture2DRHIRef GetSceneLayerTarget_RenderThread ( int32 ViewIndex, FIntRect & InOutViewport )
[]
FHeadMountedDisplayBase::GetSpectatorScreenController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Return a pointer to the SpectatorScreenController for the HMD if supported, else null. The controller is owned by the HMD, and will be destroyed when the HMD is destroyed.
XRBase
virtual [ISpectatorScreenController](API\Runtime\HeadMountedDisplay\ISpectatorScreenController) * GetSpectatorScreenController()
[]
FHeadMountedDisplayBase::GetSpectatorScreenController
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
XRBase
virtual [ISpectatorScreenController](API\Runtime\HeadMountedDisplay\ISpectatorScreenController) const * GetSpectatorScreenController() const
[]
FHeadMountedDisplayBase::GetStereoLayers
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Default stereo layer implementation
XRBase
virtual [IStereoLayers](API\Runtime\Engine\IStereoLayers) * GetStereoLayers()
[]
FHeadMountedDisplayBase::InitCanvasFromView
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Sets view-specific params (such as view projection matrix) for the canvas.
XRBase
virtual void InitCanvasFromView ( [FSceneView](API\Runtime\Engine\FSceneView) * InView, [UCanvas](API\Runtime\Engine\Engine\UCanvas) * Canvas )
[]
FHeadMountedDisplayBase::IsHeadTrackingAllowed
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
DefaultIXRTrackingSystemimplementation
XRBase
virtual bool IsHeadTrackingAllowed() const
[]
FHeadMountedDisplayBase::IsHeadTrackingEnforced
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
OptionalIXRTrackingSystemmethods.
XRBase
virtual bool IsHeadTrackingEnforced() const
[]
FHeadMountedDisplayBase::OnLateUpdateApplied_RenderThread
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Called just after the late update on the render thread passing back the current relative transform.
XRBase
virtual void OnLateUpdateApplied_RenderThread ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, const FTransform & NewRelativeTransform )
[]
FHeadMountedDisplayBase::IsSpectatorScreenActive
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Are we outputting so a Spectator Screen now.
XRBase
virtual bool IsSpectatorScreenActive() const
[]
PixelDensityMax
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
XRBase
static constexpr float PixelDensityMax = 2.0f;
[]
PixelDensityMin
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Sane pixel density values.
XRBase
static constexpr float PixelDensityMin = 0.1f;
[]
FHeadMountedDisplayBase::PopulateAnalyticsAttributes
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Return false to disable recording the analytics event
XRBase
virtual bool PopulateAnalyticsAttributes ( [TArray](API\Runtime\Core\Containers\TArray)< struct [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttributes )
[]
FHeadMountedDisplayBase::RecordAnalytics
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Record analytics - To add custom information logged with the analytics, override PopulateAnalyticsAttributes
XRBase
virtual void RecordAnalytics()
[]
FHeadMountedDisplayBase::SetHeadTrackingEnforced
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Can be used to enforce tracking even when stereo rendering is disabled. The default implementation does not allow enforcing tracking and ignores the argument.
XRBase
virtual void SetHeadTrackingEnforced ( bool bEnabled )
[]
FHeadMountedDisplayBase::FHeadMountedDisplayBase
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
XRBase
FHeadMountedDisplayBase ( [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * InARImplementation )
[]
FHeadMountedDisplayBase::~FHeadMountedDisplayBase
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
XRBase
virtual ~FHeadMountedDisplayBase()
[]
FHeadMountedDisplayBase
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayBase.h
Default implementation for variousIHeadMountedDisplaymethods. You can extend this class instead ofIHeadMountedDisplaydirectly when implementing support for new HMD devices.
XRBase
class FHeadMountedDisplayBase : public [FXRTrackingSystemBase](API\Plugins\XRBase\FXRTrackingSystemBase), public [IHeadMountedDisplay](API\Runtime\HeadMountedDisplay\IHeadMountedDisplay), public [IStereoRendering](API\Runtime\Engine\IStereoRendering)
[ { "type": "TSharedPtr< cla...", "name": "DefaultStereoLayers", "description": "" }, { "type": "TUniquePtr<FDe...", "name": "SpectatorScreenController", "description": "" } ]
FSimpleLayerManager
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h
XRBase
class FSimpleLayerManager : public [TStereoLayerManager< IStereoLayers::FLayerDesc >](API\Plugins\XRBase\TStereoLayerManager)
[]
FSimpleLayerManager::MarkTextureForUpdate
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h
Marks this layers texture for update
XRBase
virtual void MarkTextureForUpdate ( uint32 LayerId )
[]
FSpectatorScreenRenderDelegate
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultSpectatorScreenController.h
XRBase
typedef TBaseDelegate_FiveParams< void, [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) &, FTexture2DRHIRef, FTexture2DRHIRef, FTexture2DRHIRef, FVector2D > FSpectatorScreenRenderDelegate
[]
FSplashData::FSplashData
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
XRBase
FSplashData ( const [IXRLoadingScreen::FSplashDesc](API\Runtime\HeadMountedDisplay\IXRLoadingScreen\FSplashDesc) & InDesc )
[]
FSplashData
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/DefaultXRLoadingScreen.h
Default Loading Screen implementation based on the IStereoLayer interface. It requires an XR tracking system with stereo rendering and stereo layers support.
XRBase
struct FSplashData
[ { "type": "IXRLoadingScree...", "name": "Desc", "description": "" }, { "type": "uint32", "name": "LayerId", "description": "" } ]
FXRDeviceOnDisconnectDelegate
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h
XRBase
class FXRDeviceOnDisconnectDelegate
[]
FXRMotionControllerBase::EnumerateSources
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h
Called to request the motion sources that thisIMotionControllerprovides
XRBase
virtual void EnumerateSources ( [TArray](API\Runtime\Core\Containers\TArray)< [FMotionControllerSource](API\Runtime\HeadMountedDisplay\FMotionControllerSource) > & SourcesOut ) const
[]
FXRMotionControllerBase::GetControllerOrientationAndPositionForTime
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h
Note: In this class we are providing a default implementation of GetControllerOrientationAndPosition with velocity, etc parameters and GetControllerOrientationAndPositionForTime that never provide that data and require override of the four param version because this is the most common implementation now. Any child class that does support some of the additional params should override all three functions.
XRBase
virtual bool GetControllerOrientationAndPositionForTime ( const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource, [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, bool & OutTimeWasUsed, FRotator & OutOrientation, FVector & OutPosition, bool & OutbProvidedLinearVelocity, FVector & OutLinearVelocity, bool & OutbProvidedAngularVelocity, FVector & OutAngularVelocityAsAxisAndLength, bool & OutbProvidedLinearAcceleration, FVector & OutLinearAcceleration, float WorldToMetersScale ) const
[]
FXRMotionControllerBase::GetControllerOrientationAndPosition
/Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h
Note: In this class we are providing a default implementation of GetControllerOrientationAndPosition with velocity, etc parameters and GetControllerOrientationAndPositionForTime that never provide that data and require override of the four param version because this is the most common implementation now. Any child class that does support some of the additional params should override all three functions.
XRBase
bool GetControllerOrientationAndPosition ( const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource, FRotator & OutOrientation, FVector & OutPosition, float WorldToMetersScale ) const
[]