openrndr-application/org.openrndr/Program

Program

interface Program : InputEvents, ExtensionHost, Clock(source)

Inheritors

ProgramImplementation

Functions

abstract fun draw()

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

abstract fun drawImpl()

abstract fun <T : Extension> extend(extension: T): T

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

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

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

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

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

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

abstract suspend fun setup()

updateFrameSecondsFromClock

abstract fun updateFrameSecondsFromClock()

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

Properties

abstract var application: Application

abstract var assetMetadata: () -> AssetMetadata

assetProperties

abstract var assetProperties: MutableMap<String, String>

backgroundColor

abstract var backgroundColor: ColorRGBa?

abstract val clipboard: ProgramImplementation.ApplicationClipboard

abstract var clock: () -> Double

abstract val dispatcher: Dispatcher

abstract var drawer: Drawer

abstract var driver: Driver

abstract var ended: Event<ProgramEvent>

abstract val extensions: MutableList<Extension>

abstract val frameCount: Int

abstract var height: Int

abstract var isNested: Boolean

abstract val keyboard: KeyEvents

abstract val mouse: MouseEvents

abstract var name: String

abstract val pointers: Pointers

abstract val produceAssets: Event<ProduceAssetsEvent>

abstract val program: Program

abstract val requestAssets: Event<RequestAssetsEvent>

abstract val seconds: Double

abstract var userProperties: MutableMap<String, Any>

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

abstract var width: Int

abstract val window: Window