FDefaultStereoLayers

Default implementation of stereo layers for platforms that require emulating layer support.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/DefaultStereoLayers.h

Include

#include "DefaultStereoLayers.h"

Syntax

class FDefaultStereoLayers :
    public FSimpleLayerManager,
    public FSceneViewExtensionBase

Remarks

Default implementation of stereo layers for platforms that require emulating layer support.

FHeadmountedDisplayBase subclasses will use this implementation by default unless overridden.

Variables

Constructors

Name Description

Public function

FDefaultStereoLayers

(
    const FAutoRegister& AutoRegister,
    FHeadMountedDisplayBase* InHMD...
)

Functions

Name Description

Protected function Const

void

 

StereoLayerRender

(
    FRHICommandListImmediate& RHICmdLi...,
    const TArray< uint32 >& LayersToRe...,
    const FLayerRenderParams& RenderPa...
)

Protected function

void

 

UpdateHmdTransform

(
    const FTransform& InHmdTransform
)

Invoked by FHeadMountedDisplayBase to update the HMD position during the late update.

Overridden from IStereoLayers

Name Description

Public function Virtual

void

 

GetAllocatedTexture

(
    uint32 LayerId,
    FTextureRHIRef& Texture,
    FTextureRHIRef& LeftTexture
)

Get texture reference to HMD swapchain to avoid the copy path, useful for continuous update layers

Public function Virtual Const

bool

 

ShouldCopyDebugLayersToSpectatorScreen()

If true the debug layers are copied to the spectator screen, because they do not naturally end up on the spectator screen as part of the 3d view.

Public function Virtual

void

 

UpdateSplashScreen()

Update splash screens from current state

Overridden from ISceneViewExtension

Name Description

Public function Virtual

void

 

BeginRenderViewFamily

(
    FSceneViewFamily& InViewFamily
)

Called on game thread when view family is about to be rendered.

Public function Virtual Const

bool

 

IsActiveThisFrame

(
    FViewport* InViewport
)

Returning false disables the extension for the current frame.

Public function Virtual

void

 

PostRenderView_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FSceneView& InView
)

Allows to render content after the 3D content scene, useful for debugging

Public function Virtual

void

 

PreRenderView_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FSceneView& InView
)

Called on render thread at the start of rendering, for each view, after PreRenderViewFamily_RenderThread call.

Public function Virtual

void

 

PreRenderViewFamily_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FSceneViewFamily& InViewFamily
)

Called on render thread at the start of rendering.

Public function Virtual

void

 

SetupView

(
    FSceneViewFamily& InViewFamily,
    FSceneView& InView
)

Called on game thread when creating the view.

Public function Virtual

void

 

SetupViewFamily

(
    FSceneViewFamily& InViewFamily
)

ISceneViewExtension interface

Classes

Name

Description

Protected struct

FLayerRenderParams

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback