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

> Unreal Engine API Reference > Runtime > Engine > Components > UDecalComponent

Light Theme

Dark Theme

UDecalComponent

A material that is rendered onto the surface of a mesh. A kind of 'bumper sticker' for a model.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UDecalComponent

References

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

Syntax

class UDecalComponent : public USceneComponent

Remarks

A material that is rendered onto the surface of a mesh. A kind of 'bumper sticker' for a model.

Variables

	Name	Description
uint8: 1	bDestroyOwnerAfterFade	Automatically destroys the owning actor after fully fading out.
FLinearColor	DecalColor	Decal color, can be accessed using the material Decal Color node.
TObjectPtr< cla...	DecalMaterial	Decal material.
FVector	DecalSize	Decal size in local space (does not include the component scale), technically redundant but there for convenience
float	FadeDuration	Time in seconds for the decal to fade out.
float	FadeInDuration
float	FadeInStartDelay
float	FadeScreenSize
float	FadeStartDelay	Time in seconds to wait before beginning to fade out the decal.
FDeferredDecalP...	SceneProxy	The decal proxy.
int32	SortOrder	Controls the order in which decal elements are rendered.
FTimerHandle	TimerHandle_DestroyDecalComponent	Handle for efficient management of DestroyDecalComponent timer

Constructors

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

Functions

	Name	Description
UMaterialIns...	CreateDynamicMaterialInstance()	Utility to allocate a new Dynamic Material Instance, set its parent to the currently applied material, and assign it
FDeferredDec...	CreateSceneProxy()
UMaterialInt...	GetDecalMaterial()	Accessor for decal material
float	GetFadeDuration()
float	GetFadeInDuration()
float	GetFadeInStartDelay()
float	GetFadeStartDelay()
UMaterialInt...	GetMaterial ( int32 ElementIndex )
int32	GetNumMaterials()
FTransform	GetTransformIncludingDecalSize()
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
void	LifeSpanCallback()	Called when the life span of the decal has been exceeded
void	PushSelectionToProxy()	Pushes new selection state to the render thread primitive proxy
void	SetDecalColor ( const FLinearColor& Color )	Sets the decal color.
void	SetDecalMaterial ( UMaterialInterface* NewDecalMa... )	Setting decal material on decal component. This will force the decal to reattach
void	SetFadeIn ( float StartDelay, float Duration )
void	SetFadeOut ( float StartDelay, float Duration, bool DestroyOwnerAfterFade )	Sets the decal's fade start time, duration and if the owning actor should be destroyed after the decal is fully faded out.
void	SetFadeScreenSize ( float NewFadeScreenSize )	Set the FadeScreenSize for this decal component
void	SetLifeSpan ( const float LifeSpan )
void	SetMaterial ( int32 ElementIndex, UMaterialInterface* InMaterial )
void	SetSortOrder ( int32 Value )	Sets the sort order for the decal component.

Overridden from USceneComponent

		Name	Description
	FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
	bool	GetMaterialPropertyPath ( int32 ElementIndex, UObject& OutOwner, FString& OutPropertyPath, FProperty& OutProperty )	Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials

Overridden from UActorComponent

	Name	Description
const UObjec...	AdditionalStatObject()	Give a readable name for this component, including asset name if applicable
void	BeginPlay()	Begins Play for the component.
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	SendRenderTransform_Concurrent()	Called to send a transform update for this component to the rendering thread

Overridden from UObject

		Name	Description
	bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.