FNullWindow | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Runtime > ApplicationCore > Null

Inheritance Hierarchy

FGenericWindow
FNullWindow

References


Module	ApplicationCore
Header	/Engine/Source/Runtime/ApplicationCore/Public/Null/NullWindow.h
Include	#include "Null/NullWindow.h"

Syntax

class FNullWindow : public FGenericWindow

Remarks

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.

Constructors

No constructors are accessible with public or protected access.

Destructors

	Type	Name	Description
		~FNullWindow ()

Functions

	Type	Name	Description
	void	Initialize ( FNullApplication*const Application, const TSharedRef< FGenericWindowDefinition >& InDefinition, const TSharedPtr< FNullWindow >& InParent, const bool bShowImmediately )
	TSharedRef< FNullWindow >	Make ()

Overridden from FGenericWindow

Type	Name	Description
void	AdjustCachedSize ( FVector2D& Size )
void	BringToFront ( bool bForce )	Native windows should implement BringToFront by making this window the top-most window (i.e. focused).
void	Destroy ()	Native windows should implement this function by asking the OS to destroy OS-specific resource associated with the window (e.g. Win32 window handle)
void	DrawAttention ( const FWindowDrawAttentionParameters& Parameters )	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.
void	Enable ( bool bEnable )	Enables or disables the window. If disabled the window receives no input
const FGenericWindowDefinition &	GetDefinition ()
float	GetDPIScaleFactor ()
bool	GetFullScreenInfo ( int32& X, int32& Y, int32& Width, int32& Height )	Returns the rectangle of the screen the window is associated with
void *	GetOSWindowHandle ()	Gets the OS Window handle in the form of a void pointer for other API's
bool	GetRestoredDimensions ( int32& X, int32& Y, int32& Width, int32& Height )	Populates the size and location of the window when it is restored.
int32	GetWindowBorderSize ()	Gets OS specific window border size.
EWindowMode::Type	GetWindowMode ()
int32	GetWindowTitleBarSize ()	Gets OS specific window title bar size
void	HACK_ForceToFront ()	@hack Force a window to front even if a different application is in front.
void	Hide ()	Native window should hide itself
bool	IsDefinitionValid ()
bool	IsForegroundWindow ()
bool	IsFullscreenSupported ()
bool	IsManualManageDPIChanges ()	Determines whether or not this window does its own DPI management
bool	IsMaximized ()
bool	IsMinimized ()
bool	IsPointInWindow ( int32 X, int32 Y )
bool	IsVisible ()
void	Maximize ()	Native window should implement this function by performing the equivalent of the Win32 maximize operation
void	Minimize ()	Native window should implement this function by performing the equivalent of the Win32 minimize-to-taskbar operation
void	MoveWindowTo ( int32 X, int32 Y )	Native windows should implement MoveWindowTo by relocating the platform-specific window to (X,Y).
void	ReshapeWindow ( int32 X, int32 Y, int32 Width, int32 Height )	Native windows should implement ReshapeWindow by changing the platform-specific window to be located at (X,Y) and be the dimensions Width x Height.
void	Restore ()	Native window should implement this function by performing the equivalent of the Win32 restore operation
void	SetDPIScaleFactor ( float Factor )	Sets a new DPI scale factor
void	SetManualManageDPIChanges ( const bool bAutoHandle )	Call with a true argument if this window need to do its custom size management in response to DPI variations
void	SetNativeWindowButtonsVisibility ( bool bVisible )	Shows or hides native window buttons on platforms that use them
void	SetOpacity ( const float InOpacity )	Sets the opacity of this window
void	SetText ( const TCHAR*const Text )	Sets the window text - usually the title but can also be text content for things like controls
void	SetWindowFocus ()	Native windows should implement SetWindowFocus to let the OS know that a window has taken focus.
void	SetWindowMode ( EWindowMode::Type InNewWindowMode )	Toggle native window between fullscreen and normal mode
void	Show ()	Native window should make itself visible

Navigation