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

UPlanarReflectionComponent

[UPlanarReflectionComponent](API\Runtime\Engine\Components\UPlanarReflectionComponent)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

USceneCaptureComponent

UPlanarReflectionComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/PlanarReflectionComponent.h
Include	#include "Components/PlanarReflectionComponent.h"

Syntax

class UPlanarReflectionComponent : public USceneCaptureComponent

Remarks

Variables

	Name	Description
float	AngleFromPlaneFadeEnd	Receiving pixels whose normal is at this angle from the reflection plane will have completely faded out the planar reflection.
float	AngleFromPlaneFadeStart	Receiving pixels whose normal is at this angle from the reflection plane will begin to fade out the planar reflection.
bool	bRenderSceneTwoSided	Whether to render the scene as two-sided, which can be useful to hide artifacts where normal distortion would read 'under' an object that has been clipped by the reflection plane.
bool	bShowPreviewPlane
UMaterial *	CaptureMaterial	The material to use on ProxyMeshComponent
float	DistanceFromPlaneFadeoutEnd	Receiving pixels at this distance from the reflection plane will have completely faded out the planar reflection.
float	DistanceFromPlaneFadeoutStart	Receiving pixels at this distance from the reflection plane will begin to fade out the planar reflection.
float	ExtraFOV	Additional FOV used when rendering to the reflection texture.
float	NormalDistortionStrength	Controls the strength of normals when distorting the planar reflection.
float	PrefilterRoughness	The roughness value to prefilter the planar reflection texture with, useful for hiding low resolution.
float	PrefilterRoughnessDistance	The distance at which the prefilter roughness value will be achieved.
UBoxComponent &...	PreviewBox
int32	ScreenPercentage	Downsample percent, can be used to reduce GPU time rendering the planar reflection.

Constructors

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

Functions

		Name	Description
	int32	GetPlanarReflectionId()
	void	GetProjectionWithExtraFOV ( FMatrix& OutMatrix, const uint32 StereoIndex )
	void	UpdatePreviewShape()

Overridden from UActorComponent

	Name	Description
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	DestroyRenderState_Concurrent()	Used to shut down any rendering thread structure for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	FinishDestroy()	Called to finish destroying the object.
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

		Name	Description
	float	DistanceFromPlaneFadeEnd_DEPRECATED
	float	DistanceFromPlaneFadeStart_DEPRECATED

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

Take our survey

Dismiss