Struct CreateWindowSettings

Settings for new window.

Assembly: FlaxEngine.dll

File: Engine/Platform/CreateWindowSettings.h

Syntax

public struct CreateWindowSettings

Constructors

CreateWindowSettings(const CreateWindowSettings& other)

Declaration

public CreateWindowSettings(const CreateWindowSettings& other) = default

Parameters

CreateWindowSettings other

CreateWindowSettings(CreateWindowSettings&& other)

Declaration

public CreateWindowSettings(CreateWindowSettings&& other) = default

Parameters

CreateWindowSettings other

DEPRECATED("Use Type instead")

True if it's a regular window, false for tooltips, context menu and other utility windows. [Deprecated in v1.12]

Declaration

public DEPRECATED("Use Type instead") bool IsRegularWindow

Parameters

"Use Type instead" CreateWindowSettings_DEPRECATED__Use_Type_instead__

Fields

ActivateWhenFirstShown

Auto activate window after show.

Declaration

public bool ActivateWhenFirstShown = true

Field Value

bool

AllowDragAndDrop

Enable/disable drag and drop actions over the window.

Declaration

public bool AllowDragAndDrop = false

Field Value

bool

AllowInput

Allow window to capture input.

Declaration

public bool AllowInput = true

Field Value

bool

AllowMaximize

Allow window maximize action.

Declaration

public bool AllowMaximize = true

Field Value

bool

AllowMinimize

Allow window minimize action.

Declaration

public bool AllowMinimize = true

Field Value

bool

Data

The custom data (platform dependant).

Declaration

public void* Data = nullptr

Field Value

void

Fullscreen

True if show window fullscreen on show.

Declaration

public bool Fullscreen = false

Field Value

bool

HasBorder

Enable/disable window border.

Declaration

public bool HasBorder = true

Field Value

bool

HasSizingFrame

Enable/disable window sizing frame.

Declaration

public bool HasSizingFrame = true

Field Value

bool

IsTopmost

True if window topmost, otherwise false as default layout.

Declaration

public bool IsTopmost = false

Field Value

bool

MaximumSize

The maximum size. Set to 0 to use unlimited size.

Declaration

public Float2 MaximumSize = Float2(0, 0)

Field Value

Float2

MinimumSize

The minimum size.

Declaration

public Float2 MinimumSize = Float2(1, 1)

Field Value

Float2

Parent

The native parent window pointer.

Declaration

public Window* Parent = nullptr

Field Value

Window

Position

The custom start position.

Declaration

public Float2 Position = Float2(100, 400)

Field Value

Float2

ShowAfterFirstPaint

Enable/disable window auto-show after the first paint.

Declaration

public bool ShowAfterFirstPaint = true

Field Value

bool

ShowInTaskbar

True if show window on taskbar, otherwise it will be hidden.

Declaration

public bool ShowInTaskbar = true

Field Value

bool

Size

The client size.

Declaration

public Float2 Size = Float2(640, 480)

Field Value

Float2

StartPosition

The start position mode.

Declaration

public WindowStartPosition StartPosition = WindowStartPosition::Manual

Field Value

WindowStartPosition

SupportsTransparency

Enable/disable window transparency support. Required to change window opacity property.

Declaration

public bool SupportsTransparency = false

Field Value

bool

Title

The title.

Declaration

public String Title

Field Value

String

Type

The type of window. The type affects the behaviour of the window in system level. Note: Tooltip and Popup windows require Parent to be set.

Declaration

public WindowType Type = WindowType::Regular

Field Value

WindowType

Methods

CreateWindowSettings()

Declaration

public PRAGMA_DISABLE_DEPRECATION_WARNINGS CreateWindowSettings()

Returns

PRAGMA_DISABLE_DEPRECATION_WARNINGS

operator=(const CreateWindowSettings& other)

Declaration

public CreateWindowSettings operator=(const CreateWindowSettings& other) = default

Parameters

CreateWindowSettings other

Returns

CreateWindowSettings