| IModuleInterface
|
Module |
|
Header |
/Engine/Source/Runtime/HeadMountedDisplay/Public/IHeadMountedDisplay.h |
Include |
#include "IHeadMountedDisplay.h" |
class IHeadMountedDisplay : public IModuleInterface
HMD device interface
Name | Description | |
---|---|---|
|
IHeadMountedDisplay() |
Name | Description | ||
---|---|---|---|
|
CreateHMDPostProcessPass_RenderThread ( |
When implemented, creates a new post process node to provide platform-specific HMD distortion. |
|
|
DoesAppHaveVRFocus() |
Returns true, if the app has VR focus, meaning if it is rendered in the HMD. |
|
|
DoesAppUseVRFocus() |
Returns true, if the App is using VR focus. |
|
|
DrawDistortionMesh_RenderThread ( |
||
|
DrawHiddenAreaMesh_RenderThread ( |
Optional method to draw a view's hidden area mesh where supported. |
|
|
DrawVisibleAreaMesh_RenderThread ( |
Optional method to draw a view's visible area mesh where supported. |
|
|
EnableHMD ( |
Enables or disables switching to stereo. |
|
|
const float ... |
GetBlueDistortionParameters() |
|
|
GetChromaAbCorrectionValues ( |
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() |
|
|
GetDistortionWarpValues ( |
Gets the barrel distortion shader warp values for the device |
|
|
GetEyeRenderParams_RenderThread |
Returns eye render params, used from PostProcessHMD, RenderThread. |
|
|
GetFieldOfView ( |
Calculates the FOV, based on the screen dimensions of the device. Original FOV is passed as params. |
|
|
const float ... |
GetGreenDistortionParameters() |
|
|
GetHMDDistortionEnabled ( |
Whether HMDDistortion post processing is enabled or not |
|
|
GetHMDMonitorInfo ( |
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. |
|
GetIdealDebugCanvasRenderTargetSize() |
Gets the ideal render target size for the debug canvas on the device. |
|
|
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() |
|
|
GetTextureOffsetLeft() |
||
|
GetTextureOffsetRight() |
||
|
GetTextureScaleLeft() |
||
|
GetTextureScaleRight() |
||
|
HasHiddenAreaMesh() |
||
|
HasVisibleAreaMesh() |
||
|
IsChromaAbCorrectionEnabled() |
Returns 'false' if chromatic aberration correction is off. |
|
|
IsHMDConnected() |
Returns true if HMD is currently connected. It may or may not be in use. |
|
|
IsHMDEnabled() |
Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing. |
|
|
IsRenderingPaused() |
If true, scene rendering should be skipped. |
|
|
IsSpectatorScreenActive() |
Are we outputting so a Spectator Screen now. |
|
|
NeedsUpscalePostProcessPass() |
||
|
RecordAnalytics() |
Record analytics |
|
|
SetClippingPlanes ( |
Sets near and far clipping planes (NCP and FCP) for the HMD. |
|
|
SetInterpupillaryDistance ( |
Accessors to modify the interpupillary distance (meters) |
|
|
SetPixelDensity ( |
Sets the pixel density. This may cause render target resizing. |
|
|
UpdateScreenSettings ( |
This method is able to change screen settings right before any drawing occurs. |
Name |
Description |
|
---|---|---|
|
MonitorInfo |
Name | Description | ||
---|---|---|---|
|
BeginRendering_GameThread() |
Use IXRTrackingSystem::OnBeginRendering_GameThread instead |
|
|
BeginRendering_RenderThread ( |
Use IXRTrackingSystem::OnBeginRendering_Renderthread instead |