IStereoLayers

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/IStereoLayers.h

Include

#include "IStereoLayers.h"

Syntax

class IStereoLayers

Variables

Name Description

Protected variable

bool

 

bSplashIsShown

Protected variable

bool

 

bSplashShowMovie

Protected variable

uint32

 

SplashLayerHandle

Protected variable

FTexture2DRHIRe...

 

SplashMovie

Protected variable

FVector

 

SplashOffset

Protected variable

FVector2D

 

SplashScale

Protected variable

FTexture2DRHIRe...

 

SplashTexture

Destructors

Name Description

Public function Virtual

~IStereoLayers()

Functions

Name Description

Public function

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

Public function

void

 

DestroyLayer

(
    uint32 LayerId
)

Destroys the specified layer, stopping it from rendering over the world

Public function Virtual

void

 

GetAllocatedTexture

(
    uint32 LayerId,
    FTextureRHIRef& Texture,
    FTextureRHIRef& LeftTexture
)

Get texture reference to HMD swapchain to avoid the copy path, useful for continuous update layers

Public function Virtual

FLayerDesc

 

GetDebugCanvasLayerDesc

(
    FTextureRHIRef Texture
)

Public function

bool

 

GetLayerDesc

(
    uint32 LayerId,
    FLayerDesc& OutLayerDesc
)

Get the currently set layer description

Public function

void

 

HideSplashScreen()

Hide the splash screen and return to normal display.

Public function

void

 

MarkTextureForUpdate

(
    uint32 LayerId
)

Marks this layers texture for update

Public function

void

 

SetLayerDesc

(
    uint32 LayerId,
    const FLayerDesc& InLayerDesc
)

Set the a new layer description

Public function

void

 

SetSplashScreen

(
    FTextureRHIRef Texture,
    FVector2D Scale,
    FVector Offset,
    bool bShowLoadingMovie
)

Set the splash screen attributes

Public function

void

 

SetSplashScreenMovie

(
    FTextureRHIRef Texture
)

Set the splash screen's movie texture.

Public function Const

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.

Public function

void

 

ShowSplashScreen()

Show the splash screen and override the normal VR display

Public function

void

 

UpdateSplashScreen()

Update splash screens from current state

Classes

Name

Description

Public struct

FLayerDesc

Structure describing the visual appearance of a single stereo layer

Enums

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