Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UStereoLayerComponent

A geometry layer within the stereo rendered viewport.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UStereoLayerComponent

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
uint32: 1	bLiveTexture	True if the stereo layer texture needs to update itself every frame(scene capture, video, etc.)
uint32: 1	bNoAlphaChannel	True if the texture should not use its own alpha channel (1.0 will be substituted)
uint32: 1	bQuadPreserveTextureRatio	True if the quad should internally set it's Y value based on the set texture's dimensions
uint32: 1	bSupportsDepth	True if the stereo layer needs to support depth intersections with the scene geometry, if available on the platform
UTexture *	LeftTexture	Texture displayed on the stereo layer for left eye, if stereoscopic textures are supported on the platform and by the layer shape
int32	Priority	Render priority among all stereo layers, higher priority render on top of lower priority
FVector2D	QuadSize	Size of the rendered stereo layer quad
UStereoLayerSha...	Shape	Specifies which shape of layer it is.
TEnumAsByte< en...	StereoLayerType	Specifies how and where the quad is rendered to the screen
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)
FBox2D	UVRect	UV coordinates mapped to the quad face

Constructors

	Name	Description
	UStereoLayerComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
UTexture ...	GetLeftTexture()
int32	GetPriority()
FVector2D	GetQuadSize()
UTexture ...	GetTexture()
FBox2D	GetUVRect()
void	MarkStereoLayerDirty()
void	MarkTextureForUpdate()	Manually mark the stereo layer texture for updating.
void	SetEquirectProps ( FEquirectProps InScaleBiases )	Set Equirect layer properties: UVRect, Scale, and Bias
void	SetLeftTexture ( UTexture* InTexture )	Change the texture displayed on the stereo layer for left eye, if stereoscopic layer textures are supported on the platform.
void	SetPriority ( int32 InPriority )	Change the layer's render priority, higher priorities render on top of lower priorities
void	SetQuadSize ( FVector2D InQuadSize )	Change the quad size. This is the unscaled height and width, before component scale is applied.
void	SetTexture ( UTexture* InTexture )	Change the texture displayed on the stereo layer.
void	SetUVRect ( FBox2D InUVRect )	Change the UV coordinates mapped to the quad face

Overridden from UActorComponent

		Name	Description
	void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

	Name	Description
int	CylinderHeight_DEPRECATED	int CylinderHeight is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.
float	CylinderOverlayArc_DEPRECATED	float CylinderOverlayArc is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.
float	CylinderRadius_DEPRECATED	float CylinderRadius is deprecated. Use the corresponding property of the UStereoLayerShapeCylinder subobject instead.
FEquirectProps	EquirectProps_DEPRECATED	FEquirectProps EquirectProps is deprecated. Use the corresponding properties of the UStereoLayerShapeEquirect subobject instead.
TEnumAsByte< en...	StereoLayerShape_DEPRECATED	TEnumAsByte StereoLayerShape is deprecated. Use Shape instead.

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

Take our survey

Dismiss