Skip to content
On this page
Common

ClientPostEffectPresetsApi

top.katton.apicommon/src/main/kotlin/top/katton/api/ClientPostEffectPresetsApi.kt
Register a configurable full-screen invert effect.

registerClientInvertPostEffect

registerClientInvertPostEffectCommonFunction
kotlin
fun registerClientInvertPostEffect(id: String = "katton:preset/invert", amount: Float = 1.0f, activate: Boolean = false): Boolean

Register a configurable full-screen invert effect.

Parameters

ParameterDescription
amount0.0 keeps the original image, 1.0 fully inverts it.

registerClientGrayscalePostEffect

registerClientGrayscalePostEffectCommonFunction
kotlin
fun registerClientGrayscalePostEffect(id: String = "katton:preset/grayscale", amount: Float = 1.0f, activate: Boolean = false): Boolean

Register a configurable grayscale effect.

Parameters

ParameterDescription
amount0.0 keeps color, 1.0 is fully grayscale.

registerClientSepiaPostEffect

registerClientSepiaPostEffectCommonFunction
kotlin
fun registerClientSepiaPostEffect(id: String = "katton:preset/sepia", amount: Float = 1.0f, activate: Boolean = false): Boolean

Register a configurable sepia effect.

Parameters

ParameterDescription
amount0.0 keeps the original image, 1.0 is fully sepia.

registerClientTintPostEffect

registerClientTintPostEffectCommonFunction
kotlin
fun registerClientTintPostEffect(id: String = "katton:preset/tint", color: Int = 0x55AAFF, amount: Float = 0.5f, activate: Boolean = false): Boolean

Register a tint effect that maps screen luminance toward [color].

Parameters

ParameterDescription
colorRGB or ARGB integer. Alpha is ignored.
amount0.0 keeps original color, 1.0 fully applies the tint.

registerClientColorAdjustPostEffect

registerClientColorAdjustPostEffectCommonFunction
kotlin
fun registerClientColorAdjustPostEffect(id: String = "katton:preset/color_adjust", brightness: Float = 0.0f, contrast: Float = 1.0f, saturation: Float = 1.0f, gamma: Float = 1.0f, activate: Boolean = false): Boolean

Register a basic color adjustment effect.

Parameters

ParameterDescription
brightness-1.0 darkens, 0.0 unchanged, 1.0 brightens.
contrast1.0 unchanged, lower flattens, higher increases contrast.
saturation1.0 unchanged, 0.0 grayscale, higher oversaturates.
gamma1.0 unchanged. Higher values lift shadows.

registerClientVignettePostEffect

registerClientVignettePostEffectCommonFunction
kotlin
fun registerClientVignettePostEffect(id: String = "katton:preset/vignette", amount: Float = 0.75f, radius: Float = 0.65f, softness: Float = 0.35f, color: Int = 0x000000, activate: Boolean = false): Boolean

Register a vignette effect.

Parameters

ParameterDescription
amountstrength of the edge color.
radiusdistance from screen center before the vignette starts.
softnesswidth of the falloff.
colorRGB or ARGB integer. Alpha is ignored.

registerClientChromaticAberrationPostEffect

registerClientChromaticAberrationPostEffectCommonFunction
kotlin
fun registerClientChromaticAberrationPostEffect(id: String = "katton:preset/chromatic_aberration", offsetPixels: Float = 1.5f, amount: Float = 1.0f, activate: Boolean = false): Boolean

Register a chromatic aberration effect.

Parameters

ParameterDescription
offsetPixelsred/blue channel offset in screen pixels.
amountblend amount between original and shifted color.

registerClientPixelatePostEffect

registerClientPixelatePostEffectCommonFunction
kotlin
fun registerClientPixelatePostEffect(id: String = "katton:preset/pixelate", pixelSize: Float = 4.0f, activate: Boolean = false): Boolean

Register a pixelation effect.

Parameters

ParameterDescription
pixelSizeblock size in screen pixels.

registerClientPosterizePostEffect

registerClientPosterizePostEffectCommonFunction
kotlin
fun registerClientPosterizePostEffect(id: String = "katton:preset/posterize", levels: Int = 5, amount: Float = 1.0f, activate: Boolean = false): Boolean

Register a posterize effect.

Parameters

ParameterDescription
levelsnumber of color steps per channel.
amount0.0 keeps original color, 1.0 fully posterizes.

registerClientScanlinePostEffect

registerClientScanlinePostEffectCommonFunction
kotlin
fun registerClientScanlinePostEffect(id: String = "katton:preset/scanline", amount: Float = 0.18f, lines: Float = 240.0f, activate: Boolean = false): Boolean

Register a static scanline effect.

Parameters

ParameterDescription
amountscanline darkness.
linesapproximate number of scanlines across the screen height.

registerClientBlurPostEffect

registerClientBlurPostEffectCommonFunction
kotlin
fun registerClientBlurPostEffect(id: String = "katton:preset/blur", radius: Float = 4.0f, passes: Int = 1, activate: Boolean = false): Boolean

Register a blur effect backed by Minecraft's built-in box blur shader.

Parameters

ParameterDescription
radiusblur radius in pixels.
passesnumber of horizontal/vertical blur rounds.