View source

class WindowOptions

package glfw

@:nullSafety(Strict)@:structInit

Options used to create a window in GLFW.createWindow.

This should be created through a structure:

glfw.createWindow({
	title: "The title",
	width: 800,
	height: 600,
});

Variables

title:String

The initial, UTF-8 encoded window title.

width:Int

The desired width, in screen coordinates, of the window. This must be greater than zero.

height:Int

The desired height, in screen coordinates, of the window. This must be greater than zero.

@:optionaloptionalmonitor:Null<Monitor>

Optional, if present the monitor to use for fullscreen mode, else the window will be in windowed mode.

@:optionaloptionalautoIconify:Null<Bool>

Optional, specifies whether the fullscreen window will automatically iconify and restore the previous video mode on input focus loss.

This is ignored for windowed mode windows.

Default value is true.

@:optionaloptionalcenterCursor:Null<Bool>

Optional, specifies whether the cursor should be centered over the newly created fullscreen window.

This is ignored for windowed mode windows.

Default value is true.

@:optionaloptionalcursor:Null<Cursor>

Optional, specifies the default cursor to be used by the newly created window.

Defaults to the system cursor.

@:optionaloptionalcursorMode:Null<CursorMode>

Optional, specifies the cursor mode to be used by the newly created window.

Default valuse is CursorMode.Normal.

@:optionaloptionaldecorated:Null<Bool>

Optional, specifies whether the windowed mode window will have window decorations such as a border, a close widget, etc. An undecorated window will not be resizable by the user but will still allow the user to generate close events on some platforms.

This is ignored for fullscreen windows.

Default value is true.

@:optionaloptionalfloating:Null<Bool>

Optional, specifies whether the windowed mode window will be floating above other regular windows, also called topmost or always-on-top. This is intended primarily for debugging purposes and cannot be used to implement proper fullscreen windows.

This is ignored for fullscreen windows.

Default value is false.

@:optionaloptionalfocused:Null<Bool>

Optional, specifies whether the created window is given input focus.

Default value is true.

@:optionaloptionalfocusOnShow:Null<Bool>

Optional, specifies whether the window will be given input focus when Window.show is called.

Default value is true.

@:optionaloptionalkeysSticky:Null<Bool>

Optional, specifies whether sticky keys are enabled for the newly created window.

@:optionaloptionallockKeyModifiers:Null<Bool>

Optional, specifies whether caps lock and num lock key modifiers are set on key events for the newly created window.

@:optionaloptionalmaximized:Null<Bool>

Optional, specifies whether the window is maximized.

Default value is false.

@:optionaloptionalmouseButtonsSticky:Null<Bool>

Optional, specifies whether sticky mouse buttons are enabled for the newly created window.

@:optionaloptionalopacity:Null<Float>

Optional, specifies the opacity of the newly created window.

Default value is 1.0.

@:optionaloptionalopenCentered:Null<Bool>

Optional, specifies whether the window will be opened at the center of the screen instead of the placement recommended by the window system.

This is ignored for fullscreen windows.

Default value is false.

@:optionaloptionalresizable:Null<Bool>

Optional, specifies whether the windowed mode window will be resizable by the user. The window will still be resizable using the Window.setSize function.

This is ignored for fullscreen and undecorated windows.

Default value is true.

@:optionaloptionalvisible:Null<Bool>

Optional, specifies whether the window is visible.

Default value is true.