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 > Runtime > HeadMountedDisplay > FHeadMountedDisplayBase

Light Theme

Dark Theme

FHeadMountedDisplayBase

Default implementation for various [IHeadMountedDisplay](API\Runtime\HeadMountedDisplay\IHeadMountedDisplay) methods.

Windows

MacOS

Linux

Inheritance Hierarchy

FXRTrackingSystemBase

IHeadMountedDisplay

IStereoRendering

FHeadMountedDisplayBase

References

Module	HeadMountedDisplay
Header	/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayBase.h
Include	#include "HeadMountedDisplayBase.h"

Syntax

class FHeadMountedDisplayBase :
    public FXRTrackingSystemBase,
    public IHeadMountedDisplay,
    public IStereoRendering

Remarks

Default implementation for various IHeadMountedDisplay methods. You can extend this class instead of IHeadMountedDisplay directly when implementing support for new HMD devices.

Variables

		Name	Description
	TSharedPtr< cla...	DefaultStereoLayers
	TUniquePtr< FDe...	SpectatorScreenController

Constructors

	Name	Description
	FHeadMountedDisplayBase ( IARSystemSupport* InARImplemen... )

Destructors

	Name	Description
	~FHeadMountedDisplayBase()

Functions

	Name	Description
void	CopyTexture_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* SrcTexture, FIntRect SrcRect, FRHITexture2D* DstTexture, FIntRect DstRect, bool bClearBlack, bool bNoAlpha )	Helper to copy one render target into another for spectator screen display.
void	CVarSinkHandler()	CVar sink for pixel density
FVector2D	GetEyeCenterPoint_RenderThread ( EStereoscopicPass Eye )	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.
FIntRect	GetFullFlatEyeRect_RenderThread ( FTexture2DRHIRef EyeTexture )	Get the rectangle of the HMD rendertarget for the left eye which seems undistorted enough to be cropped and displayed on the spectator screen.
FTexture2DRH...	GetOverlayLayerTarget_RenderThread ( EStereoscopicPass StereoPass, FIntRect& InOutViewport )	Implement this method to provide an alternate render target for head locked stereo layer rendering, when using the default Stereo Layers implementation.
FTexture2DRH...	GetSceneLayerTarget_RenderThread ( EStereoscopicPass StereoPass, FIntRect& InOutViewport )	Implement this method to override the render target for scene based stereo layers.
bool	PopulateAnalyticsAttributes ( TArray< struct FAnalyticsEventAttri... )	Called by RecordAnalytics when creating the analytics event sent during HMD initialization.

Overridden from IXRTrackingSystem

	Name	Description
bool	IsHeadTrackingAllowed()	Default IXRTrackingSystem implementation
bool	IsHeadTrackingEnforced()	Optional IXRTrackingSystem methods.
void	OnLateUpdateApplied_RenderThread ( FRHICommandListImmediate& RHICmdLi..., const FTransform& NewRelativeTrans... )	Called just after the late update on the render thread passing back the current relative transform.
void	SetHeadTrackingEnforced ( bool bEnabled )	Can be used to enforce tracking even when stereo rendering is disabled.

Overridden from IHeadMountedDisplay

	Name	Description
bool	GetHMDDistortionEnabled ( EShadingPath ShadingPath )	Whether HMDDistortion post processing is enabled or not
ISpectatorSc...	GetSpectatorScreenController()
ISpectatorSc...	GetSpectatorScreenController()	Return a pointer to the SpectatorScreenController for the HMD if supported, else null.
bool	IsSpectatorScreenActive()	Are we outputting so a Spectator Screen now.
void	RecordAnalytics()	Record analytics - To add custom information logged with the analytics, override PopulateAnalyticsAttributes

Overridden from IStereoRendering

	Name	Description
void	CalculateStereoViewOffset ( const enum EStereoscopicPass Stereo..., FRotator& ViewRotation, const float WorldToMeters, FVector& ViewLocation )	Calculates the offset for the camera position, given the specified position, rotation, and world scale
IStereoLayer...	GetStereoLayers()	Default stereo layer implementation
void	InitCanvasFromView ( FSceneView* InView, UCanvas* Canvas )	Sets view-specific params (such as view projection matrix) for the canvas.

Constants

Name	Description
CVarSink
PixelDensityMax
PixelDensityMin	Sane pixel density values.

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

Take our survey

Dismiss