Language:
Discover
By Skill Level
By Category

UStereoLayerComponent

Choose your OS:

Inheritance Hierarchy

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

int

 

CylinderHeight

Height of the stereo layer cylinder

Protected variable

float

 

CylinderOverlayArc

Arc angle for the stereo layer cylinder

Protected variable

float

 

CylinderRadius

Radial size of the rendered stereo layer cylinder

Protected variable

UTexture *

 

LeftTexture

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

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

TEnumAsByte < en...

 

StereoLayerShape

Specifies which type of layer it is.

Protected variable

TEnumAsByte < en...

 

StereoLayerType

Specifies how and where the quad is rendered to the screen

Protected variable

UTexture *

 

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

int32

 

GetPriority()

The render priority

Public function

FVector2D

 

GetQuadSize()

The height and width of the rendered quad

Public function

UTexture ...

 

GetTexture()

The texture mapped to the stereo layer quad

Public function

FBox2D

 

GetUVRect()

The UV coordinates mapped to the quad face

Public function

void

 

MarkTextureForUpdate()

Manually mark the stereo layer texture for updating.

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 quad

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.

References

Module

Engine

Header

Runtime/Engine/Classes/Components/StereoLayerComponent.h