RenderEffect

Known direct subclasses
BlurEffect

RenderEffect that will blur the contents of an optional input RenderEffect.

OffsetEffect

RenderEffect used to translate either the given RenderEffect or the content of the GraphicsLayerScope it is configured on.


Intermediate rendering step used to render drawing commands with a corresponding visual effect. A RenderEffect can be configured on a GraphicsLayerScope and will be applied when drawn.

Summary

Protected constructors

android
Cmn
android

Public functions

RenderEffect

Obtain a android.graphics.RenderEffect from the compose RenderEffect

android
ImageFilter
android
open Boolean

Capability query to determine if the particular platform supports the RenderEffect.

Cmn
android

Protected functions

abstract ImageFilter
android
abstract RenderEffect
android

Extension functions

ImageFilter

This function is deprecated. Use asSkiaImageFilter()

android

Protected constructors

RenderEffect

protected RenderEffect()

RenderEffect

protected RenderEffect()

Public functions

asAndroidRenderEffect

@RequiresApi(value = 31)
fun asAndroidRenderEffect(): RenderEffect

Obtain a android.graphics.RenderEffect from the compose RenderEffect

asSkiaImageFilter

fun asSkiaImageFilter(): ImageFilter

isSupported

open fun isSupported(): Boolean

Capability query to determine if the particular platform supports the RenderEffect. Not all platforms support all render effects.

Note RenderEffect is only supported on Android 12 and above. Attempts to use RenderEffect on older Android versions will be ignored.

Protected functions

createImageFilter

protected abstract fun createImageFilter(): ImageFilter

createRenderEffect

@RequiresApi(value = 31)
protected abstract fun createRenderEffect(): RenderEffect

Extension functions

asDesktopImageFilter

fun RenderEffect.asDesktopImageFilter(): ImageFilter