Navigation
API > API/Runtime > API/Runtime/ApplicationCore
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.
| Name | FNullWindow |
| Type | class |
| Header File | /Engine/Source/Runtime/ApplicationCore/Public/Null/NullWindow.h |
| Include Path | #include "Null/NullWindow.h" |
Syntax
class FNullWindow : public FGenericWindow
Inheritance Hierarchy
- FGenericWindow → FNullWindow
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNullWindow() |
Protect the constructor; only TSharedRefs of this class can be made. | Null/NullWindow.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNullWindow() |
Null/NullWindow.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | bool | Null/NullWindow.h | ||
| bIsVisible | bool | Manually store window visibility as OS doesn't do that for us in nullplatform | Null/NullWindow.h | |
| DPIScaleFactor | float | Null/NullWindow.h | ||
| OwningApplication | FNullApplication * | Null/NullWindow.h | ||
| ScreenPosition | FIntPoint | Null/NullWindow.h | ||
| SizeInScreen | FIntPoint | Null/NullWindow.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Initialize
(
FNullApplication*const Application, |
Null/NullWindow.h |
Overridden from FGenericWindow
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AdjustCachedSize
(
FVector2D& Size |
Null/NullWindow.h | ||
virtual void BringToFront
(
bool bForce |
Native windows should implement BringToFront by making this window the top-most window (i.e. focused). | Null/NullWindow.h | |
virtual 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) | Null/NullWindow.h | |
virtual 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. | Null/NullWindow.h | |
virtual void Enable
(
bool bEnable |
Enables or disables the window. If disabled the window receives no input | Null/NullWindow.h | |
virtual const FGenericWindowDefinition & GetDefinition() |
Null/NullWindow.h | ||
virtual float GetDPIScaleFactor() |
Null/NullWindow.h | ||
virtual bool GetFullScreenInfo
(
int32& X, |
Returns the rectangle of the screen the window is associated with | Null/NullWindow.h | |
virtual void * GetOSWindowHandle() |
Gets the OS Window handle in the form of a void pointer for other API's | Null/NullWindow.h | |
virtual bool GetRestoredDimensions
(
int32& X, |
Populates the size and location of the window when it is restored. | Null/NullWindow.h | |
virtual int32 GetWindowBorderSize () |
Gets OS specific window border size. | Null/NullWindow.h | |
virtual EWindowMode::Type GetWindowMode() |
Null/NullWindow.h | ||
virtual int32 GetWindowTitleBarSize() |
Gets OS specific window title bar size | Null/NullWindow.h | |
virtual void HACK_ForceToFront() |
@hack Force a window to front even if a different application is in front. | Null/NullWindow.h | |
virtual void Hide() |
Native window should hide itself | Null/NullWindow.h | |
virtual bool IsDefinitionValid() |
Null/NullWindow.h | ||
virtual bool IsForegroundWindow() |
Null/NullWindow.h | ||
virtual bool IsFullscreenSupported() |
Null/NullWindow.h | ||
virtual bool IsManualManageDPIChanges() |
Determines whether or not this window does its own DPI management | Null/NullWindow.h | |
virtual bool IsMaximized() |
Null/NullWindow.h | ||
virtual bool IsMinimized() |
Null/NullWindow.h | ||
virtual bool IsPointInWindow
(
int32 X, |
Null/NullWindow.h | ||
virtual bool IsVisible() |
Null/NullWindow.h | ||
virtual void Maximize() |
Native window should implement this function by performing the equivalent of the Win32 maximize operation | Null/NullWindow.h | |
virtual void Minimize() |
Native window should implement this function by performing the equivalent of the Win32 minimize-to-taskbar operation | Null/NullWindow.h | |
virtual void MoveWindowTo
(
int32 X, |
Native windows should implement MoveWindowTo by relocating the platform-specific window to (X,Y). | Null/NullWindow.h | |
virtual void ReshapeWindow
(
int32 X, |
Native windows should implement ReshapeWindow by changing the platform-specific window to be located at (X,Y) and be the dimensions Width x Height. | Null/NullWindow.h | |
virtual void Restore() |
Native window should implement this function by performing the equivalent of the Win32 restore operation | Null/NullWindow.h | |
virtual void SetDPIScaleFactor
(
float Factor |
Sets a new DPI scale factor | Null/NullWindow.h | |
virtual 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 | Null/NullWindow.h | |
virtual void SetNativeWindowButtonsVisibility
(
bool bVisible |
Shows or hides native window buttons on platforms that use them | Null/NullWindow.h | |
virtual void SetOpacity
(
const float InOpacity |
Sets the opacity of this window | Null/NullWindow.h | |
virtual void SetText
(
const TCHAR*const Text |
Sets the window text - usually the title but can also be text content for things like controls | Null/NullWindow.h | |
virtual void SetWindowFocus () |
Native windows should implement SetWindowFocus to let the OS know that a window has taken focus. | Null/NullWindow.h | |
virtual void SetWindowMode
(
EWindowMode::Type InNewWindowMode |
Toggle native window between fullscreen and normal mode | Null/NullWindow.h | |
virtual void Show() |
Native window should make itself visible | Null/NullWindow.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FNullWindow > Make() |
Null/NullWindow.h |