#include <NullWindow.h>

Inheritance diagram for FNullWindow:

Public Member Functions
virtual APPLICATIONCORE_API	~FNullWindow ()

APPLICATIONCORE_API void	Initialize (class FNullApplication *const Application, const TSharedRef< FGenericWindowDefinition > &InDefinition, const TSharedPtr< FNullWindow > &InParent, const bool bShowImmediately)

virtual APPLICATIONCORE_API void	ReshapeWindow (int32 X, int32 Y, int32 Width, int32 Height) override

virtual APPLICATIONCORE_API bool	GetFullScreenInfo (int32 &X, int32 &Y, int32 &Width, int32 &Height) const override

virtual APPLICATIONCORE_API void	MoveWindowTo (int32 X, int32 Y) override

virtual APPLICATIONCORE_API void	BringToFront (bool bForce=false) override

virtual APPLICATIONCORE_API void	HACK_ForceToFront () override

virtual APPLICATIONCORE_API void	Destroy () override

virtual APPLICATIONCORE_API void	Minimize () override

virtual APPLICATIONCORE_API void	Maximize () override

virtual APPLICATIONCORE_API void	Restore () override

virtual APPLICATIONCORE_API void	Show () override

virtual APPLICATIONCORE_API void	Hide () override

virtual APPLICATIONCORE_API void	SetWindowMode (EWindowMode::Type InNewWindowMode) override

virtual APPLICATIONCORE_API EWindowMode::Type	GetWindowMode () const override

virtual APPLICATIONCORE_API bool	IsMaximized () const override

virtual APPLICATIONCORE_API bool	IsMinimized () const override

virtual APPLICATIONCORE_API bool	IsVisible () const override

virtual APPLICATIONCORE_API bool	GetRestoredDimensions (int32 &X, int32 &Y, int32 &Width, int32 &Height) override

virtual APPLICATIONCORE_API void	SetWindowFocus () override

virtual APPLICATIONCORE_API void	SetOpacity (const float InOpacity) override

virtual APPLICATIONCORE_API void	Enable (bool bEnable) override

virtual APPLICATIONCORE_API bool	IsPointInWindow (int32 X, int32 Y) const override

virtual APPLICATIONCORE_API int32	GetWindowBorderSize () const override

virtual APPLICATIONCORE_API int32	GetWindowTitleBarSize () const override

virtual APPLICATIONCORE_API void *	GetOSWindowHandle () const override

virtual APPLICATIONCORE_API bool	IsForegroundWindow () const override

virtual APPLICATIONCORE_API bool	IsFullscreenSupported () const override

virtual APPLICATIONCORE_API void	SetText (const TCHAR *const Text) override

virtual APPLICATIONCORE_API const FGenericWindowDefinition &	GetDefinition () const override

virtual APPLICATIONCORE_API bool	IsDefinitionValid () const override

virtual APPLICATIONCORE_API void	AdjustCachedSize (FVector2D &Size) const override

virtual float	GetDPIScaleFactor () const override

virtual void	SetDPIScaleFactor (float Value) override

virtual APPLICATIONCORE_API bool	IsManualManageDPIChanges () const override

virtual APPLICATIONCORE_API void	SetManualManageDPIChanges (const bool bAutoHandle) override

virtual APPLICATIONCORE_API void	DrawAttention (const FWindowDrawAttentionParameters &Parameters) override

virtual APPLICATIONCORE_API void	SetNativeWindowButtonsVisibility (bool bVisible)

Public Member Functions inherited from FGenericWindow
APPLICATIONCORE_API	FGenericWindow ()

virtual APPLICATIONCORE_API	~FGenericWindow ()

Static Public Member Functions
static APPLICATIONCORE_API TSharedRef< FNullWindow >	Make ()

Additional Inherited Members
Protected Attributes inherited from FGenericWindow
TSharedPtr< FGenericWindowDefinition >	Definition

Detailed Description

An implementation of FGenericWindow specifically for use when rendering off screen. This window has no platform backing so instead keeps track of its position and other properties itself.

Constructor & Destructor Documentation

◆ ~FNullWindow()

FNullWindow::~FNullWindow ( )

virtual

Member Function Documentation

◆ AdjustCachedSize()

void FNullWindow::AdjustCachedSize ( FVector2D & Size ) const

overridevirtual

Returns: Gives the native window a chance to adjust our stored window size before we cache it off

Reimplemented from FGenericWindow.

◆ BringToFront()

void FNullWindow::BringToFront ( bool bForce = false )

overridevirtual

Native windows should implement BringToFront by making this window the top-most window (i.e. focused).

Reimplemented from FGenericWindow.

◆ Destroy()

void FNullWindow::Destroy ( )

overridevirtual

Native windows should implement this function by asking the OS to destroy OS-specific resource associated with the window (e.g. Win32 window handle)

Reimplemented from FGenericWindow.

◆ DrawAttention()

void FNullWindow::DrawAttention ( const FWindowDrawAttentionParameters & Parameters )

overridevirtual

Attempts to draw the user's attention to this window in whatever way is appropriate for the platform if this window is not the current active window.

Parameters

Parameters The parameters for drawing attention. Depending on the platform, not all parameters may be supported.

Reimplemented from FGenericWindow.

◆ Enable()

void FNullWindow::Enable ( bool bEnable )

overridevirtual

Enables or disables the window. If disabled the window receives no input

Parameters

bEnable true to enable the window, false to disable it.

Reimplemented from FGenericWindow.

◆ GetDefinition()

const FGenericWindowDefinition & FNullWindow::GetDefinition ( ) const

overridevirtual

Returns: The definition describing properties of the window

Reimplemented from FGenericWindow.

◆ GetDPIScaleFactor()

virtual float FNullWindow::GetDPIScaleFactor ( ) const

inlineoverridevirtual

Returns: ratio of pixels to SlateUnits in this window. E.g. DPIScale of 2.0 means there is a 2x2 pixel square for every 1x1 SlateUnit.

Reimplemented from FGenericWindow.

◆ GetFullScreenInfo()

bool FNullWindow::GetFullScreenInfo	(	int32 &	X,
		int32 &	Y,
		int32 &	Width,
		int32 &	Height
	)		const

overridevirtual

Returns the rectangle of the screen the window is associated with

Reimplemented from FGenericWindow.

◆ GetOSWindowHandle()

void * FNullWindow::GetOSWindowHandle ( ) const

overridevirtual

Gets the OS Window handle in the form of a void pointer for other API's

Reimplemented from FGenericWindow.

◆ GetRestoredDimensions()

bool FNullWindow::GetRestoredDimensions	(	int32 &	X,
		int32 &	Y,
		int32 &	Width,
		int32 &	Height
	)

overridevirtual

Populates the size and location of the window when it is restored. If the function fails, false is returned and X,Y,Width,Height will be undefined.

Returns: true when the size and location and successfully retrieved; false otherwise.

Reimplemented from FGenericWindow.

◆ GetWindowBorderSize()

int32 FNullWindow::GetWindowBorderSize ( ) const

overridevirtual

Gets OS specific window border size. This is necessary because Win32 does not give control over this size.

Reimplemented from FGenericWindow.

◆ GetWindowMode()

EWindowMode::Type FNullWindow::GetWindowMode ( ) const

overridevirtual

Returns: true if the native window is currently in fullscreen mode, false otherwise

Reimplemented from FGenericWindow.

◆ GetWindowTitleBarSize()

int32 FNullWindow::GetWindowTitleBarSize ( ) const

overridevirtual

Gets OS specific window title bar size

Reimplemented from FGenericWindow.

◆ HACK_ForceToFront()

void FNullWindow::HACK_ForceToFront ( )

overridevirtual

@hack Force a window to front even if a different application is in front.

Reimplemented from FGenericWindow.

◆ Hide()

void FNullWindow::Hide ( )

overridevirtual

Native window should hide itself

Reimplemented from FGenericWindow.

◆ Initialize()

void FNullWindow::Initialize	(	class FNullApplication *const	Application,
		const TSharedRef< FGenericWindowDefinition > &	InDefinition,
		const TSharedPtr< FNullWindow > &	InParent,
		const bool	bShowImmediately
	)

◆ IsDefinitionValid()

bool FNullWindow::IsDefinitionValid ( ) const

overridevirtual

Returns: Returns true if the window definition is valid

Reimplemented from FGenericWindow.

◆ IsForegroundWindow()

bool FNullWindow::IsForegroundWindow ( ) const

overridevirtual

Returns: true if the window is in the foreground

Reimplemented from FGenericWindow.

◆ IsFullscreenSupported()

bool FNullWindow::IsFullscreenSupported ( ) const

overridevirtual

Returns: true if the window is in the foreground

Reimplemented from FGenericWindow.

◆ IsManualManageDPIChanges()

bool FNullWindow::IsManualManageDPIChanges ( ) const

overridevirtual

determines whether or not this window does its own DPI management

Reimplemented from FGenericWindow.

◆ IsMaximized()

bool FNullWindow::IsMaximized ( ) const

overridevirtual

Returns: true if the native window is maximized, false otherwise

Reimplemented from FGenericWindow.

◆ IsMinimized()

bool FNullWindow::IsMinimized ( ) const

overridevirtual

Returns: true if the native window is minimized, false otherwise

Reimplemented from FGenericWindow.

◆ IsPointInWindow()

bool FNullWindow::IsPointInWindow	(	int32	X,
		int32	Y
	)		const

overridevirtual

Returns: true if native window exists underneath the coordinates

Reimplemented from FGenericWindow.

◆ IsVisible()

bool FNullWindow::IsVisible ( ) const

overridevirtual

Returns: true if the native window is visible, false otherwise

Reimplemented from FGenericWindow.

◆ Make()

TSharedRef< FNullWindow > FNullWindow::Make ( )

static

◆ Maximize()

void FNullWindow::Maximize ( )

overridevirtual

Native window should implement this function by performing the equivalent of the Win32 maximize operation

Reimplemented from FGenericWindow.

◆ Minimize()

void FNullWindow::Minimize ( )

overridevirtual

Native window should implement this function by performing the equivalent of the Win32 minimize-to-taskbar operation

Reimplemented from FGenericWindow.

◆ MoveWindowTo()

void FNullWindow::MoveWindowTo	(	int32	X,
		int32	Y
	)

overridevirtual

Native windows should implement MoveWindowTo by relocating the platform-specific window to (X,Y).

Reimplemented from FGenericWindow.

◆ ReshapeWindow()

void FNullWindow::ReshapeWindow	(	int32	X,
		int32	Y,
		int32	Width,
		int32	Height
	)

overridevirtual

Native windows should implement ReshapeWindow by changing the platform-specific window to be located at (X,Y) and be the dimensions Width x Height.

Reimplemented from FGenericWindow.

◆ Restore()

void FNullWindow::Restore ( )

overridevirtual

Native window should implement this function by performing the equivalent of the Win32 restore operation

Reimplemented from FGenericWindow.

◆ SetDPIScaleFactor()

virtual void FNullWindow::SetDPIScaleFactor ( float Factor )

inlineoverridevirtual

sets a new DPI scale factor

Reimplemented from FGenericWindow.

◆ SetManualManageDPIChanges()

void FNullWindow::SetManualManageDPIChanges ( const bool bAutoHandle )

overridevirtual

call with a true argument if this window need to do its custom size management in response to DPI variations

Reimplemented from FGenericWindow.

◆ SetNativeWindowButtonsVisibility()

void FNullWindow::SetNativeWindowButtonsVisibility ( bool bVisible )

virtual

Shows or hides native window buttons on platforms that use them

Reimplemented from FGenericWindow.

◆ SetOpacity()

void FNullWindow::SetOpacity ( const float InOpacity )

overridevirtual

Sets the opacity of this window

Parameters

InOpacity The new window opacity represented as a floating point scalar

Reimplemented from FGenericWindow.

◆ SetText()

void FNullWindow::SetText ( const TCHAR *const Text )

overridevirtual

Sets the window text - usually the title but can also be text content for things like controls

Parameters

Text	The window's title or content text

Reimplemented from FGenericWindow.

◆ SetWindowFocus()

void FNullWindow::SetWindowFocus ( )

overridevirtual

Native windows should implement SetWindowFocus to let the OS know that a window has taken focus. Slate handles focus on a per widget basis internally but the OS still needs to know what window has focus for proper message routing

Reimplemented from FGenericWindow.

◆ SetWindowMode()

void FNullWindow::SetWindowMode ( EWindowMode::Type InNewWindowMode )

overridevirtual

Toggle native window between fullscreen and normal mode

Reimplemented from FGenericWindow.

◆ Show()

void FNullWindow::Show ( )

overridevirtual

Native window should make itself visible

Reimplemented from FGenericWindow.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/ApplicationCore/Public/Null/NullWindow.h
Engine/Source/Runtime/ApplicationCore/Private/Null/NullWindow.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~FNullWindow()

Member Function Documentation

◆ AdjustCachedSize()

◆ BringToFront()

◆ Destroy()

◆ DrawAttention()

◆ Enable()

◆ GetDefinition()

◆ GetDPIScaleFactor()

◆ GetFullScreenInfo()

◆ GetOSWindowHandle()

◆ GetRestoredDimensions()

◆ GetWindowBorderSize()

◆ GetWindowMode()

◆ GetWindowTitleBarSize()

◆ HACK_ForceToFront()

◆ Hide()

◆ Initialize()

◆ IsDefinitionValid()

◆ IsForegroundWindow()

◆ IsFullscreenSupported()

◆ IsManualManageDPIChanges()

◆ IsMaximized()

◆ IsMinimized()

◆ IsPointInWindow()

◆ IsVisible()

◆ Make()

◆ Maximize()

◆ Minimize()

◆ MoveWindowTo()

◆ ReshapeWindow()

◆ Restore()

◆ SetDPIScaleFactor()

◆ SetManualManageDPIChanges()

◆ SetNativeWindowButtonsVisibility()

◆ SetOpacity()

◆ SetText()

◆ SetWindowFocus()

◆ SetWindowMode()

◆ Show()