1. Epic GamesDeveloper
  3. FPixelStreamingHMD

FPixelStreamingHMD

Pixel Streamed Head Mounted Display

API > API/Plugins > API/Plugins/PixelStreamingHMD

Inheritance Hierarchy

References

   
Module PixelStreamingHMD
Header /Engine/Plugins/Media/PixelStreaming/Source/PixelStreamingHMD/Public/PixelStreamingHMD.h
Include #include "PixelStreamingHMD.h"

Syntax

class FPixelStreamingHMD :  
    public FHeadMountedDisplayBase ,  
    public FHMDSceneViewExtension

Remarks

Pixel Streamed Head Mounted Display

Constructors

  Type Name Description
Public function  

FPixelStreamingHMD ( const FAutoRegister&
)

 Constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function Virtual Const void

AdjustViewRect ( int32 ViewIndex,
int32& X,
int32& Y,
uint32& SizeX,
uint32& SizeY
)

  
Public function Virtual void

BeginRenderViewFamily ( FSceneViewFamily& InViewFamily
)

  
Public function Virtual bool

EnableStereo ( bool stereo
)

  
Public function Virtual Const FMatrix

GetStereoProjectionMatrix ( const int32 ViewIndex
)

  
Public function Const bool  
Public function Virtual Const bool IStereoRendering interface
Public function Virtual void

PreRenderView_RenderThread ( FRDGBuilder& GraphBuilder,
FSceneView& InView
)

  
Public function Virtual void

PreRenderViewFamily_RenderThread ( FRDGBuilder& GraphBuilder,
FSceneViewFamily& InViewFamily
)

  
Public function void

SetEyeViews ( FTransform Left,
FMatrix LeftProj,
FTransform Right,
FMatrix RightProj,
FTransform HMD
)

  
Public function void

SetTransform ( FTransform Transform
)

  
Public function Virtual void

SetupView ( FSceneViewFamily& InViewFamily,
FSceneView& InView
)

  
Public function Virtual void

SetupViewFamily ( FSceneViewFamily& InViewFamily
)

 ISceneViewExtension interface

Overridden from FHeadMountedDisplayBase

  Type Name Description
Public function Virtual void

CalculateStereoViewOffset ( const int32 ViewIndex,
FRotator& ViewRotation,
const float InWorldToMeters,
FVector& ViewLocation
)

  

Overridden from IXRTrackingSystem

  Type Name Description
Public function Virtual bool Reports all devices currently available to the system, optionally limiting the result to a given class of devices.
Public function Virtual Const FQuat Returns current base orientation of HMD as a quaternion.
Public function Virtual Const FVector Returns current base position of HMD.
Public function Virtual Const FRotator Returns current base orientation of HMD as yaw-pitch-roll combination.
Public function Virtual bool

GetCurrentPose ( int32 DeviceId,
FQuat& CurrentOrientation,
FVector& CurrentPosition
)

 Get the current pose for a device.
Public function Virtual IHeadMountedDisplay * Access HMD rendering-related features.
Public function Virtual bool

GetRelativeEyePose ( int32 DeviceId,
int32 ViewIndex,
FQuat& OutOrientation,
FVector& OutPosition
)

 If the device id represents a head mounted display, fetches the relative position of the given eye relative to the eye.
Public function Virtual TSharedPtr< class IStereoRendering, ESPMode::ThreadSafe > Access Stereo rendering device associated with this XR system.
Protected function Virtual Const float FXRTrackingSystemBase protected interface
Public function Virtual Const int32 Returns device specific flags.
Public function Virtual void

ResetOrientation ( float Yaw
)

 Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction.
Public function Virtual void Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction and assuming current position as a 'zero-point' (for positional tracking).
Public function Virtual void Resets position, assuming current position as a 'zero-point'.
Public function Virtual void

SetBaseOrientation ( const FQuat& BaseOrient
)

 Sets base orientation, assuming that this is forward direction. Position is not changed.
Public function Virtual void

SetBasePosition ( const FVector& InBasePosition
)

 Sets base position of the HMD.
Public function Virtual void

SetBaseRotation ( const FRotator& BaseRot
)

 Sets base orientation by setting yaw, pitch, roll, assuming that this is forward direction.

Overridden from IXRSystemIdentifier

  Type Name Description
Public function Virtual Const FName IXRTrackingSystem interface

Overridden from IHeadMountedDisplay

  Type Name Description
Public function Virtual void

DrawDistortionMesh_RenderThread ( FHeadMountedDisplayPassContext& Context,
const FIntPoint& TextureSize
)

  
Public function Virtual void

EnableHMD ( bool allow
)

 Enables or disables switching to stereo.
Public function Virtual Const void

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

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

GetFieldOfView ( float& OutHFOVInDegrees,
float& OutVFOVInDegrees
)

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

GetHMDDistortionEnabled ( EShadingPath ShadingPath
)

 Whether HMDDistortion post processing is enabled or not
Public function Virtual bool Get the name or id of the display to output for this HMD.
Public function Virtual Const float  
Public function Virtual Const bool Returns 'false' if chromatic aberration correction is off.
Public function Virtual bool IHeadMountedDisplay interface
Public function Virtual Const bool Whether or not switching to stereo is enabled; if it is false, then EnableStereo(true) will do nothing.
Public function Virtual void

SetInterpupillaryDistance ( float NewInterpupillaryDistance
)

 Accessors to modify the interpupillary distance (meters)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page