openrndr-application/org.openrndr/ProgramImplementation

ProgramImplementation

open class ProgramImplementation(val suspend: Boolean = false) : Program

The Program class, this is where most user implementations start.

Constructors

fun ProgramImplementation(suspend: Boolean = false)

Types

ApplicationClipboard

inner class ApplicationClipboard : Clipboard

Window

inner class Window : Window

Simplified window interface

Functions

animate

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

draw

open override fun draw()

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

drawImpl

open override fun drawImpl()

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

extend

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, userDraw: Program.() -> Unit)

install an extension function for the given ExtensionStage

setup

open suspend override fun setup()

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

Properties

application

open lateinit override var application: Application

assetMetadata

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

clipboard

open override val clipboard: ProgramImplementation.ApplicationClipboard

clock

open override var clock: () -> Double

clock function. defaults to returning the application time.

deltaTime

val deltaTime: Double

The elapsed time since the last draw loop

dispatcher

open override val dispatcher: Dispatcher

drawer

open lateinit override var drawer: Drawer

driver

open lateinit override var driver: Driver

ended

open override var ended: Event<ProgramEvent>

program ended event

extensions

open override val extensions: MutableList<Extension>

list of installed extensions

frameCount

open override var frameCount: Int = 0

height

open override var height: Int = 0

isNested

open override var isNested: Boolean = false

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

open override val produceAssets: Event<ProduceAssetsEvent>

program

open override val program: Program

requestAssets

open override val requestAssets: Event<RequestAssetsEvent>

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 = 0

window

open override val window: ProgramImplementation.Window

Sources

common source