Cocos Creator Shader Effect 系列 - 3 - Effect 文件调试

Effect 文件的调试,根据目前我自己的接触,并没有我们平常开发那样子,可以打印日志之类的操作。基本上是通过以下方式去进行 辅助调试

一、关注 Inspector 的编译结果

在上篇文章 Cocos Creator Shader Effect 系列 - 2 - Effect 文件解读 中,我们大致对 Cocos Creator 的 Effect 文件进行了解读,但是如果大家是从 OpenGL 学过来,就会发现有些地方可能和我们之前接触过的 OpenGL 会有些区别

比如:

Q1:顶点 Shader 中 cc_matViewProjcc_matWorld 具体是什么意思?

cc_matViewProj vs cc_matWorld

Q2:片段 Shader 中为什么一个是 texture 函数,一个是 texture2D 函数?区别是什么?

texture vs texture2D

实际上,对应的答案可以在 Inspector 的编译结果中可以查看:

  1. 选中我们的 buildin-2d-sprite.effect 文件
  2. 查看 Inspector 并滚动到底部,你就可以发现有编译后的 顶点着色器程序片段着色器程序
Compiled

展开后,你就可以发现我们常见的 顶点着色器程序片段着色器程序 了。

1.1 编译后的顶点着色器

Compiled vs

现在我们只需要在 Cocos 的引擎仓库中全局搜索 cc_matViewProj 等字眼,就知道 cc_matViewProj 的意思了,可以回答我们刚刚提出来的 Q1 了

cc_matViewProj

这里我们不在细究下去,有兴趣大家可以在继续看下去。

1.2 编译后的片段着色器

现在我们在看看 编译后的片段着色器:

Compiled fs

Q2的答案就出来了, texture() 函数在编译后其实就是 texture2D() 函数

本节主要是对上一片文章的补充,以及这也是我们调试的方法之一,这里可能会能更加直观地看到你熟悉的代码。

二、语法错误提示

从 Inspector 中查看 Effect 编译后的结果,更多的是一种结果验证,但实际上我们编写的时候,更加偏向于过程,比如,这行代码语法出错了等。

在 Cocos Creator 中,在我们编写好 Effect 后,回到编辑器,编辑器会触发一次对 Effect 文件的语法检查和预编译。特别地,如果我们的代码是错的,那么就会报错。

比如,漏写;

syntax error

但是不要紧,编辑器的控制台会告诉我们是什么错误,以及在第几行出错。给点耐心,总会找到问题原因并解决!

三、注释调试

好了,现在语法问题可以检查出来,问题不大。那么在开发特效上,我怎么调试这个特效?这个特效是我想要的特效吗?

在平常我们的开发中,我们可以断点以及打印日志等多种手段去进行调试代码,但是在 OpenGL 上,这些几乎都不是调试手段。

「注释调试」大概是主流的 Effect 调试方式,通过

  1. 注释/反注释某些行
  2. 注释/反注释某些函数

等注释手段, 观察注释/反注释后的 Shader 程序渲染出来的结果是否为自己期望 ,以此手段来进行 调试

在Cocos Creator 中,我们可以

  1. 打开 Effect 文件进行编写
  2. 将有疑问/待验证的代码进行注释/反注释释等操作
  3. 回到编辑器时,Cocos Creator 会立即执行并渲染,然后我们就可以看到 调试 结果了
Comments

四、宏开关调试

在上面的注释调试中,我们基本上是每次修改代码,都需要回到编辑器中刷新预览。其实,我们也可以巧用 宏定义 ,将一些需要经常注释反注释的代码放到宏里面,然后直接在编辑器中,通过开关去控制是否执行这些代码

macro

特别地,在某些特效中,特效是一步一步搭建起来的。这个时候,通过宏定义去进行开关控制执行哪些步骤,会极大方便我们调试。

PS:尽管可以通过宏开关调试,但是我们也不能泛滥使用宏定义,在Cocos 的 预处理宏定义 章节中,有说明到这个限制,请注意!

四、Uniform 参数调试

特效一般会由不同的属性控制其效果,比如发光,会有发光强度,发光颜色等等属性。每个属性的不同值组合,可能会产生出不同的效果。

那么,针对这种情况,我们要怎么调试出比较好的效果呢?

这个时候,我们可以将这些属性定义为 Uniform 属性并且将它暴露到Inspector中,给Cocos Creator 的 Inspector 去进行设置,每当我们修改材质这些属性并应用,我们就可以在 Cocos Creator 编辑器上 调试 了。

以内发光特效为例:

Inspecator debug

但是,在操作过几次之后,你可能会发现,通过 Inspector 去控制 Uniform 参数值改变,以此带来不同渲染效果,效率上可能会不怎么好, 每次改一个值都要手动应用一次

这个时候,我们可以通过简单的代码,写个测试场景,将这些 Uniform 属性值在代码中设置好,那么我们就能很直观的进行 效果调试

2d-sprite-glow-inner.gif

在上面这个动图,你可以发现,在发光阈值为 0.59 的时候,调整发光宽度属性,会发现一种看上去好像还可以的扩散效果。这种带有一点小惊喜的效果,如果我们不采用这种 测试场景/测试代码 去实时控制参数变化,是很难调试出来的。

六、本篇章总结

现在我们来总结一下,本篇章,我们大概列了几种调试方法:

  1. 编译后的 Shader 程序查阅
  2. 语法错误检查
  3. 注释/反注释代码调试特效效果
  4. 宏开关调试特效效果
  5. Uniform 参数在 Inspecator 中调试 以及 代码调试 特效效果

以上方法,都是我在实践过程中,经常用到的一些方法,如果你有更好的方法,可以一起交流交流~

OK,我们本章节基本就到这里了,可能你还会带着一些疑问。

比如,上面的内发光是怎么实现的?有代码吗?有原理说明吗?有,都在我的 Github 仓库 或者 Gitee 仓库 中可以找到,原理说明文章会晚一点更新。

七、阶段性总结

如果你是从这个系列初一直看下来,那么相信你现在已经对 Cocos Creator 中的 Effect 有一定了解和认识了。恭喜你!你已经过了新手村这个阶段。

而如果还没看过,那么我建议在看一下:

上面的这些基础可能会有一些遗漏之处,如果后面我们遇到了,我们会接着说。

但是,现在有了上面这些基础,相信你已经迫不及待想写点什么特效了,马上,我们就会进行一些特效开发。

下一篇:

上一篇: