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 > IHeadMountedDisplay

Light Theme

Dark Theme

IHeadMountedDisplay

HMD device interface

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IHeadMountedDisplay

FHeadMountedDisplayBase

References

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

Syntax

class IHeadMountedDisplay : public IModuleInterface

Remarks

HMD device interface

Constructors

	Name	Description
	IHeadMountedDisplay()

Functions

	Name	Description
void	CreateHMDPostProcessPass_RenderThread ( FRDGBuilder& GraphBuilder, const FViewInfo& View, const FHMDDistortionInputs& Inputs, FScreenPassTexture& OutPass )	When implemented, creates a new post process node to provide platform-specific HMD distortion.
bool	DoesAppHaveVRFocus()	Returns true, if the app has VR focus, meaning if it is rendered in the HMD.
bool	DoesAppUseVRFocus()	Returns true, if the App is using VR focus.
void	DrawDistortionMesh_RenderThread ( FRenderingCompositePassContext& Co..., const FIntPoint& TextureSize )
void	DrawHiddenAreaMesh_RenderThread ( FRHICommandList& RHICmdList, EStereoscopicPass StereoPass )	Optional method to draw a view's hidden area mesh where supported.
void	DrawVisibleAreaMesh_RenderThread ( FRHICommandList& RHICmdList, EStereoscopicPass StereoPass )	Optional method to draw a view's visible area mesh where supported.
void	EnableHMD ( bool bEnable )	Enables or disables switching to stereo.
const float ...	GetBlueDistortionParameters()
bool	GetChromaAbCorrectionValues ( FVector4& K )	Gets the chromatic aberration correction shader values for the device.
float	GetDistortionScalingFactor()	Gets the scaling factor, applied to the post process warping effect
FTexture ...	GetDistortionTextureLeft()	Additional optional distortion rendering parameters
FTexture ...	GetDistortionTextureRight()
void	GetDistortionWarpValues ( FVector4& K )	Gets the barrel distortion shader warp values for the device
void	GetEyeRenderParams_RenderThread ( const FRenderingCompositePassContex..., FVector2D& EyeToSrcUVScaleValue, FVector2D& EyeToSrcUVOffsetValue )	Returns eye render params, used from PostProcessHMD, RenderThread.
void	GetFieldOfView ( float& InOutHFOVInDegrees, float& InOutVFOVInDegrees )	Calculates the FOV, based on the screen dimensions of the device. Original FOV is passed as params.
const float ...	GetGreenDistortionParameters()
bool	GetHMDDistortionEnabled ( EShadingPath ShadingPath )	Whether HMDDistortion post processing is enabled or not
bool	GetHMDMonitorInfo ( MonitorInfo& )	Get the name or id of the display to output for this HMD.
EHMDWornStat...	GetHMDWornState()	Returns EHMDWornState::Worn if we detect that the user is wearing the HMD, EHMDWornState::NotWorn if we detect the user is not wearing the HMD, and EHMDWornState::Unknown if we cannot detect the state.
FIntPoint	GetIdealDebugCanvasRenderTargetSize()	Gets the ideal render target size for the debug canvas on the device.
FIntPoint	GetIdealRenderTargetSize()	Gets the ideal render target size for the device. See vr.pixeldensity description.
float	GetInterpupillaryDistance()
float	GetLensCenterOffset()	Gets the offset (in clip coordinates) from the center of the screen for the lens position
float	GetPixelDenity()	Gets the current pixel density setting.
const float ...	GetRedDistortionParameters()
ISpectatorSc...	GetSpectatorScreenController()	Return a pointer to the SpectatorScreenController for the HMD if supported, else null.
ISpectatorSc...	GetSpectatorScreenController()
FVector2D	GetTextureOffsetLeft()
FVector2D	GetTextureOffsetRight()
FVector2D	GetTextureScaleLeft()
FVector2D	GetTextureScaleRight()
bool	HasHiddenAreaMesh()
bool	HasVisibleAreaMesh()
bool	IsChromaAbCorrectionEnabled()	Returns 'false' if chromatic aberration correction is off.
bool	IsHMDConnected()	Returns true if HMD is currently connected. It may or may not be in use.
bool	IsHMDEnabled()	Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing.
bool	IsRenderingPaused()	If true, scene rendering should be skipped.
bool	IsSpectatorScreenActive()	Are we outputting so a Spectator Screen now.
bool	NeedsUpscalePostProcessPass()
void	RecordAnalytics()	Record analytics
void	SetClippingPlanes ( float NCP, float FCP )	Sets near and far clipping planes (NCP and FCP) for the HMD.
void	SetInterpupillaryDistance ( float NewInterpupillaryDistance )	Accessors to modify the interpupillary distance (meters)
void	SetPixelDensity ( const float NewDensity )	Sets the pixel density. This may cause render target resizing.
void	UpdateScreenSettings ( const FViewport* InViewport )	This method is able to change screen settings right before any drawing occurs.

Classes

	Name	Description
	MonitorInfo

Deprecated Functions

		Name	Description
	void	BeginRendering_GameThread()	Use IXRTrackingSystem::OnBeginRendering_GameThread instead
	void	BeginRendering_RenderThread ( const FTransform& NewRelativeTrans..., FRHICommandListImmediate& RHICmdLi..., FSceneViewFamily& ViewFamily )	Use IXRTrackingSystem::OnBeginRendering_Renderthread instead

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

Take our survey

Dismiss