openrndr-extensions/org.openrndr.extensions/SingleScreenshot

SingleScreenshot

class SingleScreenshot : Screenshots(source)

specialized version of the Screenshots extension that takes a single screenshot and exits

Constructors

SingleScreenshot

constructor()

Functions

afterDraw

open override fun afterDraw(drawer: Drawer, program: Program)

beforeDraw

open override fun beforeDraw(drawer: Drawer, program: Program)

setup

open override fun setup(program: Program)

shutdown

open fun shutdown(program: Program)

trigger

fun trigger()

Trigger screenshot creation

Properties

afterScreenshot

val afterScreenshot: Event<ScreenshotEvent>

Event that is triggered after contents have been drawn and the screenshot has been committed to file

async

var async: Boolean

should saving be performed asynchronously?

beforeScreenshot

val beforeScreenshot: Event<ScreenshotEvent>

Event that is triggered just before drawing the contents for the screenshot

captureEveryFrame

var captureEveryFrame: Boolean

when true, capture every frame. when false, only capture on keypress.

contentScale

var contentScale: Double?

contentScale can be se to be greater than 1.0 for higher resolution screenshots

delayFrames

var delayFrames: Int

delays the screenshot for a number of frames. useful to let visuals build up in automated screenshots.

enabled

open override var enabled: Boolean

folder

var folder: String?

the folder where the screenshot will be saved to. Default value is "screenshots", saves in current working directory when set to null.

key

var key: String

the key that should be pressed to take a screenshot

listenToKeyDownEvent

var listenToKeyDownEvent: Boolean

listenToProduceAssetsEvent

var listenToProduceAssetsEvent: Boolean

multisample

var multisample: BufferMultisample?

multisample settings

name

var name: String?

override automatic naming for screenshot

outputFile

var outputFile: String

filename of the screenshot output

quitAfterScreenshot

var quitAfterScreenshot: Boolean

should the program quit after taking a screenshot?

screenshotTriggersRequestAssetsEvent

var screenshotTriggersRequestAssetsEvent: Boolean