UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SWidget.h File Reference

Go to the source code of this file.

Classes

struct  TWidgetTypeTraits< WidgetType >
 
class  FPopupLayer
 
class  SWidget
 
struct  SWidget::TSlateAttribute< InObjectType, InInvalidationReasonValue, InComparePredicate >
 
struct  SWidget::TSlateAttribute< FText, EInvalidateWidgetReason::None >
 
struct  SWidget::TSlateAttribute< FText, InInvalidationReasonValue >
 
struct  SWidget::TSlateManagedAttribute< InObjectType, InInvalidationReasonValue, InComparePredicate >
 
struct  SWidget::TSlateManagedAttribute< FText, EInvalidateWidgetReason::None >
 
struct  SWidget::TSlateManagedAttribute< FText, InInvalidationReasonValue >
 
struct  SWidget::TSlateAttributeRef< InObjectType, InInvalidationReasonValue, InComparePredicate >
 
struct  SWidget::TSlateAttributeRef< FText, EInvalidateWidgetReason::None >
 
struct  SWidget::TSlateAttributeRef< FText, InInvalidationReasonValue >
 

Enumerations

enum class  EAccessibleType : uint8 { Main , Summary }
 

Functions

 DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("Widgets Created (Per Frame)"), STAT_SlateTotalWidgetsPerFrame, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("SWidget::Paint (Count)"), STAT_SlateNumPaintedWidgets, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_DWORD_COUNTER_STAT_EXTERN (TEXT("SWidget::Tick (Count)"), STAT_SlateNumTickedWidgets, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_CYCLE_STAT_EXTERN (TEXT("Execute Active Timers"), STAT_SlateExecuteActiveTimers, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_CYCLE_STAT_EXTERN (TEXT("Tick Widgets"), STAT_SlateTickWidgets, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_CYCLE_STAT_EXTERN (TEXT("SlatePrepass"), STAT_SlatePrepass, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_CYCLE_STAT_EXTERN (TEXT("SWidget MetaData"), STAT_SlateGetMetaData, STATGROUP_Slate, SLATECORE_API)
 
 DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN (TEXT("Total Widgets"), STAT_SlateTotalWidgets, STATGROUP_SlateMemory, SLATECORE_API)
 
 DECLARE_MEMORY_STAT_EXTERN (TEXT("SWidget Total Allocated Size"), STAT_SlateSWidgetAllocSize, STATGROUP_SlateMemory, SLATECORE_API)
 
template<typename TargetValueType , typename SourceValueType >
bool SetWidgetAttribute (SWidget &ThisWidget, TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 

Enumeration Type Documentation

◆ EAccessibleType

enum class EAccessibleType : uint8
strong
Enumerator
Main 
Summary 

Function Documentation

◆ DECLARE_CYCLE_STAT_EXTERN() [1/4]

DECLARE_CYCLE_STAT_EXTERN ( TEXT("Execute Active Timers" ,
STAT_SlateExecuteActiveTimers  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_CYCLE_STAT_EXTERN() [2/4]

DECLARE_CYCLE_STAT_EXTERN ( TEXT("SlatePrepass")  ,
STAT_SlatePrepass  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_CYCLE_STAT_EXTERN() [3/4]

DECLARE_CYCLE_STAT_EXTERN ( TEXT("SWidget MetaData" ,
STAT_SlateGetMetaData  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_CYCLE_STAT_EXTERN() [4/4]

DECLARE_CYCLE_STAT_EXTERN ( TEXT("Tick Widgets" ,
STAT_SlateTickWidgets  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN()

DECLARE_DWORD_ACCUMULATOR_STAT_EXTERN ( TEXT("Total Widgets" ,
STAT_SlateTotalWidgets  ,
STATGROUP_SlateMemory  ,
SLATECORE_API   
)

◆ DECLARE_DWORD_COUNTER_STAT_EXTERN() [1/3]

DECLARE_DWORD_COUNTER_STAT_EXTERN ( TEXT("SWidget::Paint (Count)")  ,
STAT_SlateNumPaintedWidgets  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_DWORD_COUNTER_STAT_EXTERN() [2/3]

DECLARE_DWORD_COUNTER_STAT_EXTERN ( TEXT("SWidget::Tick (Count)")  ,
STAT_SlateNumTickedWidgets  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_DWORD_COUNTER_STAT_EXTERN() [3/3]

DECLARE_DWORD_COUNTER_STAT_EXTERN ( TEXT("Widgets Created (Per Frame)")  ,
STAT_SlateTotalWidgetsPerFrame  ,
STATGROUP_Slate  ,
SLATECORE_API   
)

◆ DECLARE_MEMORY_STAT_EXTERN()

DECLARE_MEMORY_STAT_EXTERN ( TEXT("SWidget Total Allocated Size" ,
STAT_SlateSWidgetAllocSize  ,
STATGROUP_SlateMemory  ,
SLATECORE_API   
)

◆ SetWidgetAttribute()

bool SetWidgetAttribute ( SWidget ThisWidget,
TAttribute< TargetValueType > &  TargetValue,
const TAttribute< SourceValueType > &  SourceValue,
EInvalidateWidgetReason  BaseInvalidationReason 
)

Performs the attribute assignment and invalidates the widget minimally based on what actually changed. So if the boundness of the attribute didn't change volatility won't need to be recalculated. Returns true if the value changed.