1. Epic GamesDeveloper
  3. IStereoLayers

IStereoLayers

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class IStereoLayers

Variables

  Type Name Description
Protected variable bool bSplashIsShown  
Protected variable bool bSplashShowMovie  
Protected variable uint32 SplashLayerHandle  
Protected variable FTexture2DRHIRef SplashMovie  
Protected variable FVector SplashOffset  
Protected variable FVector2D SplashScale  
Protected variable FTexture2DRHIRef SplashTexture  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type 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 Virtual void Optional method to hide the 3D scene and only render the stereo overlays.
Public function Virtual Const bool Tell if the background layer is visible.
Public function void

MarkTextureForUpdate ( uint32 LayerId
)

 Marks this layers texture for update
Public function Virtual void Restores the stereo layer state from the last save state.
Public function Virtual void

PushLayerState ( bool bPreserve
)

 Saves the current stereo layer state on a stack to later restore them.
Public function void

SetLayerDesc ( uint32 LayerId,
const FLayerDesc& InLayerDesc
)

 Set the a new layer description
Public function Const 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.
Public function Virtual void Optional method to undo the effect of hiding the 3D scene. No-op if not supported by the platform.
Public function Virtual bool Returns true if the StereoLayers implementation supports saving and restoring state using Push/PopLayerState()
Public function Virtual void Update splash screens from current state

Classes

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

Enums

  Type Name Description
Public enum ELayerFlags    
Public enum ELayerType    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page