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

UReflectionCaptureComponent

-> will be exported to EngineDecalClasses.h

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UReflectionCaptureComponent

	UBoxReflectionCaptureComponent
	UPlaneReflectionCaptureComponent
	USphereReflectionCaptureComponent

References

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

Syntax

class UReflectionCaptureComponent : public USceneComponent

Remarks

-> will be exported to EngineDecalClasses.h

Variables

	Name	Description
bool	bMapBuildDataIdLoaded	Check to see if MapBuildDataId was loaded - otherwise we need to display a warning on cook
float	Brightness	A brightness control to scale the captured scene's reflection intensity.
FVector	CaptureOffset	World space offset to apply before capturing.
UBillboardCompo...	CaptureOffsetComponent
UTextureCube &#...	Cubemap	Cubemap to use for reflection if ReflectionSourceType is set to RS_SpecifiedCubemap.
FGuid	MapBuildDataId	Guid for map build data
EReflectionSour...	ReflectionSourceType	Indicates where to get the reflection source from.
FReflectionCapt...	SceneProxy	The rendering thread's mirror of this reflection capture.
float	SourceCubemapAngle	Angle to rotate the source cubemap when SourceType is set to SLS_SpecifiedCubemap.

Constructors

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

Functions

	Name	Description
FReflectionC...	CreateSceneProxy()	Callback to create the rendering thread mirror.
float	GetInfluenceBoundingRadius()	Gets the radius that bounds the shape's influence, used for culling.
FReflectionC...	GetMapBuildData()
int32	GetReflectionCaptureSize()
void	MarkDirtyForRecapture()	Generates a new MapBuildDataId and adds the capture to the capture queue processed by UpdateReflectionCaptureContents.
void	MarkDirtyForRecaptureOrUpload()	Adds the capture to the capture queue processed by UpdateReflectionCaptureContents.
void	SetCaptureCompleted()	Marks this component has having been recaptured.
void	UpdatePreviewShape()	Called to update the preview shapes when something they are dependent on has changed.
void	UpdateReflectionCaptureContents ( UWorld* WorldToUpdate, const TCHAR* CaptureReason, bool bVerifyOnlyCapturing )	Called each tick to recapture and queued reflection captures.

Overridden from USceneComponent

		Name	Description
	void	PreFeatureLevelChange ( ERHIFeatureLevel::Type PendingFeatu... )	Called to update any visuals needed for a feature level change
	void	PropagateLightingScenarioChange()	Updates any visuals after the lighting has changed

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	InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighti..., bool bTranslationOnly )	Called when this actor component has moved, allowing it to discard statically cached lighting information.
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.
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
ReflectionCapturesToUpdate	List of reflection captures that need to be recaptured.
ReflectionCapturesToUpdateForLoad	List of reflection captures that need to be recaptured because they were dirty on load.
ReflectionCapturesToUpdateForLoadLock

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

Take our survey

Dismiss