data class MouseEvent(val position: Vector2, val rotation: Vector2, val dragDisplacement: Vector2, val type: MouseEventType, val button: MouseButton, val modifiers: Set<KeyModifier>)

Mouse event message

MouseEvents

interface MouseEvents

MouseEventType

enum MouseEventType : Enum<MouseEventType>

Mouse event type enumeration

MouseTracker

class MouseTracker(mouseEvents: MouseEvents)

Keeps track of which mouse buttons are currently pressed. Usage: val mt = MouseTracker(mouse), then read mt.pressedButtons. Replaces MouseEvents.pressedButtons.

Pointer

@JvmRecord

data class Pointer(val position: Vector2, val primary: Boolean, val timestamp: Long)

Pointers

class Pointers(application: () -> Application)

PresentationMode

enum PresentationMode : Enum<PresentationMode>

PresentationMode describes modes of frame presentation

ProduceAssetsEvent

@JvmRecord

data class ProduceAssetsEvent(val origin: Any, val program: Program, val assetMetadata: AssetMetadata)

Program

interface Program : InputEvents, ExtensionHost, Clock

ProgramEvent

@JvmRecord

data class ProgramEvent(val type: ProgramEventType)

program event message

ProgramEventType

enum ProgramEventType : Enum<ProgramEventType>

program event type

ProgramImplementation

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

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

RequestAssetsEvent

@JvmRecord

data class RequestAssetsEvent(val origin: Any, val program: Program)

UnfocusBehaviour

enum UnfocusBehaviour : Enum<UnfocusBehaviour>

Window

interface Window

WindowConfiguration

@JvmRecord

data class WindowConfiguration(val title: String = "OPENRNDR", val position: IntVector2? = null, val width: Int = 640, val height: Int = 480, val resizable: Boolean = false, val closable: Boolean = true, val alwaysOnTop: Boolean = false, val hideDecorations: Boolean = false, val multisample: WindowMultisample = WindowMultisample.Disabled)

WindowEvent

@JvmRecord

data class WindowEvent(val type: WindowEventType, val position: Vector2, val size: Vector2, val focused: Boolean)

window event message

WindowEventType

enum WindowEventType : Enum<WindowEventType>

WindowMultisample

sealed class WindowMultisample

WindowProgram

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

Functions

application

expect fun application(build: ApplicationBuilder.() -> Unit)

expect fun application(program: Program, configuration: Configuration = Configuration())

actual fun application(build: ApplicationBuilder.() -> Unit)

Creates and runs a synchronous OPENRNDR application using the provided ApplicationBuilder.

actual fun application(program: Program, configuration: Configuration)

Runs program as a synchronous application with the given configuration.

actual fun application(build: ApplicationBuilder.() -> Unit)

Creates and runs a synchronous OPENRNDR application using the provided ApplicationBuilder.

actual fun application(program: Program, configuration: Configuration)

Runs program as a synchronous application with the given configuration.

buildConfiguration

fun buildConfiguration(builder: Configuration.() -> Unit): Configuration

Convenience function for building a new Configuration.

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

launch

fun launch(block: suspend () -> Unit)

launch

fun Dispatcher.launch(start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend CoroutineScope.() -> Unit): Job

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

launch a coroutine in the Program context

namedTimestamp