Skip to content
On this page
通用

ClientPostEffectPresetsApi

top.katton.apicommon/src/main/kotlin/top/katton/api/ClientPostEffectPresetsApi.kt
注册一个可配置的全屏反色效果。

registerClientInvertPostEffect

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

注册一个可配置的全屏反色效果。

参数

参数说明
amount0.0 保持原图,1.0 完全反色。

registerClientGrayscalePostEffect

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

注册一个可配置的灰度效果。

参数

参数说明
amount0.0 保留颜色,1.0 完全转为灰度。

registerClientSepiaPostEffect

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

注册一个可配置的棕褐色效果。

参数

参数说明
amount0.0 保持原图,1.0 完全应用棕褐色调。

registerClientTintPostEffect

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

注册一个将屏幕亮度映射到 [color] 的染色效果。

参数

参数说明
colorRGB 或 ARGB 整数;Alpha 通道会被忽略。
amount0.0 保留原色,1.0 完全应用染色。

registerClientColorAdjustPostEffect

registerClientColorAdjustPostEffect通用函数
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

注册一个基础颜色调整效果。

参数

参数说明
brightness-1.0 变暗,0.0 不变,1.0 变亮。
contrast1.0 不变,较低值降低对比度,较高值增强对比度。
saturation1.0 不变,0.0 转为灰度,较高值提高饱和度。
gamma1.0 不变,较高值会提亮暗部。

registerClientVignettePostEffect

registerClientVignettePostEffect通用函数
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

注册一个暗角效果。

参数

参数说明
amount边缘颜色强度。
radius从屏幕中心到暗角开始位置的距离。
softness衰减宽度。
colorRGB 或 ARGB 整数;Alpha 通道会被忽略。

registerClientChromaticAberrationPostEffect

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

注册一个色差效果。

参数

参数说明
offsetPixels红色和蓝色通道的屏幕像素偏移量。
amount原始颜色与偏移颜色之间的混合比例。

registerClientPixelatePostEffect

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

注册一个像素化效果。

参数

参数说明
pixelSize像素块的屏幕像素大小。

registerClientPosterizePostEffect

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

注册一个色阶压缩效果。

参数

参数说明
levels每个颜色通道的色阶数量。
amount0.0 保留原色,1.0 完全应用色阶压缩。

registerClientScanlinePostEffect

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

注册一个静态扫描线效果。

参数

参数说明
amount扫描线暗度。
lines屏幕高度方向上的近似扫描线数量。

registerClientBlurPostEffect

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

注册一个基于 Minecraft 内置 box blur shader 的模糊效果。

参数

参数说明
radius模糊半径,单位为像素。
passes水平和垂直模糊轮数。