Navigation
API > API/Runtime > API/Runtime/HeadMountedDisplay
HMD device interface
| Name | IHeadMountedDisplay |
| Type | class |
| Header File | /Engine/Source/Runtime/HeadMountedDisplay/Public/IHeadMountedDisplay.h |
| Include Path | #include "IHeadMountedDisplay.h" |
Syntax
class IHeadMountedDisplay : public IModuleInterface
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IHeadMountedDisplay() |
IHeadMountedDisplay.h |
Structs
| Name | Remarks |
|---|---|
| MonitorInfo |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateHMDPostProcessPass_RenderThread
(
FRDGBuilder& GraphBuilder, |
When implemented, creates a new post process node to provide platform-specific HMD distortion. | IHeadMountedDisplay.h | |
virtual bool DoesAppHaveVRFocus() |
Returns true, if the app has VR focus, meaning if it is rendered in the HMD. | IHeadMountedDisplay.h | |
virtual bool DoesAppUseVRFocus () |
Returns true, if the App is using VR focus. | IHeadMountedDisplay.h | |
virtual void DrawDistortionMesh_RenderThread
(
FHeadMountedDisplayPassContext& Context, |
IHeadMountedDisplay.h | ||
virtual void DrawHiddenAreaMesh
(
FRHICommandList& RHICmdList, |
Optional method to draw a view's hidden area mesh where supported. | IHeadMountedDisplay.h | |
virtual void DrawHiddenAreaMesh
(
FRHICommandList& RHICmdList, |
Optional method to draw a view's hidden area mesh where supported. | IHeadMountedDisplay.h | |
virtual void DrawVisibleAreaMesh
(
FRHICommandList& RHICmdList, |
Optional method to draw a view's visible area mesh where supported. | IHeadMountedDisplay.h | |
virtual void DrawVisibleAreaMesh
(
FRHICommandList& RHICmdList, |
Optional method to draw a view's visible area mesh where supported. | IHeadMountedDisplay.h | |
void EnableHMD
(
bool bEnable |
Enables or disables switching to stereo. | IHeadMountedDisplay.h | |
virtual const float * GetBlueDistortionParameters() |
IHeadMountedDisplay.h | ||
virtual bool GetChromaAbCorrectionValues
(
FVector4& K |
Gets the chromatic aberration correction shader values for the device. | IHeadMountedDisplay.h | |
virtual float GetDistortionScalingFactor() |
Gets the scaling factor, applied to the post process warping effect | IHeadMountedDisplay.h | |
virtual FTexture * GetDistortionTextureLeft() |
Additional optional distortion rendering parameters | IHeadMountedDisplay.h | |
virtual FTexture * GetDistortionTextureRight() |
IHeadMountedDisplay.h | ||
virtual void GetDistortionWarpValues
(
FVector4& K |
Gets the barrel distortion shader warp values for the device | IHeadMountedDisplay.h | |
virtual void GetEyeRenderParams_RenderThread
(
const FHeadMountedDisplayPassContext& Context, |
Returns eye render params, used from PostProcessHMD, RenderThread. | IHeadMountedDisplay.h | |
void GetFieldOfView
(
float& InOutHFOVInDegrees, |
Calculates the FOV, based on the screen dimensions of the device. Original FOV is passed as params. | IHeadMountedDisplay.h | |
virtual const float * GetGreenDistortionParameters() |
IHeadMountedDisplay.h | ||
bool GetHMDDistortionEnabled
(
EShadingPath ShadingPath |
Whether HMDDistortion post processing is enabled or not | IHeadMountedDisplay.h | |
bool GetHMDMonitorInfo
(
MonitorInfo& |
Get the name or id of the display to output for this HMD. | IHeadMountedDisplay.h | |
FName GetHMDName() |
Retrieves the HMD name. | IHeadMountedDisplay.h | |
virtual EHMDWornState::Type 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. | IHeadMountedDisplay.h | |
virtual FIntPoint GetIdealDebugCanvasRenderTargetSize() |
Gets the ideal render target size for the debug canvas on the device. | IHeadMountedDisplay.h | |
virtual FIntPoint GetIdealRenderTargetSize () |
Gets the ideal render target size for the device. | IHeadMountedDisplay.h | |
float GetInterpupillaryDistance() |
IHeadMountedDisplay.h | ||
virtual float GetLensCenterOffset() |
Gets the offset (in clip coordinates) from the center of the screen for the lens position | IHeadMountedDisplay.h | |
virtual float GetPixelDenity() |
Gets the current pixel density setting. | IHeadMountedDisplay.h | |
virtual const float * GetRedDistortionParameters() |
IHeadMountedDisplay.h | ||
virtual ISpectatorScreenController const * GetSpectatorScreenController () |
IHeadMountedDisplay.h | ||
virtual ISpectatorScreenController * GetSpectatorScreenController () |
Return a pointer to the SpectatorScreenController for the HMD if supported, else null. | IHeadMountedDisplay.h | |
virtual FVector2D GetTextureOffsetLeft() |
IHeadMountedDisplay.h | ||
virtual FVector2D GetTextureOffsetRight() |
IHeadMountedDisplay.h | ||
virtual FVector2D GetTextureScaleLeft() |
IHeadMountedDisplay.h | ||
virtual FVector2D GetTextureScaleRight() |
IHeadMountedDisplay.h | ||
virtual bool HasHiddenAreaMesh() |
IHeadMountedDisplay.h | ||
virtual bool HasVisibleAreaMesh() |
IHeadMountedDisplay.h | ||
bool IsChromaAbCorrectionEnabled() |
Returns 'false' if chromatic aberration correction is off. | IHeadMountedDisplay.h | |
bool IsHMDConnected() |
Returns true if HMD is currently connected. It may or may not be in use. | IHeadMountedDisplay.h | |
bool IsHMDEnabled() |
Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing. | IHeadMountedDisplay.h | |
virtual bool IsRenderingPaused() |
If true, scene rendering should be skipped. | IHeadMountedDisplay.h | |
virtual bool IsSpectatorScreenActive() |
Are we outputting so a Spectator Screen now. | IHeadMountedDisplay.h | |
virtual bool NeedsUpscalePostProcessPass() |
IHeadMountedDisplay.h | ||
virtual void RecordAnalytics() |
Record analytics | IHeadMountedDisplay.h | |
virtual void SetClippingPlanes
(
float NCP, |
Sets near and far clipping planes (NCP and FCP) for the HMD. | IHeadMountedDisplay.h | |
virtual bool SetColorScaleAndBias
(
FLinearColor ColorScale, |
Set the multiply and offset colors for composited images in the HMD | IHeadMountedDisplay.h | |
void SetInterpupillaryDistance
(
float NewInterpupillaryDistance |
Accessors to modify the interpupillary distance (meters) | IHeadMountedDisplay.h | |
virtual void SetPixelDensity
(
const float NewDensity |
Sets the pixel density. This may cause render target resizing. | IHeadMountedDisplay.h | |
virtual void UpdateScreenSettings
(
const FViewport* InViewport |
This method is able to change screen settings right before any drawing occurs. | IHeadMountedDisplay.h |