openrndr-application/org.openrndr/WindowProgram

WindowProgram

open class WindowProgram(val suspend: Boolean = false) : Program(source)

Constructors

constructor(suspend: Boolean = false)

Types

ApplicationClipboard

inner class ApplicationClipboard : Clipboard

inner class Window : Window

Simplified window interface

Properties

open lateinit override var application: Application

applicationWindow

lateinit var applicationWindow: ApplicationWindow

open override var assetMetadata: () -> AssetMetadata

assetProperties

open override var assetProperties: MutableMap<String, String>

backgroundColor

open override var backgroundColor: ColorRGBa?

background color that is used to clear the background every frame

open override val clipboard: ProgramImplementation.ApplicationClipboard

Represents the clipboard functionality for the application.

open override var clock: () -> Double

clock function. defaults to returning the application time.

val deltaTime: Double

The elapsed time since the last draw loop

open override val dispatcher: Dispatcher

open lateinit override var drawer: Drawer

open lateinit override var driver: Driver

open override var ended: Event<ProgramEvent>

program ended event

open override val extensions: MutableList<Extension>

list of installed extensions

open override var frameCount: Int

open override val gestures: Gestures

open override var height: Int

open override var isNested: Boolean

This is checked at runtime to disallow nesting extend blocks.

open override val keyboard: Keyboard

open override val mouse: ApplicationWindowMouse

open override var name: String

open override val pointers: Pointers

override val produceAssets: Event<ProduceAssetsEvent>

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

open override val program: Program

override val requestAssets: Event<RequestAssetsEvent>

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

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.

val suspend: Boolean

open override var userProperties: MutableMap<String, Any>

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

open override var width: Int

open override val window: WindowProgram.Window

Functions

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

open override fun draw()

This is the user facing draw call. It should be overridden by the user.

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

open override fun drawImpl()

This is the draw call that is called by Application. It takes care of handling extensions.

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

install an Extension

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

install an Extension and configure it

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

install an extension function for the given ExtensionStage

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

launch a coroutine in the Program context

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

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

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

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

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

open suspend override fun setup()

This runs exactly once before the first call to draw()

updateFrameSecondsFromClock

open override fun updateFrameSecondsFromClock()

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