openrndr-draw/org.openrndr.draw/ShadeStyle

ShadeStyle

open class ShadeStyle(var parameterValues: MutableMap<String, Any> = mutableMapOf(), var textureBaseIndex: Int = 2) : StyleParameters, StyleBufferBindings, StyleImageBindings(source)

Represents a customizable and composable style for shaders and rendering pipelines. This class allows defining transformations, preambles, and shader outputs as well as binding buffers and images for use in rendering.

ShadeStyle provides mechanisms for combining different styles and managing parameters for complex rendering effects.

Primary Features:

Shader Transformations: Define custom vertex, geometry, and fragment transformations.
Shader Preambles: Specify custom preamble code blocks for vertex, geometry, and fragment shaders.
Parameter Management: Facilitate management of shader parameters and types.
Outputs: Manage shader outputs such as fragment colors.
Buffer and Image Bindings: Enable configuration and binding of buffers and images.

ShadeStyle is designed for flexibility and modularity in shader-based rendering pipelines, enabling advanced rendering techniques and reusable styles.

Inheritors

ComposedShadeStyle

Constructors

ShadeStyle

constructor(parameterValues: MutableMap<String, Any> = mutableMapOf(), textureBaseIndex: Int = 2)

Properties

attributes

var attributes: MutableList<VertexBuffer>

bufferAccess

open override val bufferAccess: MutableMap<String, BufferAccess>

bufferFlags

open override val bufferFlags: MutableMap<String, Set<BufferFlag>>

buffers

open override val buffers: MutableMap<String, String>

bufferTypes

open override val bufferTypes: MutableMap<String, String>

bufferValues

open override var bufferValues: MutableMap<String, Any>

dirty

open var dirty: Boolean

Is the structure of this shade style changed since its shaders were generated?

fragmentPreamble

var fragmentPreamble: String?

Represents an optional preamble string for a shader's fragment stage. This property allows customization of the initial setup or definitions that precede main shader code for the fragment stage.

fragmentTransform

var fragmentTransform: String?

Specifies the transformation applied to the fragment shader stage. This property holds an optional string value which represents the GLSL code or expressions defining the transformation logic. When the value of this property is changed, the dirty flag is set to true, indicating that the shader needs to be recompiled or updated.

geometryPreamble

var geometryPreamble: String?

geometryTransform

var geometryTransform: String?

imageAccess

open override val imageAccess: MutableMap<String, ImageAccess>

imageArrayLength

open override val imageArrayLength: MutableMap<String, Int>

imageBindings

open override val imageBindings: MutableMap<String, Int>

imageFlags

open override val imageFlags: MutableMap<String, Set<ImageFlag>>

imageTypes

open override val imageTypes: MutableMap<String, String>

imageValues

open override val imageValues: MutableMap<String, Array<out ImageBinding>>

libraries

var libraries: List<GlslLibrary>

The GLSL libraries the code of this shade style uses, their code is emitted before the preambles of the stages that read their names

outputs

var outputs: ObservableHashmap<String, ShadeStyleOutput>

parameterTypes

open override var parameterTypes: ObservableHashmap<String, String>

parameterValues

open override var parameterValues: MutableMap<String, Any>

structureVersion

var structureVersion: Long

Counts the changes of the structure of this shade style: its code, parameter types and outputs

suppressDefaultOutput

var suppressDefaultOutput: Boolean

textureBaseIndex

open override var textureBaseIndex: Int

vertexPreamble

var vertexPreamble: String?

Represents the preamble for vertex shading code in the shade style. This property is used to define custom vertex processing logic and, when modified, marks the state as dirty to trigger a necessary update.

vertexTransform

var vertexTransform: String?

Specifies a transformation applied to the vertex shader in the form of a string.

Functions

attributes

fun attributes(attributesBuffer: VertexBuffer)

buffer

open fun buffer(name: String, buffer: AtomicCounterBuffer)

@JvmName(name = "bufferCommand")

open fun buffer(name: String, buffer: CommandBuffer<Command>)

@JvmName(name = "bufferIndexedCommand")

open fun buffer(name: String, buffer: CommandBuffer<IndexedCommand>)

open fun buffer(name: String, buffer: IndexBuffer)

open fun buffer(name: String, buffer: ShaderStorageBuffer)

image

open fun image(name: String, values: Array<out ImageBinding>)

open fun image(name: String, value: ImageBinding)

open fun image(name: String, arrayTextures: Array<ArrayTexture>, levels: Array<Int> = Array(arrayTextures.size) { 0 })

open fun image(name: String, colorBuffers: Array<ColorBuffer>, levels: Array<Int> = Array(colorBuffers.size) { 0 })

open fun image(name: String, cubemaps: Array<Cubemap>, levels: Array<Int> = Array(cubemaps.size) { 0 })

open fun image(name: String, volumeTextures: Array<VolumeTexture>, levels: Array<Int> = Array(volumeTextures.size) { 0 })

open fun image(name: String, arrayTexture: ArrayTexture, level: Int = 0)

open fun image(name: String, colorBuffer: ColorBuffer, level: Int = 0)

open fun image(name: String, cubemap: Cubemap, level: Int = 0)

open fun image(name: String, volumeTexture: VolumeTexture, level: Int = 0)

open fun image(name: String, arrayCubemap: ArrayCubemap, level: Int = 0)

Binds an ArrayCubemap as an image to be used in computations such as shaders. Validates the presence of an existing image binding with the specified name and configures the binding using the given ArrayCubemap and mipmap level.

imageBindingType

open fun imageBindingType(value: ImageBinding): String

output

fun output(name: String, output: ShadeStyleOutput)

Parameter

open fun <R : Any> Parameter(customName: String? = null, initialValue: R? = null): Parameter<R>

Creates a Parameter property with the specified constraints and associates it with a custom name or the property name.

parameter

open fun parameter(name: String, value: Array<ColorRGBa>)

open fun parameter(name: String, value: Array<Matrix33>)

open fun parameter(name: String, value: Array<Matrix44>)

open fun parameter(name: String, value: Array<Vector2>)

open fun parameter(name: String, value: Array<Vector3>)

open fun parameter(name: String, value: Array<Vector4>)

open fun parameter(name: String, value: Boolean)

open fun parameter(name: String, value: Double)

open fun parameter(name: String, value: DoubleArray)

open fun parameter(name: String, value: Float)

open fun parameter(name: String, value: Int)

open fun parameter(name: String, value: IntArray)

open fun parameter(name: String, value: ColorRGBa)

open fun parameter(name: String, value: ArrayCubemap)

open fun parameter(name: String, value: ArrayTexture)

open fun parameter(name: String, value: BufferTexture)

open fun parameter(name: String, value: ColorBuffer)

open fun parameter(name: String, value: Cubemap)

open fun parameter(name: String, value: DepthBuffer)

open fun parameter(name: String, value: VolumeTexture)

open fun parameter(name: String, value: BooleanVector2)

open fun parameter(name: String, value: BooleanVector3)

open fun parameter(name: String, value: BooleanVector4)

open fun parameter(name: String, value: IntVector2)

open fun parameter(name: String, value: IntVector3)

open fun parameter(name: String, value: IntVector4)

open fun parameter(name: String, value: Matrix33)

open fun parameter(name: String, value: Matrix44)

open fun parameter(name: String, value: Vector2)

open fun parameter(name: String, value: Vector3)

open fun parameter(name: String, value: Vector4)

open fun parameter(name: String, value: DynamicParameter)

Sets name to a parameter that is resolved in the shader, read from a texture or computed by GLSL code

open fun parameter(name: String, value: DynamicParameterSource)

Sets name to the dynamic parameter that value provides, it is read from value when the style is used

parameter

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

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

parameterType

fun parameterType(name: String): String

plus

operator fun plus(other: ShadeStyle): ShadeStyle

Composes this shade style with other: this shade style is applied first, then other, each in its own namespace, so they can use the same names for parameters, functions and varyings

registerImageBinding

open fun StyleImageBindings.registerImageBinding(name: String, access: ImageAccess = ImageAccess.READ_WRITE, flags: Set<ImageFlag>, arrayLength: Int = -1)

registerStructuredBuffer

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

resolveDynamicParameters

fun ShadeStyle.resolveDynamicParameters(): ShadeStyle

This shade style with its dynamic parameters and libraries resolved: the shade style itself when it has none, otherwise a shade style that reads them through resolver functions and has the code of the libraries it uses in its preambles. Shade style managers use it to make shaders.

structuredBuffer

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