Supported Filters and Effects

import android.net.Uri
import ly.img.engine.Color
import ly.img.engine.DesignBlockType
import ly.img.engine.EffectType
import ly.img.engine.Engine
import ly.img.engine.FillType
import ly.img.engine.MimeType
import ly.img.engine.ShapeType
import java.nio.ByteBuffer

data class SupportedFiltersAndEffects(
    val sceneSupportsEffects: Boolean,
    val imageBlockSupportsEffects: Boolean,
    val appliedEffectCount: Int,
    val effectType: String,
    val intensity: Float,
    val darkColor: Color,
    val lightColor: Color,
    val previewPng: ByteBuffer,
)

suspend fun supportedFiltersAndEffects(engine: Engine): SupportedFiltersAndEffects {
    val scene = engine.scene.create()

    val page = engine.block.create(DesignBlockType.Page)
    engine.block.setWidth(page, value = 800F)
    engine.block.setHeight(page, value = 600F)
    engine.block.appendChild(parent = scene, child = page)

    val imageBlock = engine.block.create(DesignBlockType.Graphic)
    engine.block.setShape(imageBlock, shape = engine.block.createShape(ShapeType.Rect))
    engine.block.setPositionX(imageBlock, value = 100F)
    engine.block.setPositionY(imageBlock, value = 75F)
    engine.block.setWidth(imageBlock, value = 600F)
    engine.block.setHeight(imageBlock, value = 450F)
    engine.block.appendChild(parent = page, child = imageBlock)

    val imageFill = engine.block.createFill(FillType.Image)
    engine.block.setUri(
        block = imageFill,
        property = "fill/image/imageFileURI",
        value = Uri.parse("https://img.ly/static/ubq_samples/sample_1.jpg"),
    )
    engine.block.setFill(block = imageBlock, fill = imageFill)

    val sceneSupportsEffects = engine.block.supportsEffects(scene)
    val imageBlockSupportsEffects = engine.block.supportsEffects(imageBlock)

    require(!sceneSupportsEffects) { "Scenes do not support effect stacks." }
    require(imageBlockSupportsEffects) { "Image-backed graphic blocks can render effects." }

    val duotoneEffect = engine.block.createEffect(type = EffectType.DuoToneFilter)
    engine.block.appendEffect(block = imageBlock, effectBlock = duotoneEffect)

    val darkColor = Color.fromRGBA(r = 0.02F, g = 0.04F, b = 0.12F, a = 1F)
    val lightColor = Color.fromRGBA(r = 0.5F, g = 0.7F, b = 1F, a = 1F)

    engine.block.setColor(
        block = duotoneEffect,
        property = "effect/duotone_filter/darkColor",
        value = darkColor,
    )
    engine.block.setColor(
        block = duotoneEffect,
        property = "effect/duotone_filter/lightColor",
        value = lightColor,
    )
    engine.block.setFloat(
        block = duotoneEffect,
        property = "effect/duotone_filter/intensity",
        value = 0.8F,
    )

    val appliedEffects = engine.block.getEffects(imageBlock)
    require(appliedEffects == listOf(duotoneEffect)) {
        "Expected one duotone effect on the image block."
    }

    val previewPng = engine.block.export(block = page, mimeType = MimeType.PNG)
    check(previewPng.hasRemaining()) { "The supported filters and effects preview export is empty." }

    return SupportedFiltersAndEffects(
        sceneSupportsEffects = sceneSupportsEffects,
        imageBlockSupportsEffects = imageBlockSupportsEffects,
        appliedEffectCount = appliedEffects.size,
        effectType = engine.block.getType(duotoneEffect),
        intensity = engine.block.getFloat(duotoneEffect, property = "effect/duotone_filter/intensity"),
        darkColor = engine.block.getColor(duotoneEffect, property = "effect/duotone_filter/darkColor"),
        lightColor = engine.block.getColor(duotoneEffect, property = "effect/duotone_filter/lightColor"),
        previewPng = previewPng.asReadOnlyBuffer(),
    )
}

Effects are separate blocks in an ordered effect stack. You create an effect block, append it to a supported design block, then configure that effect through its property keys.

Use this page as a reference for available Android effect types and properties. For a focused walkthrough on adding and managing effects in a scene, see the Apply a Filter or Effect guide.

Check Effect Support#

Before applying effects to a block, verify whether it supports them using supportsEffects(). Not all block types can have effects applied. The snippet below checks a scene and an image-backed graphic block.

val sceneSupportsEffects = engine.block.supportsEffects(scene)
val imageBlockSupportsEffects = engine.block.supportsEffects(imageBlock)

require(!sceneSupportsEffects) { "Scenes do not support effect stacks." }
require(imageBlockSupportsEffects) { "Image-backed graphic blocks can render effects." }

Effect support is available for:

• Graphic blocks - including image fills, video fills, shapes, and solid colors
• Page blocks - effects apply to the page fill or background, not its child blocks

Other block types, such as scenes and groups, return false.

Add an Effect#

Create an effect with createEffect() using an EffectType value, then attach it to a block’s effect stack with appendEffect().

val duotoneEffect = engine.block.createEffect(type = EffectType.DuoToneFilter)
engine.block.appendEffect(block = imageBlock, effectBlock = duotoneEffect)

Configure Effect Properties#

Configure effect parameters using typed setter methods. Property paths follow the format effect/{effect-type}/{property-name}.

val darkColor = Color.fromRGBA(r = 0.02F, g = 0.04F, b = 0.12F, a = 1F)
val lightColor = Color.fromRGBA(r = 0.5F, g = 0.7F, b = 1F, a = 1F)

engine.block.setColor(
    block = duotoneEffect,
    property = "effect/duotone_filter/darkColor",
    value = darkColor,
)
engine.block.setColor(
    block = duotoneEffect,
    property = "effect/duotone_filter/lightColor",
    value = lightColor,
)
engine.block.setFloat(
    block = duotoneEffect,
    property = "effect/duotone_filter/intensity",
    value = 0.8F,
)

CE.SDK provides setter methods for different parameter types:

• setFloat() - For intensity, amount, and decimal values
• setInt() - For discrete values like pixel sizes
• setUri() - For file URIs, such as LUT files
• setString() - For string values, such as LUT filter IDs
• setColor() - For color values

The property tables list effect/enabled for completeness. Use setEffectEnabled() and isEffectEnabled() to disable, enable, and query an effect block.

Retrieve Applied Effects#

Use getEffects() to retrieve all effects applied to a block, in the order they are applied.

val appliedEffects = engine.block.getEffects(imageBlock)
require(appliedEffects == listOf(duotoneEffect)) {
    "Expected one duotone effect on the image block."
}

Effects#

The following tables document all available effect types and their configurable properties.

Adjustments Type#

An effect block for basic image adjustments.

This section describes the properties available for the Adjustments Type (//ly.img.ubq/effect/adjustments) block type.

Cross Cut Type#

An effect that distorts the image with horizontal slices.

This section describes the properties available for the Cross Cut Type (//ly.img.ubq/effect/cross_cut) block type.

Dot Pattern Type#

An effect that displays the image using a dot matrix.

This section describes the properties available for the Dot Pattern Type (//ly.img.ubq/effect/dot_pattern) block type.

Duotone Filter Type#

An effect that applies a two-tone color mapping.

This section describes the properties available for the Duotone Filter Type (//ly.img.ubq/effect/duotone_filter) block type.

Extrude Blur Type#

An effect that applies a radial extrude blur.

This section describes the properties available for the Extrude Blur Type (//ly.img.ubq/effect/extrude_blur) block type.

Glow Type#

An effect that applies an artificial glow.

This section describes the properties available for the Glow Type (//ly.img.ubq/effect/glow) block type.

Green Screen Type#

An effect that replaces a specific color with transparency.

This section describes the properties available for the Green Screen Type (//ly.img.ubq/effect/green_screen) block type.

Half Tone Type#

An effect that overlays a halftone pattern.

This section describes the properties available for the Half Tone Type (//ly.img.ubq/effect/half_tone) block type.

Linocut Type#

An effect that overlays a linocut pattern.

This section describes the properties available for the Linocut Type (//ly.img.ubq/effect/linocut) block type.

Liquid Type#

An effect that applies a liquefy distortion.

This section describes the properties available for the Liquid Type (//ly.img.ubq/effect/liquid) block type.

Lut Filter Type#

An effect that applies a color lookup table (LUT).

This section describes the properties available for the Lut Filter Type (//ly.img.ubq/effect/lut_filter) block type.

Mirror Type#

An effect that mirrors the image along a central axis.

This section describes the properties available for the Mirror Type (//ly.img.ubq/effect/mirror) block type.

Outliner Type#

An effect that highlights the outlines in an image.

This section describes the properties available for the Outliner Type (//ly.img.ubq/effect/outliner) block type.

Pixelize Type#

An effect that pixelizes the image.

This section describes the properties available for the Pixelize Type (//ly.img.ubq/effect/pixelize) block type.

Posterize Type#

An effect that reduces the number of colors in the image.

This section describes the properties available for the Posterize Type (//ly.img.ubq/effect/posterize) block type.

Radial Pixel Type#

An effect that reduces the image into radial pixel rows.

This section describes the properties available for the Radial Pixel Type (//ly.img.ubq/effect/radial_pixel) block type.

Recolor Type#

An effect that replaces one color with another.

This section describes the properties available for the Recolor Type (//ly.img.ubq/effect/recolor) block type.

Sharpie Type#

Cartoon-like effect.

This section describes the properties available for the Sharpie Type (//ly.img.ubq/effect/sharpie) block type.

Shifter Type#

An effect that shifts individual color channels.

This section describes the properties available for the Shifter Type (//ly.img.ubq/effect/shifter) block type.

Tilt Shift Type#

An effect that applies a tilt-shift blur.

This section describes the properties available for the Tilt Shift Type (//ly.img.ubq/effect/tilt_shift) block type.

Tv Glitch Type#

An effect that mimics TV banding and distortion.

This section describes the properties available for the Tv Glitch Type (//ly.img.ubq/effect/tv_glitch) block type.

Vignette Type#

An effect that adds a vignette (darkened corners).

This section describes the properties available for the Vignette Type (//ly.img.ubq/effect/vignette) block type.

API Reference#

Next Steps#

• Apply a Filter or Effect - Apply, configure, stack, and manage filters and effects