跳到主要内容

着色器(Shaders)

着色器允许你使用 WebGL 为任意节点应用自定义效果。

Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.

着色器可以通过 shaders 属性指定。最简单的情况下,该值应是一个字符串,其中包含片元着色器的 GLSL 代码:

import myShader from './myShader.glsl';

//...

view.add(
<Circle
size={200}
fill="lightseagreen"
shaders={myShader}
/>,
);

下面是一个简单着色器的示例,它会将节点的颜色反转:

myShader.glsl
#version 300 es
precision highp float;

#include "@motion-canvas/core/shaders/common.glsl"

void main() {
outColor = texture(sourceTexture, sourceUV);
outColor.rgb = 1.0 - outColor.rgb;
}

GLSL 预处理器​

Motion Canvas 自带一个简单的 GLSL 预处理器,让你可以通过 #include 指令包含文件:

#include "path-to-file"

路径的解析规则与 JavaScript 中的 import 语句相同。它可以指向一个相对路径的文件:

#include "../utils/math.glsl"

或者指向另一个包中的文件:

#include "@motion-canvas/core/shaders/common.glsl"

为方便起见,每个着色器中同一个 GLSL 文件只能被导入一次。之后对同一文件的每次导入都会被忽略,因此不需要使用 #ifdef 保护。

默认 uniform​

以下 uniform 在所有着色器中均可用:

in vec2 screenUV;
in vec2 sourceUV;
in vec2 destinationUV;

out vec4 outColor;

uniform float time;
uniform float deltaTime;
uniform float framerate;
uniform int frame;
uniform vec2 resolution;
uniform sampler2D sourceTexture;
uniform sampler2D destinationTexture;
uniform mat4 sourceMatrix;
uniform mat4 destinationMatrix;

可以使用以下指令将它们包含进来:

#include "@motion-canvas/core/shaders/common.glsl"

源(Source)与目标(Destination)​

Motion Canvas 中的着色器遵循与 2D canvas 中的 globalCompositeOperation 相同的理念。sourceTexture 包含正在被渲染的节点,而 destinationTexture 包含已经渲染到屏幕上的内容。这两者可以分别使用 sourceUV 和 destinationUV 进行采样,然后以各种方式组合,以产生所需的结果。

自定义 uniform​

你可以通过将着色器字符串替换为配置对象来向着色器传递自定义 uniform:

import myShader from './myShader.glsl';

//...

view.add(
<Circle
size={200}
fill="lightseagreen"
shaders={{
fragment: myShader,
uniforms: {
myFloat: 0.5,
myVec2: new Vector2(2, 5),
myColor: new Color('blue'),
},
}}
/>,
);

uniforms 属性是一个对象,其键是 uniform 的名称,值是传递给着色器的内容。

uniform 的类型由值推断得出:

TypeScriptGLSL
numberfloat
[number, number]vec2
[number, number, number]vec3
[number, number, number, number]vec4
Colorvec4
Vector2vec2
BBoxvec4
Spacingvec4

基于这一点,上例中的 uniform 将在着色器中以如下形式可用:

myShader.glsl
uniform float myFloat;
uniform vec2 myVec2;
uniform vec4 myColor;

还可以通过实现 WebGLConvertible 接口来创建可作为 uniform 传递的自定义类。

缓存​

当节点被缓存时,其内容会先渲染到一个独立的画布上,然后再转移到屏幕上(你可以在 滤镜与特效 一节中了解更多)当着色器应用于某个被缓存节点的后代时,destinationTexture 将只包含在该缓存节点上下文中绘制的内容,而不包含其他任何东西。这与合成操作的工作方式类似。

任何带有着色器的节点都会被自动缓存——这使我们能够在着色器运行之前确定 sourceTexture 的内容。缓存要求我们知晓该节点所渲染的一切内容的大小和位置。这超出了它的逻辑尺寸。诸如阴影、描边和滤镜之类的东西都会使渲染区域变大。对于内置效果,我们已经考虑到了这一点;但对于自定义着色器,你可能需要手动调整缓存大小。cachePadding 属性正是用于此目的。它指定了节点周围应包含在缓存中的额外空间。

视图缓存​

默认情况下,缓存的大小受限于可见区域。当节点部分位于屏幕之外时,这可能会导致某些着色器表现异常。要解决此问题,你可以增大视图本身的 cachePadding。它将充当可见区域周围的缓冲区。