openrndr-draw/org.openrndr.draw

Package-level declarations

Types

Array of Cubemap, all with the same ColorType, ColorFormat and other properties. Typically, used for efficient reflection probes, lighting and shadowing systems. This is a common interface to be implemented in various target languages.

actual interface ArrayCubemap

ArrayCubemapAttachment

class ArrayCubemapAttachment(val index: Int, val name: String?, val arrayCubemap: ArrayCubemap, val side: CubemapSide, val layer: Int, val level: Int) : ColorAttachment

ArrayCubemapImageBinding

class ArrayCubemapImageBinding(val arrayCubemap: ArrayCubemap, val level: Int, imageAccess: ImageAccess) : ImageBinding

ArrayTexture

expect abstract class ArrayTexture

actual abstract class ArrayTexture

ArrayTextureAttachment

class ArrayTextureAttachment(val index: Int, val name: String?, val arrayTexture: ArrayTexture, val layer: Int, val level: Int) : ColorAttachment

ArrayTextureImageBinding

class ArrayTextureImageBinding(val arrayTexture: ArrayTexture, val level: Int, imageAccess: ImageAccess) : ImageBinding

ArrayTextureLayerImageBinding

class ArrayTextureLayerImageBinding(val arrayTexture: ArrayTexture, val level: Int, imageAccess: ImageAccess) : ImageBinding

AtomicCounterBuffer

interface AtomicCounterBuffer

BatchBuilder

open class BatchBuilder(val drawer: Drawer)

BlendMode

enum BlendMode : Enum<BlendMode>

Used for controlling how pixels are blended together. The different modes can be used to simulate different kinds of effects like transparency, adding light, subtracting color and others.

BufferMultisample

sealed class BufferMultisample

Buffer multisample options

BufferPrimitiveType

enum BufferPrimitiveType : Enum<BufferPrimitiveType>

BufferTexture

expect abstract class BufferTexture

actual abstract class BufferTexture

BufferTextureFileFormat

enum BufferTextureFileFormat : Enum<BufferTextureFileFormat>

BufferTextureImageBinding

class BufferTextureImageBinding(val bufferTexture: BufferTexture, imageAccess: ImageAccess) : ImageBinding

BufferTextureShadow

expect abstract class BufferTextureShadow

actual abstract class BufferTextureShadow

BufferWriter

expect abstract class BufferWriter

actual abstract class BufferWriter

BufferWriterStd430

expect interface BufferWriterStd430

actual interface BufferWriterStd430

ChannelMask

@JvmRecord

data class ChannelMask(val red: Boolean, val green: Boolean, val blue: Boolean, val alpha: Boolean)

CharacterPair

@JvmRecord

data class CharacterPair(val left: Char, val right: Char)

CircleBatch

class CircleBatch(val geometry: VertexBuffer, val drawStyle: VertexBuffer) : AutoCloseable

Stored circle batch

CircleBatchBuilder

class CircleBatchBuilder(val drawer: Drawer) : BatchBuilder

Builder for stored circle batches

ColorAttachment

sealed class ColorAttachment

Color attachment for RenderTarget.

ColorBuffer

expect abstract class ColorBuffer : AutoCloseable

actual abstract class ColorBuffer : AutoCloseable

representation for simple images stored on GPU memory

ColorBufferAttachment

class ColorBufferAttachment(val index: Int, val name: String?, val colorBuffer: ColorBuffer, val level: Int, val ownedByRenderTarget: Boolean) : ColorAttachment

ColorBufferImageBinding

class ColorBufferImageBinding(val colorBuffer: ColorBuffer, val level: Int, imageAccess: ImageAccess) : ImageBinding

ColorBufferProxy

data class ColorBufferProxy(val url: String, val loader: ColorBufferLoader, val persistent: Boolean)

ColorBufferShadow

interface ColorBufferShadow

ColorFormat

enum ColorFormat : Enum<ColorFormat>

Color format enumeration

ColorSampling

enum ColorSampling : Enum<ColorSampling>

Color sampling enumeration

ColorType

enum ColorType : Enum<ColorType>

Color type enumeration

ComputeShader

interface ComputeShader : ShaderImageBindings, ShaderBufferBindings, ShaderUniforms

ComputeStructure

data class ComputeStructure(val structDefinitions: String? = null, val uniforms: String? = null, val buffers: String? = null, val computeTransform: String, val computePreamble: String, val workGroupSize: IntVector3)

ComputeStyle

class ComputeStyle : StyleParameters, StyleBufferBindings, StyleImageBindings

ComputeStyle class

ComputeStyleManager

abstract class ComputeStyleManager

Cubemap

expect interface Cubemap

actual interface Cubemap

CubemapAttachment

class CubemapAttachment(val index: Int, val name: String?, val cubemap: Cubemap, val side: CubemapSide, val level: Int) : ColorAttachment

CubemapImageBinding

class CubemapImageBinding(val cubemap: Cubemap, val level: Int, imageAccess: ImageAccess) : ImageBinding

CubemapLayerImageBinding

class CubemapLayerImageBinding(val cubemap: Cubemap, val side: CubemapSide, val level: Int, imageAccess: ImageAccess) : ImageBinding

CubemapSide

enum CubemapSide : Enum<CubemapSide>

CullTestPass

enum CullTestPass : Enum<CullTestPass>

Cull test pass condition enumeration

DepthBuffer

interface DepthBuffer

DepthFormat

enum DepthFormat : Enum<DepthFormat>

Depth format enumeration

DepthTestPass

enum DepthTestPass : Enum<DepthTestPass>

Depth test pass condition enumeration

DrawContext

@JvmRecord

data class DrawContext(val model: Matrix44, val view: Matrix44, val projection: Matrix44, val width: Int, val height: Int, val contentScale: Double, val modelViewScalingFactor: Double)

Drawer

class Drawer(val driver: Driver)

The Drawer

DrawerConfiguration

object DrawerConfiguration

Drawer configuration

DrawPrimitive

enum DrawPrimitive : Enum<DrawPrimitive>

Draw primitive type enumeration

DrawQuality

enum DrawQuality : Enum<DrawQuality>

Specifies if to optimize drawing for quality or performance.

DrawStyle

data class DrawStyle(var clip: Rectangle? = null, var fill: ColorRGBa? = ColorRGBa.WHITE, var stroke: ColorRGBa? = ColorRGBa.BLACK, var lineCap: LineCap = LineCap.BUTT, var lineJoin: LineJoin = LineJoin.MITER, var strokeWeight: Double = 1.0, var smooth: Boolean = true, var miterLimit: Double = 4.0, var quality: DrawQuality = DrawQuality.QUALITY, var depthTestPass: DepthTestPass = DepthTestPass.ALWAYS, var depthWrite: Boolean = false, var blendMode: BlendMode = BlendMode.OVER, var cullTestPass: CullTestPass = CullTestPass.ALWAYS, var channelWriteMask: ChannelMask = ChannelMask(red = true, green = true, blue = true, alpha = true), var alphaToCoverage: Boolean = false, var shadeStyle: ShadeStyle? = null, var fontMap: FontMap? = null, var kerning: KernMode = KernMode.METRIC, var textSetting: TextSettingMode = TextSettingMode.SUBPIXEL, var stencil: StencilStyle = StencilStyle(), var frontStencil: StencilStyle = stencil, var backStencil: StencilStyle = stencil, var colorMatrix: Matrix55 = Matrix55.IDENTITY)

A data class that controls the look of drawing operations including stroke and fill color, stroke weight and more.

DrawThread

interface DrawThread

Filter

open class Filter(shader: Shader? = null, watcher: ShaderWatcher? = null)

Filter base class. Renders "full-screen" quads.

Filter1to1

open class Filter1to1(shader: Shader? = null, watcher: ShaderWatcher? = null) : Filter

Filter2to1

open class Filter2to1(shader: Shader? = null, watcher: ShaderWatcher? = null) : Filter

Filter3to1

open class Filter3to1(shader: Shader? = null, watcher: ShaderWatcher? = null) : Filter

Filter4to1

open class Filter4to1(shader: Shader? = null, watcher: ShaderWatcher? = null) : Filter

FontImageMap

class FontImageMap(val texture: ColorBuffer, val map: Map<Char, IntRectangle>, val glyphMetrics: Map<Char, GlyphMetrics>, val size: Double, val contentScale: Double, val ascenderLength: Double, val descenderLength: Double, val height: Double, val leading: Double, val name: String) : FontMap

A type of FontMap which keeps characters pre-rendered in a ColorBuffer texture at a specific font size.

FontImageMapDescriptor

@JvmRecord

data class FontImageMapDescriptor(val fontUrl: String, val size: Double, val alphabet: Set<Char>, val contentScale: Double)

FontMap

abstract class FontMap

Holds properties common to both vector-based and image-based FontMaps.

FontVectorMap

abstract class FontVectorMap : FontMap

A type of FontMap which keeps characters stored as vector data. Good for displaying very large text and for displaying text at different scales, but in general less performant than FontImageMap because it is not pre-rendered.

GlyphMetrics

@JvmRecord

data class GlyphMetrics(val advanceWidth: Double, val leftSideBearing: Double, val xBitmapShift: Double, val yBitmapShift: Double)

ImageAccess

typealias ImageAccess = BufferAccess

ImageBinding

sealed class ImageBinding

ImageFileDetails

data class ImageFileDetails(val width: Int, val height: Int, val channels: Int)

Details for an image

ImageFileFormat

enum ImageFileFormat : Enum<ImageFileFormat>

File format used while saving to file

ImageFlag

typealias ImageFlag = BufferFlag

IndexBuffer

expect interface IndexBuffer

actual interface IndexBuffer

IndexType

enum IndexType : Enum<IndexType>

KernMode

enum KernMode : Enum<KernMode>

LayeredArrayCubemapAttachment

class LayeredArrayCubemapAttachment(val index: Int, val name: String?, val arrayCubemap: ArrayCubemap, val level: Int) : ColorAttachment

LayeredArrayTextureAttachment

class LayeredArrayTextureAttachment(val index: Int, val name: String?, val arrayTexture: ArrayTexture, val level: Int) : ColorAttachment

LayeredCubemapAttachment

class LayeredCubemapAttachment(val index: Int, val name: String?, val cubemap: Cubemap, val level: Int) : ColorAttachment

LayeredVolumeTextureAttachment

class LayeredVolumeTextureAttachment(val index: Int, val name: String?, val volumeTexture: VolumeTexture, val level: Int) : ColorAttachment

LineCap

enum LineCap : Enum<LineCap>

Line cap enumeration

LineJoin

enum LineJoin : Enum<LineJoin>

Line join enumeration

MagnifyingFilter

enum MagnifyingFilter : Enum<MagnifyingFilter>

Texture filters for magnification

MinifyingFilter

enum MinifyingFilter : Enum<MinifyingFilter>

Texture filters used for minification

ObservableHashmap

class ObservableHashmap<K, V>(val b: MutableMap<K, V>, val onChange: () -> Unit) : MutableMap<K, V>

PointBatch

class PointBatch(val geometry: VertexBuffer, val drawStyle: VertexBuffer)

PointBatchBuilder

class PointBatchBuilder(val drawer: Drawer) : BatchBuilder

RectangleBatch

class RectangleBatch(val geometry: VertexBuffer, val drawStyle: VertexBuffer)

RectangleBatchBuilder

class RectangleBatchBuilder(val drawer: Drawer) : BatchBuilder

RenderTarget

interface RenderTarget

RenderTargetBuilder

class RenderTargetBuilder(renderTarget: RenderTarget)

ResizableColorBuffer

class ResizableColorBuffer(width: Int, height: Int, contentScale: Double = 1.0, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), multisample: BufferMultisample = BufferMultisample.Disabled, levels: Int = 1, session: Session? = Session.active)

ResizableRenderTarget

class ResizableRenderTarget(width: Int, height: Int, contentScale: Double = 1.0, multisample: BufferMultisample = BufferMultisample.Disabled, session: Session?, val builder: RenderTargetBuilder.() -> Unit)

Session

class Session(val parent: Session?)

Session

SessionStatistics

class SessionStatistics(val renderTargets: Int, val colorBuffers: Int, val depthBuffers: Int, val bufferTextures: Int, val indexBuffers: Int, val vertexBuffers: Int, val shaders: Int, val cubemaps: Int, val arrayTextures: Int, val computeShaders: Int, val atomicCounterBuffers: Int, val arrayCubemaps: Int, val shaderStorageBuffers: Int)

Session statistics

Shader

interface Shader : ShaderImageBindings, ShaderUniforms, ShaderBufferBindings

ShaderBufferBindings

interface ShaderBufferBindings

ShaderImageBindings

interface ShaderImageBindings

ShaderStorageBuffer

expect interface ShaderStorageBuffer

actual interface ShaderStorageBuffer

ShaderStorageBufferShadow

interface ShaderStorageBufferShadow

ShaderStorageElement

interface ShaderStorageElement

ShaderStorageFormat

class ShaderStorageFormat

ShaderStoragePrimitive

data class ShaderStoragePrimitive(val name: String, val type: BufferPrimitiveType, val arraySize: Int = 1, var offset: Int = 0, var padding: Int = 0) : ShaderStorageElement

ShaderStorageStruct

data class ShaderStorageStruct(val structName: String, val name: String, val elements: List<ShaderStorageElement>, val arraySize: Int = 1, var offset: Int = 0) : ShaderStorageElement

ShaderType

enum ShaderType : Enum<ShaderType>

ShaderUniforms

interface ShaderUniforms

ShaderWatcher

expect class ShaderWatcher

actual class ShaderWatcher

ShaderWatcherBuilder

class ShaderWatcherBuilder

ShadeStructure

data class ShadeStructure(var structDefinitions: String? = null, var uniforms: String? = null, var attributes: String? = null, var buffers: String? = null, var vertexTransform: String? = null, var geometryTransform: String? = null, var fragmentTransform: String? = null, var vertexPreamble: String? = null, var geometryPreamble: String? = null, var fragmentPreamble: String? = null, var outputs: String? = null, var varyingOut: String? = null, var varyingIn: String? = null, var varyingBridge: String? = null, var suppressDefaultOutput: Boolean = false)

ShadeStyle

open class ShadeStyle : StyleParameters, StyleBufferBindings, StyleImageBindings

ShadeStyleFilter

class ShadeStyleFilter(val shadeStyle: ShadeStyle) : Filter, StyleParameters

A Filter that uses the ShadeStyle interface and language

ShadeStyleFilter1to1

class ShadeStyleFilter1to1(val shadeStyle: ShadeStyle) : Filter1to1, StyleParameters

ShadeStyleFilter2to1

class ShadeStyleFilter2to1(val shadeStyle: ShadeStyle) : Filter2to1, StyleParameters

ShadeStyleGLSL

expect class ShadeStyleGLSL

A collection of granules, or template functions for writing stylable shaders in GLSL. ShadeStyleGLSL is used in OPENRNDR's shader generators but is exposed to the user such that they too can write shader generators.

actual class ShadeStyleGLSL

ShadeStyleManager

abstract class ShadeStyleManager(val name: String)

ShadeStyleOutput

data class ShadeStyleOutput(val attachment: Int, val format: ColorFormat = ColorFormat.RGBa, val type: ColorType = ColorType.FLOAT32)

StencilOperation

enum StencilOperation : Enum<StencilOperation>

StencilStyle

data class StencilStyle(var stencilFailOperation: StencilOperation = StencilOperation.KEEP, var depthFailOperation: StencilOperation = StencilOperation.KEEP, var depthPassOperation: StencilOperation = StencilOperation.KEEP, var stencilTestMask: Int = 255, var stencilTestReference: Int = 0, var stencilWriteMask: Int = 255, var stencilTest: StencilTest = StencilTest.DISABLED)

StencilTest

enum StencilTest : Enum<StencilTest>

Struct

open class Struct<T : Struct<T>>

Struct definition

StructuredBuffer

class StructuredBuffer<T : Struct<T>>(val struct: T, val ssbo: ShaderStorageBuffer)

StyleBufferBindings

interface StyleBufferBindings

StyleImageBindings

interface StyleImageBindings

StyleParameters

interface StyleParameters

TextSettingMode

enum TextSettingMode : Enum<TextSettingMode>

TransformTarget

enum TransformTarget : Enum<TransformTarget>

UniformBlock

interface UniformBlock

UniformBlockLayout

data class UniformBlockLayout(val sizeInBytes: Int, val entries: Map<String, UniformDescription>)

UniformDescription

data class UniformDescription(val name: String, val type: UniformType, val size: Int, val offset: Int, val stride: Int)

UniformType

enum UniformType : Enum<UniformType>

VertexBuffer

expect abstract class VertexBuffer : AutoCloseable

actual abstract class VertexBuffer : AutoCloseable

VertexBufferShadow

interface VertexBufferShadow

VertexElement

data class VertexElement(val attribute: String, val offset: Int, val type: VertexElementType, val arraySize: Int)

VertexElementType

enum VertexElementType : Enum<VertexElementType>

Vertex element type enumeration

VertexFormat

class VertexFormat

VertexBuffer Layout describes how data is organized in the VertexBuffer

VolumeTexture

expect interface VolumeTexture

actual interface VolumeTexture

VolumeTextureAttachment

class VolumeTextureAttachment(val index: Int, val name: String?, val volumeTexture: VolumeTexture, val layer: Int, val level: Int) : ColorAttachment

VolumeTextureImageBinding

class VolumeTextureImageBinding(val volumeTexture: VolumeTexture, val level: Int, imageAccess: ImageAccess) : ImageBinding

VolumeTextureLayerImageBinding

class VolumeTextureLayerImageBinding(val volumeTexture: VolumeTexture, val layer: Int, val level: Int, imageAccess: ImageAccess) : ImageBinding

WrapMode

enum WrapMode : Enum<WrapMode>

Texture wrapping mode

Functions

arrayCubemap

fun arrayCubemap(width: Int, layers: Int, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), levels: Int = 1, session: Session = Session.active): ArrayCubemap

Creates an array cubemap

arrayTexture

fun arrayTexture(width: Int, height: Int, layers: Int, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), levels: Int = 1, session: Session = Session.active): ArrayTexture

Creates an array texture

bufferTexture

fun bufferTexture(elementCount: Int, format: ColorFormat = ColorFormat.RGBa, type: ColorType = ColorType.FLOAT32, session: Session? = Session.active): BufferTexture

create a BufferTexture

circleBatch

fun Drawer.circleBatch(build: CircleBatchBuilder.() -> Unit): CircleBatch

Create a stored batch of circles

codeFromStream

fun codeFromStream(stream: InputStream): String

codeFromURL

fun codeFromURL(url: URL): String

fun codeFromURL(url: String): String

colorBuffer

fun colorBuffer(width: Int, height: Int, contentScale: Double = 1.0, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), multisample: BufferMultisample = BufferMultisample.Disabled, levels: Int = 1, session: Session? = Session.active): ColorBuffer

create a ColorBuffer

computeShader1DExecuteSize

fun computeShader1DExecuteSize(workGroupSize: IntVector3, dataSize: Int): IntVector3

Determines optimal size of ComputeShader execution for 1-dimensional data of variable size.

computeShader2DExecuteSize

fun computeShader2DExecuteSize(workGroupSize: IntVector3, dataSize: IntVector2): IntVector3

Determines optimal size of ComputeShader execution for 2-dimensional data of variable size.

computeShaderExecuteSize

fun computeShaderExecuteSize(workGroupSize: IntVector3, dataSize: IntVector3): IntVector3

Determines optimal size of ComputeShader execution for 3-dimensional data of variable size.

computeStyle

fun computeStyle(builder: ComputeStyle.() -> Unit): ComputeStyle

constant

fun constant(color: ColorRGBa, ignoreAlpha: Boolean = true): Matrix55

createEquivalent

fun ColorBuffer.createEquivalent(width: Int = this.width, height: Int = this.height, contentScale: Double = this.contentScale, format: ColorFormat = this.format, type: ColorType = this.type, multisample: BufferMultisample = this.multisample, levels: Int = this.levels): ColorBuffer

create an equivalent ColorBuffer, with the option to override attributes

cubemap

fun cubemap(width: Int, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), levels: Int = 1, session: Session? = Session.active): Cubemap

defaultColorType

fun defaultColorType(format: ColorFormat): ColorType

Return the default color type for format

depthBuffer

fun depthBuffer(width: Int, height: Int, format: DepthFormat = DepthFormat.DEPTH24_STENCIL8, multisample: BufferMultisample): DepthBuffer

drawThread

fun drawThread(): DrawThread

creates and starts a DrawThread

execute

fun ComputeStyle.execute(width: Int = 1, height: Int = 1, depth: Int = 1)

filterShaderFromCode

fun filterShaderFromCode(fragmentShaderCode: String, name: String, includeShaderConfiguration: Boolean = true): Shader

filterShaderFromUrl

fun filterShaderFromUrl(url: String): Shader

filterWatcherFromUrl

fun filterWatcherFromUrl(url: String): ShaderWatcher

grayscale

fun grayscale(r: Double = 0.33, g: Double = 0.33, b: Double = 0.33): Matrix55

imageBinding

fun BufferTexture.imageBinding(imageAccess: ImageAccess): BufferTextureImageBinding

fun ArrayCubemap.imageBinding(level: Int = 0, imageAccess: ImageAccess): ArrayCubemapImageBinding

fun ArrayTexture.imageBinding(level: Int = 0, imageAccess: ImageAccess): ArrayTextureImageBinding

fun ColorBuffer.imageBinding(level: Int = 0, imageAccess: ImageAccess): ColorBufferImageBinding

fun Cubemap.imageBinding(level: Int = 0, imageAccess: ImageAccess): CubemapImageBinding

fun VolumeTexture.imageBinding(level: Int = 0, imageAccess: ImageAccess): VolumeTextureImageBinding

imageProxy

fun imageProxy(file: File, queue: Boolean = true, persistent: Boolean = false): ColorBufferProxy

fun imageProxy(fileOrUrl: String, queue: Boolean = true, persistent: Boolean = false): ColorBufferProxy

indexBuffer

fun indexBuffer(elementCount: Int, type: IndexType): IndexBuffer

isEquivalentTo

fun ColorBuffer.isEquivalentTo(other: ColorBuffer, ignoreWidth: Boolean = false, ignoreHeight: Boolean = false, ignoreContentScale: Boolean = false, ignoreFormat: Boolean = false, ignoreType: Boolean = false, ignoreMultisample: Boolean = false, ignoreLevels: Boolean = false): Boolean

check if this ColorBuffer is equivalent to other

isolated

fun Drawer.isolated(function: Drawer.() -> Unit)

Pushes style and model-view-projection matrices, calls function and pops.

isolatedWithTarget

fun Drawer.isolatedWithTarget(target: RenderTarget, function: Drawer.() -> Unit)

Pushes style and model-view-projection matrices, sets render target, calls function and pops.

launch

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

launches a coroutine on the DrawThread

loadBufferTexture

fun loadBufferTexture(file: File, formatHint: BufferTextureFileFormat? = BufferTextureFileFormat.ORB, session: Session? = Session.active): BufferTexture

load a buffer texture from a file

fun loadBufferTexture(url: URL, formatHint: BufferTextureFileFormat? = BufferTextureFileFormat.ORB, session: Session? = Session.active): BufferTexture

load a BufferTexture from a url

fun loadBufferTexture(fileOrUrl: String, formatHint: BufferTextureFileFormat? = BufferTextureFileFormat.ORB, session: Session? = Session.active): BufferTexture

load a buffer texture from file or url

loadCubemap

fun loadCubemap(data: CubemapImageData, session: Session? = Session.active): Cubemap

fun loadCubemap(fileOrUrl: String, formatHint: ImageFileFormat? = ImageFileFormat.DDS, session: Session? = Session.active): Cubemap

loadFont

fun loadFont(fileOrUrl: String, size: Double, characterSet: Set<Char> = defaultFontmapCharacterSet, contentScale: Double = 1.0, fontScaler: (Face) -> Double = ::fontHeightScaler): FontImageMap

loadImage

expect fun loadImage(fileOrUrl: String, formatHint: ImageFileFormat? = ImageFileFormat.guessFromExtension(fileOrUrl.split(".").last()), allowSRGB: Boolean = true, loadMipmaps: Boolean = true, session: Session? = Session.active): ColorBuffer

load an image from a file or url encoded as String, also accepts base64 encoded data urls

fun loadImage(buffer: MPPBuffer, name: String? = null, formatHint: ImageFileFormat? = null, allowSRGB: Boolean = true, session: Session? = Session.active): ColorBuffer

actual fun loadImage(fileOrUrl: String, formatHint: ImageFileFormat?, allowSRGB: Boolean, loadMipmaps: Boolean, session: Session?): ColorBuffer

load an image from a file or url encoded as String, also accepts base64 encoded data urls

fun loadImage(file: File, formatHint: ImageFileFormat? = ImageFileFormat.guessFromExtension(file.extension), allowSRGB: Boolean = true, loadMipmaps: Boolean = true, session: Session? = Session.active): ColorBuffer

load an image from File

fun loadImage(url: URL, formatHint: ImageFileFormat? = ImageFileFormat.guessFromExtension(url.toExternalForm().split(".").lastOrNull()), allowSRGB: Boolean = true, loadMipmaps: Boolean = true, session: Session? = Session.active): ColorBuffer

load an image from an url

actual fun loadImage(fileOrUrl: String, formatHint: ImageFileFormat?, allowSRGB: Boolean, loadMipmaps: Boolean, session: Session?): ColorBuffer

load an image from a file or url encoded as String, also accepts base64 encoded data urls

loadImageSuspend

expect suspend fun loadImageSuspend(fileOrUrl: String, formatHint: ImageFileFormat? = null, allowSRGB: Boolean = true, session: Session? = Session.active): ColorBuffer

actual suspend fun loadImageSuspend(fileOrUrl: String, formatHint: ImageFileFormat?, allowSRGB: Boolean, session: Session?): ColorBuffer

parameter

inline fun <T : Struct<T>> StyleParameters.parameter(name: String, value: T)

inline fun <T : Struct<T>> StyleParameters.parameter(name: String, value: Array<T>)

persistent

fun <T> persistent(builder: () -> T): T

Mark a GPU resource or code that uses GPU resources as persistent

pointBatch

fun Drawer.pointBatch(build: PointBatchBuilder.() -> Unit): PointBatch

Create a stored batch of points

probeImage

fun probeImage(fileOrUrl: String): ImageFileDetails?

Probe an image located at fileOrUrl

fun probeImage(file: File): ImageFileDetails?

rectangleBatch

fun Drawer.rectangleBatch(build: RectangleBatchBuilder.() -> Unit): RectangleBatch

Create a stored batch of rectangles

registerStructuredBuffer

inline fun <T : Struct<T>> StyleBufferBindings.registerStructuredBuffer(name: String, access: BufferAccess = BufferAccess.READ_WRITE, flags: Set<BufferFlag> = emptySet())

renderTarget

fun renderTarget(width: Int, height: Int, contentScale: Double = 1.0, multisample: BufferMultisample = BufferMultisample.Disabled, session: Session? = Session.active, builder: RenderTargetBuilder.() -> Unit): RenderTarget

build a RenderTarget

resizableColorBuffer

fun resizableColorBuffer(width: Int, height: Int, contentScale: Double = 1.0, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), multisample: BufferMultisample = BufferMultisample.Disabled, levels: Int = 1, session: Session? = Session.active): ResizableColorBuffer

resizableRenderTarget

fun resizableRenderTarget(width: Int, height: Int, contentScale: Double, multisample: BufferMultisample = BufferMultisample.Disabled, session: Session? = Session.active, builder: RenderTargetBuilder.() -> Unit): ResizableRenderTarget

session

fun session(code: () -> Unit)

Runs code inside a (short-lived) session

shaderStorageBuffer

fun shaderStorageBuffer(format: ShaderStorageFormat): ShaderStorageBuffer

shaderStorageFormat

fun shaderStorageFormat(builder: ShaderStorageFormat.() -> Unit): ShaderStorageFormat

shaderStorageFormatToVertexFormat

fun shaderStorageFormatToVertexFormat(format: ShaderStorageFormat, elementName: String?): VertexFormat

shaderWatcher

fun shaderWatcher(init: ShaderWatcherBuilder.() -> Unit): ShaderWatcher

shadeStyle

fun shadeStyle(builder: ShadeStyle.() -> Unit): ShadeStyle

shadeStyleType

inline fun <F> shadeStyleType(): String

shadeStyleTypeOrNull

inline fun <F> shadeStyleTypeOrNull(): String?

shadeStyleTypeToGLSL

fun shadeStyleTypeToGLSL(type: String): String

structToShaderStorageFormat

fun structToShaderStorageFormat(struct: Struct<*>): ShaderStorageFormat

structuredBuffer

fun <T : Struct<T>> structuredBuffer(struct: T): StructuredBuffer<T>

Create a StructuredBuffer from struct

structuredBuffer

inline fun <T : Struct<T>> StyleBufferBindings.structuredBuffer(name: String, buffer: StructuredBuffer<T>)

tint

fun tint(color: ColorRGBa): Matrix55

typeDef

inline fun <T : Struct<out T>> Struct<out T>.typeDef(name: String = T::class.simpleName!!, bufferDefinition: Boolean = false): String

typeDefImpl

fun <T : Struct<T>> Struct<T>.typeDefImpl(name: String, bufferDefinition: Boolean = false): String

vertexBuffer

fun vertexBuffer(vertexFormat: VertexFormat, vertexCount: Int, session: Session? = Session.active): VertexBuffer

VertexBuffer builder function.

vertexFormat

fun vertexFormat(builder: VertexFormat.() -> Unit): VertexFormat

Build a vertex format

volumeTexture

fun volumeTexture(width: Int, height: Int, depth: Int, format: ColorFormat = ColorFormat.RGBa, type: ColorType = defaultColorType(format), levels: Int = 1, session: Session? = Session.active): VolumeTexture

write