ISpectatorScreenController Class Reference

#include <ISpectatorScreenController.h>

Inheritance diagram for ISpectatorScreenController:

Public Member Functions
virtual	~ISpectatorScreenController ()
virtual void	SetSpectatorScreenMode (ESpectatorScreenMode Mode)=0
virtual ESpectatorScreenMode	GetSpectatorScreenMode () const =0
virtual void	SetSpectatorScreenTexture (UTexture *InTexture)=0
virtual UTexture *	GetSpectatorScreenTexture () const
virtual void	SetSpectatorScreenModeTexturePlusEyeLayout (const FSpectatorScreenModeTexturePlusEyeLayout &Layout)=0
virtual void	QueueDebugCanvasLayerID (int32 LayerID) final

Static Public Member Functions
static FName	GetModularFeatureName ()

Detailed Description

Spectator Screen Controller interface

This is the interface to control the spectator screen, on platforms that support it.

Constructor & Destructor Documentation

~ISpectatorScreenController()

virtual ISpectatorScreenController::~ISpectatorScreenController ( )

inlinevirtual

Member Function Documentation

GetModularFeatureName()

static FName ISpectatorScreenController::GetModularFeatureName ( )

inlinestatic

GetSpectatorScreenMode()

virtual ESpectatorScreenMode ISpectatorScreenController::GetSpectatorScreenMode ( ) const

pure virtual

GetSpectatorScreenTexture()

virtual UTexture * ISpectatorScreenController::GetSpectatorScreenTexture ( ) const

inlinevirtual

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

QueueDebugCanvasLayerID()

virtual void ISpectatorScreenController::QueueDebugCanvasLayerID ( int32  LayerID )

inlinefinalvirtual

SetSpectatorScreenMode()

virtual void ISpectatorScreenController::SetSpectatorScreenMode ( ESpectatorScreenMode  Mode )

pure virtual

Sets the social screen mode.

Parameters

Mode	(in) The social screen Mode.

SetSpectatorScreenModeTexturePlusEyeLayout()

virtual void ISpectatorScreenController::SetSpectatorScreenModeTexturePlusEyeLayout ( const FSpectatorScreenModeTexturePlusEyeLayout &  Layout )

pure virtual

Setup the layout for ESpectatorScreenMode::TexturePlusEye.

Parameters

EyeRectMin	min of screen rectangle the eye will be drawn in. 0-1 normalized.
EyeRectMax	max of screen rectangle the eye will be drawn in. 0-1 normalized.
TextureRectMin	min of screen rectangle the texture will be drawn in. 0-1 normalized.
TextureRectMax	max of screen rectangle the texture will be drawn in. 0-1 normalized.
bDrawEyeFirst	if true the eye is drawn before the texture, if false the reverse.
bClearBlack	if true the render target will be drawn black before either rect is drawn.

SetSpectatorScreenTexture()

virtual void ISpectatorScreenController::SetSpectatorScreenTexture ( UTexture *  InTexture )

pure virtual

Change the texture displayed on the social screen

Parameters

InTexture

new Texture2D

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/HeadMountedDisplay/Public/ISpectatorScreenController.h