Navigation
API > API/Runtime > API/Runtime/ApplicationCore > API/Runtime/ApplicationCore/GenericPlatform
Inheritance Hierarchy
- FGenericWindow
- FNullWindow
References
| Module | ApplicationCore |
| Header | /Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericWindow.h |
| Include | #include "GenericPlatform/GenericWindow.h" |
Syntax
class FGenericWindow
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< FGenericWindowDefinition > | Definition |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| 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 & | ||
   |
float | ||
   |
bool | GetFullScreenInfo
(
int32& X, |
Returns the rectangle of the screen the window is associated with |
   |
void * | Gets the OS Window handle in the form of a void pointer for other API's | |
  |
bool | GetRestoredDimensions
(
int32& X, |
Populates the size and location of the window when it is restored. |
   |
int32 | Gets OS specific window border size. | |
   |
EWindowMode::Type | ||
   |
int32 | Gets OS specific window title bar size | |
  |
void | Force a window to front even if a different application is in front. | |
  |
void | Hide () |
Native window should hide itself |
   |
bool | ||
   |
bool | ||
   |
bool | ||
   |
bool | Determines whether or not this window does its own DPI management | |
   |
bool | IsMaximized () |
|
   |
bool | IsMinimized () |
|
   |
bool | IsPointInWindow
(
int32 X, |
|
   |
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, |
Native windows should implement MoveWindowTo by relocating the platform-specific window to (X,Y). |
  |
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. |
  |
void | Restore () |
Native window should implement this function by performing the equivalent of the Win32 restore operation |
  |
void | SetDPIScaleFactor
(
const 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 | 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 |