FDefaultSpectatorScreenController

Default implementation of spectator screen controller.

Windows
MacOS
Linux

Inheritance Hierarchy

ISpectatorScreenController

TSharedFromThis

FDefaultSpectatorScreenController

References

Module

HeadMountedDisplay

Header

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

Include

#include "DefaultSpectatorScreenController.h"

Syntax

class FDefaultSpectatorScreenController :
    public ISpectatorScreenController,
    public TSharedFromThis< FDefaultSpectatorScreenController, ESPMode::ThreadSafe >

Remarks

Default implementation of spectator screen controller.

Variables

Constructors

Name Description

Public function

FDefaultSpectatorScreenController

(
    FHeadMountedDisplayBase* InHMD...
)

Destructors

Functions

Name Description

Public function Virtual

void

 

BeginRenderViewFamily()

Implementation methods called by HMD.

Protected function Virtual Const

FRHITexture2...

 

GetFallbackRHITexture()

Protected function Virtual

FIntRect

 

GetFullFlatEyeRect_RenderThread

(
    FTexture2DRHIRef EyeTexture
)

Public function

FSpectatorSc...

 

GetSpectatorScreenRenderDelegate_RenderThread()

Protected function Virtual

void

 

RenderSpectatorModeDistorted

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeMirrorAndTexture

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeSingleEye

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeSingleEyeCroppedToFill

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeSingleEyeLetterboxed

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeTexture

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Protected function Virtual

void

 

RenderSpectatorModeUndistorted

(
    FRHICommandListImmediate& RHICmdLi...,
    FTexture2DRHIRef TargetTexture,
    FTexture2DRHIRef EyeTexture,
    FTexture2DRHIRef OtherTexture,
    FVector2D WindowSize
)

Public function Virtual

void

 

RenderSpectatorScreen_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FRHITexture2D* BackBuffer,
    FTexture2DRHIRef RenderTarget,
    FVector2D WindowSize
)

Protected function Virtual

void

 

SetSpectatorScreenModeTexturePlusEyeLayout_RenderThread

(
    const FSpectatorScreenModeTexturePl...
)

Protected function Virtual

void

 

SetSpectatorScreenModeTexturePlusEyeLayoutRenderCommand

(
    const FSpectatorScreenModeTexturePl...
)

Protected function Virtual

void

 

SetSpectatorScreenTexture_RenderThread

(
    FTexture2DRHIRef& InTexture
)

Protected function Virtual

void

 

SetSpectatorScreenTextureRenderCommand

(
    UTexture* SrcTexture
)

Public function Virtual

void

 

UpdateSpectatorScreenMode_RenderThread()

Overridden from ISpectatorScreenController

Name Description

Public function Virtual Const

ESpectatorSc...

 

GetSpectatorScreenMode()

ISpectatorScreenController.

Public function Virtual Const

UTexture ...

 

GetSpectatorScreenTexture()

Get the texture that would currently be displayed on the social screen (if in a mode that does that)

Public function Virtual

void

 

QueueDebugCanvasLayerID

(
    int32 LayerID
)

Public function Virtual

void

 

SetSpectatorScreenMode

(
    ESpectatorScreenMode Mode
)

Sets the social screen mode.

Public function Virtual

void

 

SetSpectatorScreenModeTexturePlusEyeLayout

(
    const FSpectatorScreenModeTexturePl...
)

Setup the layout for ESpectatorScreenMode::TexturePlusEye.

Public function Virtual

void

 

SetSpectatorScreenTexture

(
    UTexture* InTexture
)

Change the texture displayed on the social screen

Classes

Name

Description

Protected class

Helpers

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