Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > HeadMountedDisplay > FDefaultSpectatorScreenController

Light Theme

Dark Theme

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

		Name	Description
	TArray< int32 >	DebugCanvasLayerIDs
	ESpectatorScree...	NewSpectatorScreenMode
	FCriticalSectio...	NewSpectatorScreenModeLock
	FSpectatorScree...	SpectatorScreenDelegate_RenderThread
	ESpectatorScree...	SpectatorScreenMode_RenderThread
	FSpectatorScree...	SpectatorScreenModeTexturePlusEyeLayout_RenderThread
	TWeakObjectPtr<...	SpectatorScreenTexture
	FTexture2DRHIRe...	SpectatorScreenTexture_RenderThread

Constructors

	Name	Description
	FDefaultSpectatorScreenController ( FHeadMountedDisplayBase* InHMD... )

Destructors

	Name	Description
	~FDefaultSpectatorScreenController()

Functions

	Name	Description
void	BeginRenderViewFamily()	Implementation methods called by HMD.
FRHITexture2...	GetFallbackRHITexture()
FIntRect	GetFullFlatEyeRect_RenderThread ( FTexture2DRHIRef EyeTexture )
FSpectatorSc...	GetSpectatorScreenRenderDelegate_RenderThread()
void	RenderSpectatorModeDistorted ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeMirrorAndTexture ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeSingleEye ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeSingleEyeCroppedToFill ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeSingleEyeLetterboxed ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeTexture ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorModeUndistorted ( FRHICommandListImmediate& RHICmdLi..., FTexture2DRHIRef TargetTexture, FTexture2DRHIRef EyeTexture, FTexture2DRHIRef OtherTexture, FVector2D WindowSize )
void	RenderSpectatorScreen_RenderThread ( FRHICommandListImmediate& RHICmdLi..., FRHITexture2D* BackBuffer, FTexture2DRHIRef RenderTarget, FVector2D WindowSize )
void	SetSpectatorScreenModeTexturePlusEyeLayout_RenderThread ( const FSpectatorScreenModeTexturePl... )
void	SetSpectatorScreenModeTexturePlusEyeLayoutRenderCommand ( const FSpectatorScreenModeTexturePl... )
void	SetSpectatorScreenTexture_RenderThread ( FTexture2DRHIRef& InTexture )
void	SetSpectatorScreenTextureRenderCommand ( UTexture* SrcTexture )
void	UpdateSpectatorScreenMode_RenderThread()

Overridden from ISpectatorScreenController

	Name	Description
ESpectatorSc...	GetSpectatorScreenMode()	ISpectatorScreenController.
UTexture ...	GetSpectatorScreenTexture()	Get the texture that would currently be displayed on the social screen (if in a mode that does that)
void	QueueDebugCanvasLayerID ( int32 LayerID )
void	SetSpectatorScreenMode ( ESpectatorScreenMode Mode )	Sets the social screen mode.
void	SetSpectatorScreenModeTexturePlusEyeLayout ( const FSpectatorScreenModeTexturePl... )	Setup the layout for ESpectatorScreenMode::TexturePlusEye.
void	SetSpectatorScreenTexture ( UTexture* InTexture )	Change the texture displayed on the social screen

Classes

	Name	Description
	Helpers

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss