haze-utils/dev.chrisbanes.haze

Package-level declarations

Types

value class Bitmask(value: Int = 0)

Immutable integer-backed set of bit flags.

@RequiresOptIn(message = "This is an internal Haze API and should not be used outside of the library. It may be changed or removed without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class InternalHazeApi

Marks public declarations reserved for Haze's internal module-to-module implementation.

MutableRuntimeShaderRenderEffect

interface MutableRuntimeShaderRenderEffect

A runtime shader render effect whose uniforms can be updated without recompiling its source.

PlatformColorFilter

actual typealias PlatformColorFilter = ColorFilter

typealias PlatformColorFilter = ColorFilter

Platform-specific color filter type.

expect class PlatformColorFilter

Platform-specific color filter type.

actual typealias PlatformColorFilter = ColorFilter

typealias PlatformColorFilter = ColorFilter

Platform-specific color filter type.

PlatformContext

actual typealias PlatformContext = Context

typealias PlatformContext = Context

Android Context used as the Haze platform context.

expect abstract class PlatformContext

Platform-specific context required by built-in Haze renderers.

actual abstract class PlatformContext

Stateless platform context used by Skiko-backed Haze renderers.

PlatformRenderEffect

actual typealias PlatformRenderEffect = RenderEffect

typealias PlatformRenderEffect = RenderEffect

Platform-specific render effect type.

expect class PlatformRenderEffect

Platform-specific render effect type.

actual typealias PlatformRenderEffect = ImageFilter

typealias PlatformRenderEffect = ImageFilter

Platform-specific render effect type.

PlatformRuntimeEffect

actual class PlatformRuntimeEffect(sksl: String)

On Android, we use RuntimeShader directly rather than a RuntimeEffect. This class wraps the SKSL to create RuntimeShader instances on demand.

expect class PlatformRuntimeEffect

Platform-specific runtime effect type for compiling shaders.

actual typealias PlatformRuntimeEffect = RuntimeEffect

typealias PlatformRuntimeEffect = RuntimeEffect

Platform-specific runtime effect type for compiling shaders.

Poko

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Poko

Generates value-based equals, hashCode, and toString implementations for the class.

RuntimeShaderRenderEffectException

class RuntimeShaderRenderEffectException(cause: Throwable) : RuntimeException

A platform runtime shader or its native render-effect graph could not be constructed.

RuntimeShaderUniformProvider

interface RuntimeShaderUniformProvider

Interface for setting uniforms on runtime shaders.

Functions

asComposeRenderEffect

@RequiresApi(value = 31)

actual fun PlatformRenderEffect.asComposeRenderEffect(): RenderEffect

Converts this platform render effect to a Compose RenderEffect.

expect fun PlatformRenderEffect.asComposeRenderEffect(): RenderEffect

Converts this platform render effect to a Compose RenderEffect.

actual fun PlatformRenderEffect.asComposeRenderEffect(): RenderEffect

Converts this platform render effect to a Compose RenderEffect.

blendForeground

fun PlatformRenderEffect.blendForeground(foreground: PlatformRenderEffect, blendMode: BlendMode, offset: Offset = Offset.Unspecified): PlatformRenderEffect

Blends this render effect with a foreground effect.

createBlendColorFilter

@RequiresApi(value = 29)

actual fun createBlendColorFilter(color: Int, blendMode: BlendMode): PlatformColorFilter

Creates a color filter that blends with a given color.

expect fun createBlendColorFilter(color: Int, blendMode: BlendMode): PlatformColorFilter

Creates a color filter that blends with a given color.

actual fun createBlendColorFilter(color: Int, blendMode: BlendMode): PlatformColorFilter

Creates a color filter that blends with a given color.

createBlendRenderEffect

@RequiresApi(value = 31)

actual fun createBlendRenderEffect(blendMode: BlendMode, background: PlatformRenderEffect, foreground: PlatformRenderEffect, crop: Rect?): PlatformRenderEffect

Creates a blend PlatformRenderEffect from two render effects.

expect fun createBlendRenderEffect(blendMode: BlendMode, background: PlatformRenderEffect, foreground: PlatformRenderEffect, crop: Rect? = null): PlatformRenderEffect

Creates a blend PlatformRenderEffect from two render effects.

actual fun createBlendRenderEffect(blendMode: BlendMode, background: PlatformRenderEffect, foreground: PlatformRenderEffect, crop: Rect?): PlatformRenderEffect

Creates a blend PlatformRenderEffect from two render effects.

createBlurRenderEffect

@RequiresApi(value = 31)

actual fun createBlurRenderEffect(radiusX: Float, radiusY: Float, tileMode: TileMode, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect?

Creates a blur PlatformRenderEffect.

expect fun createBlurRenderEffect(radiusX: Float, radiusY: Float, tileMode: TileMode, input: PlatformRenderEffect? = null, crop: Rect? = null): PlatformRenderEffect?

Creates a blur PlatformRenderEffect.

actual fun createBlurRenderEffect(radiusX: Float, radiusY: Float, tileMode: TileMode, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect?

Creates a blur PlatformRenderEffect.

createColorFilterRenderEffect

@RequiresApi(value = 31)

actual fun createColorFilterRenderEffect(colorFilter: PlatformColorFilter, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect

Creates a color filter PlatformRenderEffect.

expect fun createColorFilterRenderEffect(colorFilter: PlatformColorFilter, input: PlatformRenderEffect? = null, crop: Rect? = null): PlatformRenderEffect

Creates a color filter PlatformRenderEffect.

actual fun createColorFilterRenderEffect(colorFilter: PlatformColorFilter, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect

Creates a color filter PlatformRenderEffect.

createFractalNoiseShader

@RequiresApi(value = 33)

actual fun createFractalNoiseShader(baseFrequencyX: Float, baseFrequencyY: Float, numOctaves: Int, seed: Float): Shader

Creates a fractal noise shader.

expect fun createFractalNoiseShader(baseFrequencyX: Float, baseFrequencyY: Float, numOctaves: Int, seed: Float): Shader

Creates a fractal noise shader.

actual fun createFractalNoiseShader(baseFrequencyX: Float, baseFrequencyY: Float, numOctaves: Int, seed: Float): Shader

Creates a fractal noise shader.

createMutableRuntimeShaderRenderEffect

@RequiresApi(value = 33)

actual fun createMutableRuntimeShaderRenderEffect(effect: PlatformRuntimeEffect, shaderNames: Array<String>, inputs: Array<PlatformRenderEffect?>): MutableRuntimeShaderRenderEffect

Creates a mutable-uniform runtime shader render effect with the given child shaders.

expect fun createMutableRuntimeShaderRenderEffect(effect: PlatformRuntimeEffect, shaderNames: Array<String>, inputs: Array<PlatformRenderEffect?>): MutableRuntimeShaderRenderEffect

Creates a mutable-uniform runtime shader render effect with the given child shaders.

actual fun createMutableRuntimeShaderRenderEffect(effect: PlatformRuntimeEffect, shaderNames: Array<String>, inputs: Array<PlatformRenderEffect?>): MutableRuntimeShaderRenderEffect

Creates a mutable-uniform runtime shader render effect with the given child shaders.

createOffsetRenderEffect

@RequiresApi(value = 31)

actual fun createOffsetRenderEffect(offsetX: Float, offsetY: Float, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect

Creates an offset PlatformRenderEffect.

expect fun createOffsetRenderEffect(offsetX: Float, offsetY: Float, input: PlatformRenderEffect? = null, crop: Rect? = null): PlatformRenderEffect

Creates an offset PlatformRenderEffect.

actual fun createOffsetRenderEffect(offsetX: Float, offsetY: Float, input: PlatformRenderEffect?, crop: Rect?): PlatformRenderEffect

Creates an offset PlatformRenderEffect.

createProgressiveBlurRenderEffect

fun createProgressiveBlurRenderEffect(blurRadiusPx: Float, size: Size, offset: Offset, mask: Shader): PlatformRenderEffect

Creates a separable progressive blur clipped to size at offset.

createRuntimeEffect

actual fun createRuntimeEffect(sksl: String): PlatformRuntimeEffect

Creates a PlatformRuntimeEffect from SKSL shader code.

expect fun createRuntimeEffect(sksl: String): PlatformRuntimeEffect

Creates a PlatformRuntimeEffect from SKSL shader code.

actual fun createRuntimeEffect(sksl: String): PlatformRuntimeEffect

Creates a PlatformRuntimeEffect from SKSL shader code.

createRuntimeShaderRenderEffect

@RequiresApi(value = 33)

actual fun createRuntimeShaderRenderEffect(effect: PlatformRuntimeEffect, shaderNames: Array<String>, inputs: Array<PlatformRenderEffect?>, uniforms: RuntimeShaderUniformProvider.() -> Unit): PlatformRenderEffect

Creates a runtime shader PlatformRenderEffect with the given effect and child shaders.

expect fun createRuntimeShaderRenderEffect(effect: PlatformRuntimeEffect, shaderNames: Array<String>, inputs: Array<PlatformRenderEffect?>, uniforms: RuntimeShaderUniformProvider.() -> Unit = {}): PlatformRenderEffect

Creates a runtime shader PlatformRenderEffect with the given effect and child shaders.

createShaderRenderEffect

@RequiresApi(value = 31)

actual fun createShaderRenderEffect(shader: Shader, crop: Rect?): PlatformRenderEffect

Creates a PlatformRenderEffect from a shader.

expect fun createShaderRenderEffect(shader: Shader, crop: Rect? = null): PlatformRenderEffect

Creates a PlatformRenderEffect from a shader.

actual fun createShaderRenderEffect(shader: Shader, crop: Rect?): PlatformRenderEffect

Creates a PlatformRenderEffect from a shader.

isRuntimeShaderRenderEffectSupported

@ChecksSdkIntAtLeast(api = 33)

actual fun isRuntimeShaderRenderEffectSupported(): Boolean

Returns whether the device supports Android runtime-shader render effects.

expect fun isRuntimeShaderRenderEffectSupported(): Boolean

Returns whether runtime-shader render effects are supported on the current platform.

actual fun isRuntimeShaderRenderEffectSupported(): Boolean

Returns true because Skiko supports runtime-shader render effects.

requirePlatformContext

actual fun CompositionLocalConsumerModifierNode.requirePlatformContext(): PlatformContext

Returns the Android context associated with this modifier node.

expect fun CompositionLocalConsumerModifierNode.requirePlatformContext(): PlatformContext

Returns the PlatformContext associated with this modifier node.

actual fun CompositionLocalConsumerModifierNode.requirePlatformContext(): PlatformContext

Returns the shared Skiko PlatformContext.

then

@RequiresApi(value = 31)

actual inline fun PlatformRenderEffect.then(other: PlatformRenderEffect): PlatformRenderEffect

Chains this render effect with another, composing them.

expect fun PlatformRenderEffect.then(other: PlatformRenderEffect): PlatformRenderEffect

Chains this render effect with another, composing them.

actual fun PlatformRenderEffect.then(other: PlatformRenderEffect): PlatformRenderEffect

Chains this render effect with another, composing them.

toAndroidBlendMode

@RequiresApi(value = 29)

fun BlendMode.toAndroidBlendMode(): BlendMode

Converts a Compose BlendMode to Android's AndroidBlendMode.

toPlatformColorFilter

actual fun ColorFilter.toPlatformColorFilter(): PlatformColorFilter

Converts a Compose ColorFilter to an Android platform PlatformColorFilter.

expect fun ColorFilter.toPlatformColorFilter(): PlatformColorFilter

Converts a Compose ColorFilter to a platform PlatformColorFilter.

actual fun ColorFilter.toPlatformColorFilter(): PlatformColorFilter

Converts a Compose ColorFilter to a Skia platform PlatformColorFilter.

toSkiaBlendMode

fun BlendMode.toSkiaBlendMode(): BlendMode

Converts a Compose BlendMode to Skia's SkiaBlendMode.

trace

actual inline fun <R> trace(sectionName: String, block: () -> R): R

Runs block inside a synchronous Android trace section named sectionName.

expect inline fun <R> trace(sectionName: String, block: () -> R): R

Runs block inside a synchronous platform trace section named sectionName.

actual inline fun <R> trace(sectionName: String, block: () -> R): R

Runs block inside a Compose trace section named sectionName.

traceAsync

actual inline suspend fun <R> traceAsync(sectionName: String, cookie: Int, crossinline block: suspend () -> R): R

Runs block inside an asynchronous Android trace section identified by cookie.

expect inline suspend fun <R> traceAsync(sectionName: String, cookie: Int, crossinline block: suspend () -> R): R

Runs block inside an asynchronous platform trace section identified by cookie.

actual inline suspend fun <R> traceAsync(sectionName: String, cookie: Int, crossinline block: suspend () -> R): R

Runs block; Skiko does not currently emit an asynchronous platform trace section.