FGenericWindow

Windows
MacOS
Linux

Inheritance Hierarchy

FGenericWindow

FHoloLensWindow

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericWindow.h

Include

#include "GenericPlatform/GenericWindow.h"

Syntax

class FGenericWindow

Variables

Name Description

Protected variable

TSharedPtr< FGe...

 

Definition

Constructors

Name Description

Public function

FGenericWindow()

Destructors

Name Description

Public function Virtual

~FGenericWindow()

Functions

Name Description

Public function Virtual Const

void

 

AdjustCachedSize

(
    FVector2D& Size
)

Public function Virtual

void

 

BringToFront

(
    bool bForce
)

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

Public function 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)

Public function Virtual

void

 

DrawAttention

(
    const FWindowDrawAttentionParameter...
)

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.

Public function Virtual

void

 

Enable

(
    bool bEnable
)

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

Public function Virtual Const

const FGener...

 

GetDefinition()

Public function Virtual Const

float

 

GetDPIScaleFactor()

Public function Virtual Const

bool

 

GetFullScreenInfo

(
    int32& X,
    int32& Y,
    int32& Width,
    int32& Height
)

Returns the rectangle of the screen the window is associated with

Public function Virtual Const

void *

 

GetOSWindowHandle()

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

Public function Virtual

bool

 

GetRestoredDimensions

(
    int32& X,
    int32& Y,
    int32& Width,
    int32& Height
)

Populates the size and location of the window when it is restored.

Public function Virtual Const

int32

 

GetWindowBorderSize()

Gets OS specific window border size.

Public function Virtual Const

EWindowMode:...

 

GetWindowMode()

Public function Virtual Const

int32

 

GetWindowTitleBarSize()

Gets OS specific window title bar size

Public function Virtual

void

 

HACK_ForceToFront()

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

Public function Virtual

void

 

Hide()

Native window should hide itself

Public function Virtual Const

bool

 

IsDefinitionValid()

Public function Virtual Const

bool

 

IsForegroundWindow()

Public function Virtual Const

bool

 

IsManualManageDPIChanges()

Determines whether or not this window does its own DPI management

Public function Virtual Const

bool

 

IsMaximized()

Public function Virtual Const

bool

 

IsMinimized()

Public function Virtual Const

bool

 

IsPointInWindow

(
    int32 X,
    int32 Y
)

Public function Virtual Const

bool

 

IsVisible()

Public function Virtual

void

 

Maximize()

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

Public function Virtual

void

 

Minimize()

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

Public function Virtual

void

 

MoveWindowTo

(
    int32 X,
    int32 Y
)

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

Public function Virtual

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.

Public function Virtual

void

 

Restore()

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

Public function Virtual

void

 

SetDPIScaleFactor

(
    const float Factor
)

Sets a new DPI scale factor

Public function 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

Public function Virtual

void

 

SetNativeWindowButtonsVisibility

(
    bool bVisible
)

Shows or hides native window buttons on platforms that use them

Public function Virtual

void

 

SetOpacity

(
    const float InOpacity
)

Sets the opacity of this window

Public function Virtual

void

 

SetText

(
    const TCHAR*const Text
)

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

Public function Virtual

void

 

SetWindowFocus()

Native windows should implement SetWindowFocus to let the OS know that a window has taken focus.

Public function Virtual

void

 

SetWindowMode

(
    EWindowMode::Type InNewWindowMode
)

Toggle native window between fullscreen and normal mode

Public function Virtual

void

 

Show()

Native window should make itself visible

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback