UStereoLayerComponent

A geometry layer within the stereo rendered viewport.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/StereoLayerComponent.h

Include

#include "Components/StereoLayerComponent.h"

Syntax

class UStereoLayerComponent : public USceneComponent

Remarks

A geometry layer within the stereo rendered viewport.

Variables

Name Description

Public variable

uint32: 1

 

bLiveTexture

True if the stereo layer texture needs to update itself every frame(scene capture, video, etc.)

Public variable

uint32: 1

 

bNoAlphaChannel

True if the texture should not use its own alpha channel (1.0 will be substituted)

Public variable

uint32: 1

 

bQuadPreserveTextureRatio

True if the quad should internally set it's Y value based on the set texture's dimensions

Public variable

uint32: 1

 

bSupportsDepth

True if the stereo layer needs to support depth intersections with the scene geometry, if available on the platform

Protected variable

TObjectPtr< cla...

 

LeftTexture

Texture displayed on the stereo layer for left eye, if stereoscopic textures are supported on the platform and by the layer shape

Protected variable

int32

 

Priority

Render priority among all stereo layers, higher priority render on top of lower priority

Protected variable

FVector2D

 

QuadSize

Size of the rendered stereo layer quad

Protected variable

TObjectPtr< USt...

 

Shape

Specifies which shape of layer it is.

Protected variable

TEnumAsByte< en...

 

StereoLayerType

Specifies how and where the quad is rendered to the screen

Protected variable

TObjectPtr< cla...

 

Texture

Texture displayed on the stereo layer (is stereocopic textures are supported on the platfrom and more than one texture is provided, this will be the right eye)

Protected variable

FBox2D

 

UVRect

UV coordinates mapped to the quad face

Constructors

Name Description

Public function

UStereoLayerComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

UTexture ...

 

GetLeftTexture()

Public function Const

int32

 

GetPriority()

Public function Const

FVector2D

 

GetQuadSize()

Public function Const

UTexture ...

 

GetTexture()

Public function Const

FBox2D

 

GetUVRect()

Public function

void

 

MarkStereoLayerDirty()

Public function

void

 

MarkTextureForUpdate()

Manually mark the stereo layer texture for updating.

Public function

void

 

SetEquirectProps

(
    FEquirectProps InScaleBiases
)

Set Equirect layer properties: UVRect, Scale, and Bias

Public function

void

 

SetLeftTexture

(
    UTexture* InTexture
)

Change the texture displayed on the stereo layer for left eye, if stereoscopic layer textures are supported on the platform.

Public function

void

 

SetPriority

(
    int32 InPriority
)

Change the layer's render priority, higher priorities render on top of lower priorities

Public function

void

 

SetQuadSize

(
    FVector2D InQuadSize
)

Change the quad size. This is the unscaled height and width, before component scale is applied.

Public function

void

 

SetTexture

(
    UTexture* InTexture
)

Change the texture displayed on the stereo layer.

Public function

void

 

SetUVRect

(
    FBox2D InUVRect
)

Change the UV coordinates mapped to the quad face

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

TickComponent

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorComponentTickFunction* T...
)

Function called every frame on this ActorComponent.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

Name Description

Protected variable

int

 

CylinderHeight_DEPRECATED

int CylinderHeight is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.

Protected variable

float

 

CylinderOverlayArc_DEPRECATED

float CylinderOverlayArc is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.

Protected variable

float

 

CylinderRadius_DEPRECATED

float CylinderRadius is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.

Protected variable

FEquirectProps

 

EquirectProps_DEPRECATED

FEquirectProps EquirectProps is deprecated. Use the corresponding properties of the UStereoLayerShapeEquirect subobject instead.

Protected variable

TEnumAsByte< en...

 

StereoLayerShape_DEPRECATED

TEnumAsByte StereoLayerShape is deprecated. Use Shape instead.