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 > Components > UCanvasPanel

Light Theme

Dark Theme

UCanvasPanel

The canvas panel is a designer friendly panel that allows widgets to be laid out at arbitrary locations, anchored and z-ordered with other children of the canvas.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UCanvasPanel

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/CanvasPanel.h
Include	#include "Components/CanvasPanel.h"

Syntax

class UCanvasPanel : public UPanelWidget

Remarks

The canvas panel is a designer friendly panel that allows widgets to be laid out at arbitrary locations, anchored and z-ordered with other children of the canvas. The canvas is a great widget for manual layout, but bad when you want to procedurally just generate widgets and place them in a container (unless you want absolute layout).

Many Children
Absolute Layout
Anchors

Variables

		Name	Description
	TSharedPtr< cla...	MyCanvas

Constructors

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

Functions

	Name	Description
UCanvasPanel...	AddChildToCanvas ( UWidget* Content )
TSharedPtr< ...	GetCanvasWidget()	Gets the underlying native canvas widget if it has been constructed
bool	GetGeometryForSlot ( int32 SlotIndex, FGeometry& ArrangedGeometry )	Computes the geometry for a particular slot based on the current geometry of the canvas.
bool	GetGeometryForSlot ( UCanvasPanelSlot* Slot, FGeometry& ArrangedGeometry )	Computes the geometry for a particular slot based on the current geometry of the canvas.

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
bool	LockToPanelOnDrag()
void	OnSlotAdded ( UPanelSlot* Slot )
void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

		Name	Description
	const FText	GetPaletteCategory()	Gets the palette category of the widget
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss