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 > UMG > Slate > SObjectWidget > SObjectWidget::OnPaint

Light Theme

Dark Theme

SObjectWidget::OnPaint

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Choose your operating system:

Windows

macOS

Linux

Override Hierarchy

SWidget::OnPaint()

SCompoundWidget::OnPaint()

SObjectWidget::OnPaint()

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Slate/SObjectWidget.h
Include	#include "Slate/SObjectWidget.h"
Source	/Engine/Source/Runtime/UMG/Private/Slate/SObjectWidget.cpp

Syntax

virtual int32 OnPaint
(
    const FPaintArgs & Args,
    const FGeometry & AllottedGeometry,
    const FSlateRect & MyCullingRect,
    FSlateWindowElementList & OutDrawElements,
    int32 LayerId,
    const FWidgetStyle & InWidgetStyle,
    bool bParentEnabled
) const

Remarks

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.

Returns

The maximum layer ID attained by this widget or any of its children.

Parameters

Parameter	Description
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.