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 > Engine > IStereoLayers

Light Theme

Dark Theme

IStereoLayers

Windows

MacOS

Linux

Inheritance Hierarchy

IStereoLayers

TStereoLayerManager

FSimpleLayerManager

FDefaultStereoLayers

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/IStereoLayers.h
Include	#include "IStereoLayers.h"

Syntax

class IStereoLayers

Variables

		Name	Description
	bool	bSplashIsShown
	bool	bSplashShowMovie
	uint32	SplashLayerHandle
	FTexture2DRHIRe...	SplashMovie
	FVector	SplashOffset
	FVector2D	SplashScale
	FTexture2DRHIRe...	SplashTexture

Destructors

	Name	Description
	~IStereoLayers()

Functions

	Name	Description
uint32	CreateLayer ( const FLayerDesc& InLayerDesc )	Creates a new layer from a given texture resource, which is projected on top of the world as a quad.
void	DestroyLayer ( uint32 LayerId )	Destroys the specified layer, stopping it from rendering over the world.
void	GetAllocatedTexture ( uint32 LayerId, FTextureRHIRef& Texture, FTextureRHIRef& LeftTexture )	Get texture reference to HMD swapchain to avoid the copy path, useful for continuous update layers
FLayerDesc	GetDebugCanvasLayerDesc ( FTextureRHIRef Texture )
bool	GetLayerDesc ( uint32 LayerId, FLayerDesc& OutLayerDesc )	Get the currently set layer description
void	HideBackgroundLayer()	Optional method to hide the 3D scene and only render the stereo overlays.
bool	IsBackgroundLayerVisible()	Tell if the background layer is visible.
void	MarkTextureForUpdate ( uint32 LayerId )	Marks this layers texture for update
void	PopLayerState()	Restores the stereo layer state from the last save state.
void	PushLayerState ( bool bPreserve )	Saves the current stereo layer state on a stack to later restore them.
void	SetLayerDesc ( uint32 LayerId, const FLayerDesc& InLayerDesc )	Set the a new layer description
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.
void	ShowBackgroundLayer()	Optional method to undo the effect of hiding the 3D scene. No-op if not supported by the platform.
bool	SupportsLayerState()	Returns true if the StereoLayers implementation supports saving and restoring state using Push/PopLayerState()
void	UpdateSplashScreen()	Update splash screens from current state

Classes

	Name	Description
	FLayerDesc	Structure describing the visual appearance of a single stereo layer

Enums

	Name	Description
	ELayerFlags
	ELayerType

Deprecated Functions

	Name	Description
void	HideSplashScreen()	Use the IXRLoadingScreen interface instead of IStereoLayers::*SplashScreen
void	SetSplashScreen ( FTextureRHIRef Texture, FVector2D Scale, FVector Offset, bool bShowLoadingMovie )	Use the IXRLoadingScreen interface instead of IStereoLayers::*SplashScreen
void	SetSplashScreenMovie ( FTextureRHIRef Texture )	Use the IXRLoadingScreen interface instead of IStereoLayers::*SplashScreen
void	ShowSplashScreen()	Use the IXRLoadingScreen interface instead of IStereoLayers::*SplashScreen

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

Take our survey

Dismiss