Navigation
API > API/Runtime > API/Runtime/Engine
A geometry layer within the stereo rendered viewport.
| Name | UStereoLayerComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Components/StereoLayerComponent.h |
| Include Path | #include "Components/StereoLayerComponent.h" |
Syntax
UCLASS (ClassGroup="HeadMountedDisplay", HideCategories=(Object, LOD, Lighting, TextureStreaming),
EditInlineNew, Meta=(DisplayName="Stereo Layer", BlueprintSpawnableComponent), MinimalAPI)
class UStereoLayerComponent : public USceneComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UStereoLayerComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UStereoLayerComponent
(
const FObjectInitializer& ObjectInitializer |
Components/StereoLayerComponent.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AdditionalFlags | TArray< FName > | Additional flags not included in IStereoLayers::ELayerFlags | Components/StereoLayerComponent.h |
|
| bLiveTexture | uint32 | True if the stereo layer texture needs to update itself every frame(scene capture, video, etc.) | Components/StereoLayerComponent.h |
|
| bNoAlphaChannel | uint32 | True if the texture should not use its own alpha channel (1.0 will be substituted) | Components/StereoLayerComponent.h |
|
| bQuadPreserveTextureRatio | uint32 | True if the quad should internally set it's Y value based on the set texture's dimensions | Components/StereoLayerComponent.h |
|
| bSupportsDepth | uint32 | True if the stereo layer needs to support depth intersections with the scene geometry, if available on the platform | Components/StereoLayerComponent.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsDirty | bool | Dirty state determines whether the stereo layer needs updating | Components/StereoLayerComponent.h | |
| bLastVisible | bool | Last frames visiblity state | Components/StereoLayerComponent.h | |
| bTextureNeedsUpdate | bool | Texture needs to be marked for update | Components/StereoLayerComponent.h | |
| LastTransform | FTransform | Last transform is cached to determine if the new frames transform has changed | Components/StereoLayerComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTexture * GetLeftTexture() |
Components/StereoLayerComponent.h |
|
|
int32 GetPriority() |
Components/StereoLayerComponent.h |
|
|
FVector2D GetQuadSize() |
Components/StereoLayerComponent.h |
|
|
UTexture * GetTexture() |
Components/StereoLayerComponent.h |
|
|
FBox2D GetUVRect() |
Components/StereoLayerComponent.h |
|
|
void MarkStereoLayerDirty() |
Components/StereoLayerComponent.h | ||
void MarkTextureForUpdate() |
Manually mark the stereo layer texture for updating. | Components/StereoLayerComponent.h |
|
void SetEquirectProps
(
FEquirectProps InEquirectProps |
Set Equirect layer properties: UVRect, Scale, Bias and Radius. | Components/StereoLayerComponent.h |
|
void SetLeftTexture
(
UTexture* InTexture |
Change the texture displayed on the stereo layer for left eye, if stereoscopic layer textures are supported on the platform. | Components/StereoLayerComponent.h |
|
void SetPriority
(
int32 InPriority |
Change the layer's render priority, higher priorities render on top of lower priorities | Components/StereoLayerComponent.h |
|
void SetQuadSize
(
FVector2D InQuadSize |
Change the quad size. This is the unscaled height and width, before component scale is applied. | Components/StereoLayerComponent.h |
|
void SetTexture
(
UTexture* InTexture |
Change the texture displayed on the stereo layer. | Components/StereoLayerComponent.h |
|
void SetUVRect
(
FBox2D InUVRect |
Change the UV coordinates mapped to the quad face | Components/StereoLayerComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EndPlay
(
const EEndPlayReason::Type EndPlayReason |
Ends gameplay for this component. Called from AActor::EndPlay only if bHasBegunPlay is true | Components/StereoLayerComponent.h | |
virtual void OnUnregister () |
Called when a component is unregistered. | Components/StereoLayerComponent.h | |
virtual void TickComponent
(
float DeltaTime, |
Function called every frame on this ActorComponent. | Components/StereoLayerComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
Components/StereoLayerComponent.h |