View source

class Window

package openfl.display

extends Window

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@:access(openfl.display.Stage)@SuppressWarnings("checkstyle:FieldDocComment")

Available on all platforms

The Window class is a Lime Window instance that automatically initializes an OpenFL stage for the current window.

Methods

Inherited Variables

Defined by Window

read onlyapplication:Application

borderless:Bool

read onlycontext:RenderContext

cursor:MouseCursor

read onlydisplay:Display

displayMode:DisplayMode

read onlyelement:Dynamic

frameRate:Float

The current frame rate (measured in frames-per-second) of the window.

On some platforms, a frame rate of 60 or greater may imply vsync, which will perform more quickly on displays with a higher refresh rate

fullscreen:Bool

height:Int

read onlyhidden:Bool

read onlyid:Int

maxHeight:Int

maxWidth:Int

maximized:Bool

minHeight:Int

minWidth:Int

minimized:Bool

mouseLock:Bool

read onlynativeHandle:Dynamic

@:value(new Event<Void>())read onlyonActivate:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonClose:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonDeactivate:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<String>())read onlyonDropFile:_Event_String_Void<String ‑> Void> = new Event<String>()

@:value(new Event<Void>())read onlyonEnter:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonExpose:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonFocusIn:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonFocusOut:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonFullscreen:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonHide:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<KeyCode -> KeyModifier>())read onlyonKeyDown:_Event_lime_ui_KeyCode_lime_ui_KeyModifier_Void<(KeyCode, KeyModifier) ‑> Void> = new Event<KeyCode -> KeyModifier>()

@:value(new Event<KeyCode -> KeyModifier -> haxe.Int64>())read onlyonKeyDownPrecise:_Event_lime_ui_KeyCode_lime_ui_KeyModifier_haxe_Int64_Void<(KeyCode, KeyModifier, Int64) ‑> Void> = new Event<KeyCode -> KeyModifier -> haxe.Int64>()

@:value(new Event<KeyCode -> KeyModifier>())read onlyonKeyUp:_Event_lime_ui_KeyCode_lime_ui_KeyModifier_Void<(KeyCode, KeyModifier) ‑> Void> = new Event<KeyCode -> KeyModifier>()

@:value(new Event<KeyCode -> KeyModifier -> haxe.Int64>())read onlyonKeyUpPrecise:_Event_lime_ui_KeyCode_lime_ui_KeyModifier_haxe_Int64_Void<(KeyCode, KeyModifier, Int64) ‑> Void> = new Event<KeyCode -> KeyModifier -> haxe.Int64>()

@:value(new Event<Void>())read onlyonLeave:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonMaximize:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonMinimize:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Float -> Float -> MouseButton>())read onlyonMouseDown:_Event_Float_Float_lime_ui_MouseButton_Void<(Float, Float, MouseButton) ‑> Void> = new Event<Float -> Float -> MouseButton>()

@:value(new Event<Float -> Float>())read onlyonMouseMove:_Event_Float_Float_Void<(Float, Float) ‑> Void> = new Event<Float -> Float>()

@:value(new Event<Float -> Float>())read onlyonMouseMoveRelative:_Event_Float_Float_Void<(Float, Float) ‑> Void> = new Event<Float -> Float>()

@:value(new Event<Float -> Float -> Int>())read onlyonMouseUp:_Event_Float_Float_Int_Void<(Float, Float, Int) ‑> Void> = new Event<Float -> Float -> Int>()

@:value(new Event<Float -> Float -> MouseWheelMode>())read onlyonMouseWheel:_Event_Float_Float_lime_ui_MouseWheelMode_Void<(Float, Float, MouseWheelMode) ‑> Void> = new Event<Float -> Float -> MouseWheelMode>()

@:value(new Event<Float -> Float>())read onlyonMove:_Event_Float_Float_Void<(Float, Float) ‑> Void> = new Event<Float -> Float>()

@:value(new Event<RenderContext>())read onlyonRender:_Event_lime_graphics_RenderContext_Void<RenderContext ‑> Void> = new Event<RenderContext>()

@:value(new Event<Void>())read onlyonRenderContextLost:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<RenderContext>())read onlyonRenderContextRestored:_Event_lime_graphics_RenderContext_Void<RenderContext ‑> Void> = new Event<RenderContext>()

@:value(new Event<Int -> Int>())read onlyonResize:_Event_Int_Int_Void<(Int, Int) ‑> Void> = new Event<Int -> Int>()

@:value(new Event<Void>())read onlyonRestore:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<Void>())read onlyonShow:_Event_Void_Void<() ‑> Void> = new Event<Void>()

@:value(new Event<String -> Int -> Int>())read onlyonTextEdit:_Event_String_Int_Int_Void<(String, Int, Int) ‑> Void> = new Event<String -> Int -> Int>()

@:value(new Event<String>())read onlyonTextInput:_Event_String_Void<String ‑> Void> = new Event<String>()

opacity:Float

parameters:Dynamic

resizable:Bool

read onlyscale:Float

read onlystage:Stage

textInputEnabled:Bool

title:String

visible:Bool

width:Int

x:Int

y:Int

Inherited Methods

Defined by Window

@:value({ title : null, message : null })alert(?message:String, ?title:String):Void

focus():Void

move(x:Int, y:Int):Void

@:value({ rect : null })readPixels(?rect:Rectangle):Image

resize(width:Int, height:Int):Void

setIcon(image:Image):Void

setMaxSize(width:Int, height:Int):Void

setMinSize(width:Int, height:Int):Void

setTextInputRect(value:Rectangle):Rectangle

setVSyncMode(mode:WindowVSyncMode):Bool

Sets the swap interval for the current window.

Returns:

false if the swap interval could not be set

toString():String

warpMouse(x:Int, y:Int):Void