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 > USafeZone

Light Theme

Dark Theme

USafeZone

The Safe-Zone widget is an essential part of developing a game UI that can run on lots of different non-PC platforms.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

USafeZone

References

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

Syntax

class USafeZone : public UContentWidget

Remarks

The Safe-Zone widget is an essential part of developing a game UI that can run on lots of different non-PC platforms. While a modern flat panel computer monitor may not have over scan issues, this is a common occurrence for Consoles. It's common for TVs to have extra pixels under the bezel, in addition to projectors and projection TVs having potentially several vertical and horizontal columns of pixels hidden behind or against a black border of the projection screen.

Useful testing console commands to help, simulate the safe zone on PC, r.DebugSafeZone.TitleRatio 0.96 r.DebugActionZone.ActionRatio 0.96

To enable a red band to visualize the safe zone, use this console command, r.DebugSafeZone.Mode controls the debug visualization overlay (0..2, default 0). 0: Do not display the safe zone overlay. 1: Display the overlay for the title safe zone. 2: Display the overlay for the action safe zone.

Variables

		Name	Description
	TOptional< floa...	DesignerDpi
	TOptional< FVec...	DesignerSize
	TSharedPtr< cla...	MySafeZone

Constructors

	Name	Description
	USafeZone()

Functions

		Name	Description
	bool	GetPadBottom()
	bool	GetPadLeft()
	bool	GetPadRight()
	bool	GetPadTop()
	void	SetPadBottom ( bool InPadBottom )
	void	SetPadLeft ( bool InPadLeft )
	void	SetPadRight ( bool InPadRight )
	void	SetPadTop ( bool InPadTop )
	void	SetSidesToPad ( bool InPadLeft, bool InPadRight, bool InPadTop, bool InPadBottom )
	void	UpdateWidgetProperties()

Overridden from UPanelWidget

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

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnDesignerChanged ( const FDesignerChangedEventArgs& E... )
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 )

Deprecated Variables

	Name	Description
bool	PadBottom	Direct access to PadBottom is deprecated. Please use the getter or setter.
bool	PadLeft	Direct access to PadLeft is deprecated. Please use the getter or setter.
bool	PadRight	Direct access to PadRight is deprecated. Please use the getter or setter.
bool	PadTop	Direct access to PadTop is deprecated. Please use the getter or setter.

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

Take our survey

Cancel