Navigation
API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/SOverlay
Description
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
Virtual Inheritance
- SWidget::OnPaint → SPanel::OnPaint → SOverlay::OnPaint
| Name | OnPaint |
| Type | function |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Widgets/SOverlay.h |
| Include Path | #include "Widgets/SOverlay.h" |
| Source | /Engine/Source/Runtime/SlateCore/Private/Widgets/SOverlay.cpp |
virtual int32 OnPaint
(
const FPaintArgs & Args,
const FGeometry & AllottedGeometry,
const FSlateRect & MyCullingRect,
FSlateWindowElementList & OutDrawElements,
int32 LayerId,
const FWidgetStyle & InWidgetStyle,
bool bParentEnabled
) const
The maximum layer ID attained by this widget or any of its children.
Parameters
| Name | Remarks |
|---|---|
| Args | All the arguments necessary to paint this widget ( |
| AllottedGeometry | The FGeometry that describes an area in which the widget should appear. |
| MyCullingRect | The rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget. |
| OutDrawElements | A list of FDrawElements to populate with the output. |
| LayerId | The Layer onto which this widget should be rendered. |
| InColorAndOpacity | Color and Opacity to be applied to all the descendants of the widget being painted |
| bParentEnabled | True if the parent of this widget is enabled. |