Add orx-timer
This commit is contained in:
39
orx-timer/README.md
Normal file
39
orx-timer/README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# orx-timer
|
||||
|
||||
`orx-timer` adds simple timer functionality to OPENRNDR's Program
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Add `orx-timer` to the `orxFeatures` set in your build.gradle.kts
|
||||
|
||||
## Usage
|
||||
|
||||
`orx-timer` facilitates two extension functions for `Program`
|
||||
|
||||
`fun Program.repeat(intervalInSeconds: Double, count: Int? = null, initialDelayInSeconds: Double = 0.0, action: () -> Unit)`
|
||||
|
||||
`fun Program.timeOut(delayInSeconds: Double, action: () -> Unit)`
|
||||
|
||||
A simple example looks like this:
|
||||
|
||||
```$kotlin
|
||||
fun main() = application {
|
||||
program {
|
||||
repeat(2.0) {
|
||||
println("hello there )
|
||||
}
|
||||
extend {
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Note that drawing inside the `repeat` action has no effect. Have a look at the demos listed below for an example of
|
||||
`repeat` triggered drawing.
|
||||
|
||||
## Demos
|
||||
|
||||
* [Simple `repeat` demonstration](src/demo/kotlin/DemoRepeat01.kt)
|
||||
* [A `repeat` demonstration with drawing](src/demo/kotlin/DemoRepeat02.kt)
|
||||
* [Simple `timeOut` demonstration](src/demo/kotlin/DemoTimeOut01.kt)
|
||||
Reference in New Issue
Block a user