A mutable list of extensions associated with the host. Extensions allow adding custom behavior or extending the functionality of the framework at various lifecycle stages such as setup, before draw, and after draw.

frameCount

open override var frameCount: Int

height

open override var height: Int

isNested

open override var isNested: Boolean

This is checked at runtime to disallow nesting extend blocks.

keyboard

open override val keyboard: Keyboard

mouse

open override val mouse: ApplicationMouse

name

open override var name: String

pointers

open override val pointers: Pointers

produceAssets

override val produceAssets: Event<ProduceAssetsEvent>

An event triggered when assets need to be produced or generated.

program

open override val program: Program

requestAssets

override val requestAssets: Event<RequestAssetsEvent>

An event triggered when there is a request for assets to be accessed or provided.

seconds

open override val seconds: Double

The number of seconds since program start, or the time from a custom clock. value is updated at the beginning of the frame only.

suspend

val suspend: Boolean = false

userProperties

open override var userProperties: MutableMap<String, Any>

A map that can be used to store arbitrary data, including functions

width

open override var width: Int

window

open override val window: ProgramImplementation.Window

Functions

animate

fun animate(animationFunction: Animatable.() -> Unit)

draw

open override fun draw()

The draw method is responsible for rendering the current state of the program. This method is called automatically for each frame during the runtime of the program. It serves as the main function to perform all visual updates, including drawing shapes, updating visuals, and handling animations based on the current state.

drawImage

fun Program.drawImage( width: Int, height: Int, contentScale: Double? = null, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), multisample: BufferMultisample? = null, drawFunction: Drawer.() -> Unit): ColorBuffer

Create an image ColorBuffer by drawing it

drawImpl

open override fun drawImpl()

extend

open override fun <T : Extension> extend(extension: T): T

Adds an extension to the host and returns the extension instance. The extension allows customization or extension of the host's functionality at various lifecycle stages such as setup, before draw, and after draw.

open override fun <T : Extension> extend(extension: T, configure: T.() -> Unit): T

Adds an extension to the host and applies a configuration block to it. This method allows customization or extension of the host's functionality by invoking a user-defined configuration on the provided extension.

open override fun extend(stage: ExtensionStage, userDraw: Program.() -> Unit)

Adds an extension to the program that executes a user-defined block of code at a specified extension stage. The execution stage can be SETUP, BEFORE_DRAW, or AFTER_DRAW. This method prevents nesting of extend calls.

launch

fun Program.launch( context: CoroutineContext = dispatcher, start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend CoroutineScope.() -> Unit): Job

launch a coroutine in the Program context

loadFont

fun Program.loadFont( fileOrUrl: String, size: Double, characterSet: Set<Char> = defaultFontmapCharacterSet, contentScale: Double = this.drawer.context.contentScale, fontScaler: (Face) -> Double = ::fontHeightScaler): FontImageMap

Load a FontImageMap

namedTimestamp

expect fun Program.namedTimestamp(extension: String = "", path: String? = null): String

Generates a timestamped name for the program, optionally including a file extension and path.

actual fun Program.namedTimestamp(extension: String, path: String?): String

setup

open suspend override fun setup()

updateFrameSecondsFromClock

open override fun updateFrameSecondsFromClock()

window

fun Program.window(configuration: WindowConfiguration = WindowConfiguration(), init: suspend Program.() -> Unit): ApplicationWindow