Navigation
Unreal Engine C++ API Reference > Runtime > Engine
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
Type | Name | Description | |
---|---|---|---|
![]() |
bool | bSplashIsShown | |
![]() |
bool | bSplashShowMovie | |
![]() |
uint32 | SplashLayerHandle | |
![]() |
FTexture2DRHIRef | SplashMovie | |
![]() |
FVector | SplashOffset | |
![]() |
FVector2D | SplashScale | |
![]() |
FTexture2DRHIRef | SplashTexture |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | 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, |
Get texture reference to HMD swapchain to avoid the copy path, useful for continuous update layers |
![]() ![]() |
FLayerDesc | GetDebugCanvasLayerDesc
(
FTextureRHIRef Texture |
|
![]() |
bool | GetLayerDesc
(
uint32 LayerId, |
Get the currently set layer description |
![]() ![]() |
void | Optional method to hide the 3D scene and only render the stereo overlays. | |
![]() ![]() ![]() |
bool | Tell if the background layer is visible. | |
![]() |
void | MarkTextureForUpdate
(
uint32 LayerId |
Marks this layers texture for update |
![]() ![]() |
void | 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, |
Set the a new layer description |
![]() ![]() |
bool | 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 | Optional method to undo the effect of hiding the 3D scene. No-op if not supported by the platform. | |
![]() ![]() |
bool | Returns true if the StereoLayers implementation supports saving and restoring state using Push/PopLayerState() | |
![]() ![]() |
void | Update splash screens from current state |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
FLayerDesc | Structure describing the visual appearance of a single stereo layer |
Enums
Type | Name | Description | |
---|---|---|---|
![]() |
ELayerFlags | ||
![]() |
ELayerType |