WindowConfig

View source
clay.WindowConfig (Class)

Window configuration information for creating windows

Instance Members

fullscreen: Bool

create in fullscreen, default: false, mobile true

trueFullscreen: Bool

If false, the users native window/desktop resolution will be used instead of the specified window size. default: false On native, changing the users video mode is less than ideal, so trueFullscreen is commonly discouraged.

resizable: Bool

allow the window to be resized, default: true

borderless: Bool

create as a borderless window, default: false

x: Int

window x at creation. Leave this alone to use the OS default.

y: Int

window y at creation. Leave this alone to use the OS default.

width: Int

window width at creation, default: 960

height: Int

window height at creation, default: 640

title: String

window title, default: 'clay app'

noInput: Bool

disables input arriving at/from this window. default: false

backgroundSleep: Float

Time in seconds to sleep when in the background. Setting this to zero disables the behavior. This has no effect on the web target, as there is no concept of sleep there (and browsers usually throttle background tabs). Higher sleep times (i.e 1/10 or 1/30) use less cpu. default: 1/15

new(?fullscreen: Null<Bool>, ?trueFullscreen: Null<Bool>, ?resizable: Null<Bool>, ?borderless: Null<Bool>, ?x: Null<Int>, ?y: Null<Int>, ?width: Null<Int>, ?height: Null<Int>, ?title: Null<String>, ?noInput: Null<Bool>, ?backgroundSleep: Null<Float>): Void
Name Type Default Description
fullscreen Null<Bool> (optional) create in fullscreen, default: false, mobile true
trueFullscreen Null<Bool> (optional) If false, the users native window/desktop resolution will be used instead of the specified window size. default: false On native, changing the users video mode is less than ideal, so trueFullscreen is commonly discouraged.
resizable Null<Bool> (optional) allow the window to be resized, default: true
borderless Null<Bool> (optional) create as a borderless window, default: false
x Null<Int> (optional) window x at creation. Leave this alone to use the OS default.
y Null<Int> (optional) window y at creation. Leave this alone to use the OS default.
width Null<Int> (optional) window width at creation, default: 960
height Null<Int> (optional) window height at creation, default: 640
title Null<String> (optional) window title, default: 'clay app'
noInput Null<Bool> (optional) disables input arriving at/from this window. default: false
backgroundSleep Null<Float> (optional) Time in seconds to sleep when in the background. Setting this to zero disables the behavior. This has no effect on the web target, as there is no concept of sleep there (and browsers usually throttle background tabs). Higher sleep times (i.e 1/10 or 1/30) use less cpu. default: 1/15

Metadata

Name Parameters
:structInit -
:publicFields -