melonjs-effects-and-shaders
Use this skill for post-processing effects, custom shaders, blend modes and colour grading in melonJS. Covers the built-in ShaderEffect presets, addPostEffect on renderables and cameras, writing a custom dual-language GLSL/WGSL effect, the screen_texture builtins, and why effects silently do nothing on the Canvas fallback. Triggers on: Tween, easing, animate an effect, ShaderEffect, addPostEffect, removePostEffect, getPostEffect, postEffectNeedsCapture, VignetteEffect, GlowEffect, BlurEffect, PixelateEffect, ScanlineEffect, shader, GLSL, WGSL, uniform, setUniform, setTexture, setTime, blendMode, colorMatrix, screen_texture, toFrameTexture, post effect, filter.
melonjs · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add melonjs/melonJS --skill melonjs-effects-and-shaders技能说明
name: melonjs-effects-and-shaders description: "Use this skill for post-processing effects, custom shaders, blend modes and colour grading in melonJS. Covers the built-in ShaderEffect presets, addPostEffect on renderables and cameras, writing a custom dual-language GLSL/WGSL effect, the screen_texture builtins, and why effects silently do nothing on the Canvas fallback. Triggers on: Tween, easing, animate an effect, ShaderEffect, addPostEffect, removePostEffect, getPostEffect, postEffectNeedsCapture, VignetteEffect, GlowEffect, BlurEffect, PixelateEffect, ScanlineEffect, shader, GLSL, WGSL, uniform, setUniform, setTexture, setTime, blendMode, colorMatrix, screen_texture, toFrameTexture, post effect, filter." license: MIT
Post effects and custom shaders
melonJS ships a catalogue of post effects and a dual-language shader system. The recurring trap is that every shader path needs a GPU backend and degrades to nothing on Canvas rather than erroring. Blend modes are the exception — those work on all three renderers.
Applying an effect
Effects attach to a renderable or to a camera (for full-screen grading):
import { VignetteEffect, GlowEffect } from "melonjs";
sprite.addPostEffect(new GlowEffect(app.renderer));
app.viewport.addPostEffect(new VignetteEffect(app.renderer));
renderable.shader = … is deprecated since 19.2.0, and its setter destroys
whatever it replaces. Use addPostEffect / getPostEffect / removePostEffect.
A camera effect covers the HUD too
A camera's post-effect brackets the entire world draw — floating children included. So the obvious way to write a full-screen pass also washes over every HUD label in that world, which is rarely what you want.
To land a pass after the world but before the HUD, host the effect on a screen-filling floating renderable ordered below the HUD's z instead:
const quad = new Sprite(0, 0, { image: anyImage });
quad.anchorPoint.set(0, 0);
quad.scale(viewW / anyImage.width, viewH / anyImage.height);
quad.floating = true; // its own uv is now screen space
quad.blendMode = "additive";
quad.addPostEffect(myEffect);
world.addChild(quad, HUD_Z - 10); // 2D: below the labels. See the note.
Two things follow from the quad filling the frame: its own uv is screen space
(so a pass like this needs none of the screen_uv / screen_texture builtins),
and the incoming color is the quad's own texture, which a body that paints
from scratch can ignore entirely.
Depth here is easy to get backwards, and the rule FLIPS between the two sort
modes. Under the default sortOn = "z" a higher z draws later, i.e. on top,
so HUD_Z - 10 puts the pass under the labels as written above. Under
sortOn = "depth", which every Camera3d scene sets, a floating child's sort
key is pos.z * pos.z and the walk paints far to near, so the SMALLER
magnitude is nearer and draws on top — HUD_Z - 10 there puts the pass OVER
the labels, the opposite of the comment.
So in a 3D scene give the overlay a larger magnitude than the HUD, and give
the HUD a small one (melonjs-3d and melonjs-ui-and-text both say a HUD
wants a small depth, not the huge z that would put it on top in 2D).
Either way, verify it rather than reasoning about it: return a flat colour from the body for one frame and see what it tints.
A renderable that draws with PRIMITIVES has to ask to be captured
One effect is applied the cheap way: the renderable is drawn with the effect's
own program instead of being captured offscreen and post-processed, which costs
no render target. That is equivalent only when everything the renderable draws
is a textured quad. fillRect, strokeRect and renderer.fill(shape) go
through a batcher that never reads that shader, so one effect on such a
renderable would silently do nothing, while two would work, because a chain
always captures.
So a renderable of your own that draws with primitives says so:
class Bar extends Renderable {
constructor(x, y, w, h) {
super(x, y, w, h);
this.postEffectNeedsCapture = true; // ← or one effect is a no-op
}
draw(renderer) {
renderer.fillRect(this.pos.x, this.pos.y, this.width, this.height);
}
}
ProgressBar and Trail set it for you, and a sprite needs nothing: the flag
defaults to false and only ever changes the single-effect case.
Toggle with enabled, do not remove
removePostEffect() destroys the effect — it calls effect.destroy() and
frees GPU resources, so the instance cannot be re-added. Same for
clearPostEffects() and for reassigning the deprecated .shader.
// ✗ destroys it; re-adding later fails or forces a recompile
sprite.removePostEffect(effect);
// ✓
effect.enabled = false;
An effect with effect.shared === true opts out of auto-destroy because it is
reused across renderables.
Built-in effects
Twenty-three presets, every one constructed as new XEffect(renderer, options)
and every one shipping both a GLSL and a WGSL body, so they all run on either
GPU backend: VignetteEffect, ScanlineEffect (optional CRT curvature),
BloomEffect, GlowEffect, BlurEffect, PixelateEffect,
ChromaticAberrationEffect, DropShadowEffect, FlashEffect,
OutlineEffect, ColorMatrixEffect, DesaturateEffect, DissolveEffect,
TintPulseEffect, WaveEffect, SwayEffect, InvertEffect, SepiaEffect,
HologramEffect, ShineEffect, RadialGradientEffect, SquishEffect,
ToneMappingEffect.
Colors take an alpha. Every color option and setColor takes [r, g, b]
or [r, g, b, a], each 0.0 to 1.0, and the alpha is the color's own opacity: a
half-transparent outline, a glow at half strength, a flash that only half
covers. [r, g, b] is opaque, as it always was. Any other length throws.
RadialGradientEffect takes a Color instead, and its alpha scales the spot.
sprite.addPostEffect(new OutlineEffect(app.renderer,
阅读完整来源 ↗