1. Epic GamesDeveloper
  3. IHeadMountedDisplay

IHeadMountedDisplay

HMD device interface

Unreal Engine C++ API Reference > Runtime > HeadMountedDisplay

Inheritance Hierarchy

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

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual Const void When implemented, creates a new post process node to provide platform-specific HMD distortion.
Public function Virtual Const bool Returns true, if the app has VR focus, meaning if it is rendered in the HMD.
Public function Virtual Const bool Returns true, if the App is using VR focus.
Public function Virtual void

DrawDistortionMesh_RenderThread ( FHeadMountedDisplayPassContext& Context,
const FIntPoint& TextureSize
)

  
Public function Virtual Const void

DrawHiddenAreaMesh ( FRHICommandList& RHICmdList,
int32 ViewIndex
)

 Optional method to draw a view's hidden area mesh where supported.
Public function Virtual Const void

DrawVisibleAreaMesh ( FRHICommandList& RHICmdList,
int32 ViewIndex
)

 Optional method to draw a view's visible area mesh where supported.
Public function void

EnableHMD ( bool bEnable
)

 Enables or disables switching to stereo.
Public function Virtual Const const float *  
Public function Virtual Const bool

GetChromaAbCorrectionValues ( FVector4& K
)

 Gets the chromatic aberration correction shader values for the device.
Public function Virtual Const float Gets the scaling factor, applied to the post process warping effect
Public function Virtual Const FTexture * Additional optional distortion rendering parameters
Public function Virtual Const FTexture *  
Public function Virtual Const void

GetDistortionWarpValues ( FVector4& K
)

 Gets the barrel distortion shader warp values for the device
Public function Virtual Const void

GetEyeRenderParams_RenderThread ( const FHeadMountedDisplayPassContext& Context,
FVector2D& EyeToSrcUVScaleValue,
FVector2D& EyeToSrcUVOffsetValue
)

 Returns eye render params, used from PostProcessHMD, RenderThread.
Public function Const void

GetFieldOfView ( float& InOutHFOVInDegrees,
float& InOutVFOVInDegrees
)

 Calculates the FOV, based on the screen dimensions of the device. Original FOV is passed as params.
Public function Virtual Const const float *  
Public function Const bool

GetHMDDistortionEnabled ( EShadingPath ShadingPath
)

 Whether HMDDistortion post processing is enabled or not
Public function bool Get the name or id of the display to output for this HMD.
Public function Const FName Retrieves the HMD name.
Public function Virtual EHMDWornState::Type 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.
Public function Virtual Const FIntPoint Gets the ideal render target size for the debug canvas on the device.
Public function Virtual Const FIntPoint Gets the ideal render target size for the device. See vr.pixeldensity description.
Public function Const float  
Public function Virtual Const float Gets the offset (in clip coordinates) from the center of the screen for the lens position
Public function Virtual Const float Gets the current pixel density setting.
Public function Virtual Const const float *  
Public function Virtual ISpectatorScreenController * Return a pointer to the SpectatorScreenController for the HMD if supported, else null.
Public function Virtual Const ISpectatorScreenController const *  
Public function Virtual Const FVector2D  
Public function Virtual Const FVector2D  
Public function Virtual Const FVector2D  
Public function Virtual Const FVector2D  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool Returns 'false' if chromatic aberration correction is off.
Public function bool Returns true if HMD is currently connected. It may or may not be in use.
Public function Const bool Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing.
Public function Virtual Const bool If true, scene rendering should be skipped.
Public function Virtual Const bool Are we outputting so a Spectator Screen now.
Public function Virtual bool  
Public function Virtual void Record analytics
Public function Virtual void

SetClippingPlanes ( float NCP,
float FCP
)

 Sets near and far clipping planes (NCP and FCP) for the HMD.
Public function void

SetInterpupillaryDistance ( float NewInterpupillaryDistance
)

 Accessors to modify the interpupillary distance (meters)
Public function Virtual void

SetPixelDensity ( const float NewDensity
)

 Sets the pixel density. This may cause render target resizing.
Public function Virtual void

UpdateScreenSettings ( const FViewport* InViewport
)

 This method is able to change screen settings right before any drawing occurs.

Classes

  Type Name Description
Public struct MonitorInfo    

Deprecated Functions

  Type Name Description
Public function Virtual void Use IXRTrackingSystem::OnBeginRendering_GameThread instead
Public function Virtual void

BeginRendering_RenderThread ( const FTransform& NewRelativeTransform,
FRHICommandListImmediate& RHICmdList,
FSceneViewFamily& ViewFamily
)

 Use IXRTrackingSystem::OnBeginRendering_Renderthread instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page