orx-shade-styles/org.openrndr.extra.shadestyles.fills.clip/ClipBuilder

ClipBuilder

class ClipBuilder : StyleParameters(source)

Constructors

constructor()

Properties

var blend: Double

var clipFit: FillFit

Defines the strategy for fitting a clip shape to its bounds.

var clipInner: Double

Defines the inner boundary threshold for applying a clipping mask.

clipMaskFunction

var clipMaskFunction: String

Represents the GLSL function used to define the clipping mask for a shader.

var clipOuter: Double

Specifies the outer threshold for the clipping effect in rendering.

var clipTransform: Matrix44

var clipUnits: FillUnits

Specifies the coordinate space used for defining clip shapes. The value can be one of the FillUnits enum constants, such as:

domainWarpFunction

var domainWarpFunction: String

A variable containing a GLSL function as a string that defines a domain warping operation applied to coordinates. Domain warping is typically used to introduce variations or distortions in patterns by altering the input space over which a procedure operates.

var feather: Double

Specifies the feathering amount applied to the edges of the clipping mask. Feathering softens the transition between clipped and unclipped regions, creating a smoother boundary. The value represents the width of the feathering effect, with 0.0 indicating no feathering.

var floor: Double

var invert: Boolean

Determines whether the current clipping mask should be inverted.

open override var parameterTypes: ObservableHashmap<String, String>

parameterValues

open override var parameterValues: MutableMap<String, Any>

textureBaseIndex

open override var textureBaseIndex: Int

Functions

fun build(): ClipBase

fun circle(builder: CircleClipBuilder.() -> Unit)

Adds a circular clipping mask to the current clip context.

fun ellipse(builder: EllipseClipBuilder.() -> Unit)

Adds an elliptical clipping mask to the current clip context.

fun line(builder: LineClipBuilder.() -> Unit)

Adds a line-shaped clipping mask to the current clip context.

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

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)

fun rectangle(builder: RectangleClipBuilder.() -> Unit)

Configures a rectangular clipping mask within the current clip context.

fun star(builder: StarClipBuilder.() -> Unit)

Adds a star-shaped clipping mask to the current clip context.