UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FWidgetComponentInstanceData Struct Reference

#include <WidgetComponent.h>

+ Inheritance diagram for FWidgetComponentInstanceData:

Public Member Functions

 FWidgetComponentInstanceData ()
 
 FWidgetComponentInstanceData (const UWidgetComponent *SourceComponent)
 
virtual ~FWidgetComponentInstanceData ()=default
 
virtual bool ContainsData () const override
 
virtual void ApplyToComponent (UActorComponent *Component, const ECacheApplyPhase CacheApplyPhase) override
 
virtual void AddReferencedObjects (FReferenceCollector &Collector) override
 
- Public Member Functions inherited from FSceneComponentInstanceData
ENGINE_API FSceneComponentInstanceData ()
 
ENGINE_API FSceneComponentInstanceData (const USceneComponent *SourceComponent)
 
virtual ENGINE_API ~FSceneComponentInstanceData ()
 
virtual ENGINE_API void FindAndReplaceInstances (const TMap< UObject *, UObject * > &OldToNewInstanceMap) override
 
- Public Member Functions inherited from FActorComponentInstanceData
ENGINE_API FActorComponentInstanceData ()
 
ENGINE_API FActorComponentInstanceData (const UActorComponent *SourceComponent)
 
ENGINE_API bool MatchesComponent (const UActorComponent *Component, const UObject *ComponentTemplate) const
 
const UClass * GetComponentClass () const
 
const UObject * GetComponentTemplate () const
 
- Public Member Functions inherited from FInstanceCacheDataBase
virtual ENGINE_API ~FInstanceCacheDataBase ()
 
UObject * GetUniqueTransientPackage ()
 
ENGINE_API UObject * GetUniqueTransientObject (UClass *Class)
 
const TArray< FDataCacheDuplicatedObjectData > & GetDuplicatedObjects () const
 
const TArray< TObjectPtr< UObject > > & GetReferencedObjects () const
 
const TArray< uint8 > & GetSavedProperties () const
 

Public Attributes

TSubclassOf< UUserWidget > WidgetClass
 
TObjectPtr< UTextureRenderTarget2D > RenderTarget
 
- Public Attributes inherited from FSceneComponentInstanceData
TMap< TObjectPtr< USceneComponent >, FTransform > AttachedInstanceComponents
 

Additional Inherited Members

- Protected Attributes inherited from FActorComponentInstanceData
TObjectPtr< const UObject > SourceComponentTemplate
 
EComponentCreationMethod SourceComponentCreationMethod
 
int32 SourceComponentTypeSerializedIndex
 
- Protected Attributes inherited from FInstanceCacheDataBase
TArray< uint8 > SavedProperties
 

Detailed Description

The widget component provides a surface in the 3D environment on which to render widgets normally rendered to the screen. Widgets are first rendered to a render target, then that render target is displayed in the world.

Material Properties set by this component on whatever material overrides the default. SlateUI [Texture] BackColor [Vector] TintColorAndOpacity [Vector] OpacityFromTexture [Scalar]

Constructor & Destructor Documentation

◆ FWidgetComponentInstanceData() [1/2]

FWidgetComponentInstanceData::FWidgetComponentInstanceData ( )
inline

◆ FWidgetComponentInstanceData() [2/2]

FWidgetComponentInstanceData::FWidgetComponentInstanceData ( const UWidgetComponent *  SourceComponent)
inline

◆ ~FWidgetComponentInstanceData()

virtual FWidgetComponentInstanceData::~FWidgetComponentInstanceData ( )
virtualdefault

Member Function Documentation

◆ AddReferencedObjects()

virtual void FWidgetComponentInstanceData::AddReferencedObjects ( FReferenceCollector &  Collector)
inlineoverridevirtual

Reimplemented from FSceneComponentInstanceData.

◆ ApplyToComponent()

virtual void FWidgetComponentInstanceData::ApplyToComponent ( UActorComponent *  Component,
const ECacheApplyPhase  CacheApplyPhase 
)
inlineoverridevirtual

Applies this component instance data to the supplied component

Reimplemented from FSceneComponentInstanceData.

◆ ContainsData()

virtual bool FWidgetComponentInstanceData::ContainsData ( ) const
inlineoverridevirtual

Determines if any instance data was actually saved.

Reimplemented from FSceneComponentInstanceData.

Member Data Documentation

◆ RenderTarget

TObjectPtr<UTextureRenderTarget2D> FWidgetComponentInstanceData::RenderTarget

◆ WidgetClass

TSubclassOf<UUserWidget> FWidgetComponentInstanceData::WidgetClass
The documentation for this struct was generated from the following file: