FLayerDesc

Structure describing the visual appearance of a single stereo layer

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "IStereoLayers.h"

Syntax

struct FLayerDesc

Remarks

Structure describing the visual appearance of a single stereo layer

Variables

Name Description

Public variable

uint32

 

Flags

Uses LAYER_FLAG_... See: ELayerFlags.

Public variable

uint32

 

Id

The layer's ID.

Public variable

FIntPoint

 

LayerSize

Size of texture that the compositor should allocate. Unnecessary if Texture is provided. The compositor will allocate a cubemap whose faces are of LayerSize if ShapeType is CubemapLayer.

Public variable

FTextureRHIRef

 

LeftTexture

Texture mapped for left eye (if one texture provided, mono assumed)

Public variable

ELayerType

 

PositionType

Which space the layer is locked within.

Public variable

int32

 

Priority

Render order priority, higher priority render on top of lower priority. Face-Locked layers are rendered on top of other layer types regardless of priority.

Public variable

FVector2D

 

QuadSize

Size of rendered quad.

Public variable

FTextureRHIRef

 

Texture

Texture mapped for right eye (if one texture provided, mono assumed)

Public variable

FTransform

 

Transform

View space transform.

Public variable

FBox2D

 

UVRect

UVs of rendered quad in UE units.

Constructors

Name Description

Public function

FLayerDesc()

Public function

FLayerDesc

(
    const IStereoLayerShape& InShape
)

Functions

Name Description

Public function Const

uint32

 

GetLayerId()

Public function

T &

 

GetShape()

Returns Shape cast to the supplied type. It's up to the caller to have ensured the cast is valid before calling this method.

Public function Const

const T &

 

GetShape()

Public function Const

bool

 

HasShape()

Which shape of layer it is.

Public function Const

bool

 

IsVisible()

Public function

void

 

SetLayerId

(
    uint32 InId
)

Public function

void

 

SetShape

(
    InArgTypes&&... Args
)

Constants

Name

Description

INVALID_LAYER_ID

Layer IDs must be larger than 0.

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