Package org.hexworks.zircon.api.application

This package contains the Application class that can be used to start a Zircon application. You can also find all the related configuration classes.

Types

AppConfig
Link copied to clipboard
common
data class AppConfig(blinkLengthInMilliSeconds: Long, cursorStyle: CursorStyle, cursorColor: TileColor, isCursorBlinking: Boolean, isClipboardAvailable: Boolean, defaultTileset: TilesetResource, defaultGraphicalTileset: TilesetResource, defaultColorTheme: ColorTheme, debugMode: Boolean, size: Size, fullScreen: Boolean, borderless: Boolean, title: String, fpsLimit: Int, debugConfig: DebugConfig, closeBehavior: CloseBehavior, shortcutsConfig: ShortcutsConfig, iconData: ByteArray?, iconPath: String?)
Object that encapsulates the configuration parameters for an Application.
Application
Link copied to clipboard
common
interface Application
An Application enhances a TileGrid with continuous rendering, and some additional functionality for starting, pausing, resuming and stopping it.
CloseBehavior
Link copied to clipboard
common
enum CloseBehavior : Enum<CloseBehavior>
The possible options to choose from when handling the event when the application window is closed.
CursorStyle
Link copied to clipboard
common
enum CursorStyle : Enum<CursorStyle>
Different cursor styles supported by TileGrid.
DebugConfig
Link copied to clipboard
common
data class DebugConfig(displayGrid: Boolean, displayCoordinates: Boolean, displayFps: Boolean, relaxBoundsCheck: Boolean)
Contains the configuration to be used when debug mode is enabled.
RenderData
Link copied to clipboard
common
data class RenderData(timestampMs: Long)
Contains metadata for a render step in Application.
ShortcutsConfig
Link copied to clipboard
common
data class ShortcutsConfig(activateFocused: KeyboardEventMatcher, deactivateActivated: KeyboardEventMatcher, focusNext: KeyboardEventMatcher, focusPrevious: KeyboardEventMatcher)
These are the shortcuts that Zircon will use for component activation / deactivation and focus handling (next / previous).