对于引擎开发者¶

例子¶

下划线符号在函数和变量名称中使用：

var foo_bar = 123;  // correct
var fooBar = 123;   // wrong

所有的全局变量以下划线开头：

var _foo_bar = null;

这些常量用大写字母表示，从不以下划线开头：

var FOO_BAR = 100;

外部API方法和属性的名称均在点之后写的。为了避免混淆他们必须用 @ cc_externs 标签字段：

exports.FOO_BAR = 123;

exports.foo_bar = function() {

}

/**
 * Set properties.
 * @method module:properties.set_props
 * @param {Object} foo Foo object
 * @cc_externs props_1 props_2
 * @cc_externs props_3 props_4
 */
exports.set_props = function(foo) {

    var bar_1 = foo.props_1;
    var bar_2 = foo.props_2;
    var bar_3 = foo.props_3;
    var bar_4 = foo.props_4;

    ...
}

注释仅用英语。注释风格 - JSDoc。

验证¶

编译器执行与着色器代码验证以下程序：

• 报告有关未使用的变量和函数（死码）

• 检查着色器的语法，

• 检查着色器的一致性导入/导出机制，

• 去除奇数或重复的标记：空格，endlines和分号。

混淆¶

混淆minifies的GLSL代码，使得它很难理解它。到目前为止以下过程实现：

• 具有较短的单符号（与支持导入/导出机制的）替换用户定义的标识符，两符号等的名称。

优化¶

优化构成以下程序：

• 除去大括号，不能在除了创建本地作用域任何方式有用（这一功能是用于处理节点/灯指示），

• 内部功能的优化 - 创建共享局部变量，以取代原来由程序员创建的。

删除未使用大括号的一个例子：替换下面的代码

void function(){
    int a;
    {
        a = 1;
    }
}

与这些代码

void function(){
    int a;
    a = 1;
}

临时局部变量的低数量是由在不同情况下重复使用它们来实现的。例如，下面的代码

int function(){
    int a = 1;
    int b = a + 3;
    return b;
}

Blender内置渲染引擎的纹理绘图类型已被其它三个模块所取代：

int function(){
    int _int_tmp0 = 1;
    _int_tmp0 = _int_tmp0 + 3;
    return _int_tmp0;
}

导入/导出指令¶

导入/导出指令用于组织，结构和增加着色器代码的可读性中包含文件。它们在文件的开头指定，应该看起来大约是这样的：

#import u_frame_factor u_quatsb u_quatsa u_transb u_transa a_influence
#import qrot

#export skin

在 ＃import 指令定义了一组声明的包含文件之外，但可以从里面被访问的ID。这里有一个限制，但：这样的id必然是上述地方，其中包括文件链接的地方声明。

在 ＃export 指令定义了一组可以从该文件外部访问的ID。这样的id必然在这个文件中声明。

因此，它使用的着色器包含文件必须拥有所有必要的连接位置之前，进口的声明，以后它可以使用导出的标识。

IDS既可以是变量名和函数名。如果没有导入/导出命令中，它在默认情况下认为，包括文件不使用外部声明和内部的人的使用不允许。

建议和限制¶

由于以下几个原因：预处理，处理多个着色器和包括文件和由于编译器的功能的需要 - 其可能保证只有当一些规则和限制方面的着色源推崇的输出代码的工作码：

1. 为了描述这是由引擎在运行中定义的常量，有必要使用``＃var``特殊指令。例如：

#var AU_QUALIFIER uniform
AU_QUALIFIER float a;

这里的语法是类似的#define指令。所述#var指令的一点是，它定义了值允许解析初始着色。它是不相关的这将是什么（在上面的例子如“制服”或“属性”），因为在这个水平上它是未知反正。不过，最好是指定一个或多或少适当的描述，不是随心所欲。

2. 在需要的时候使用导入/导出指令。

3. 内置的功能，不能超载 - 只有用户的。

4. 变量不应与的内置函数名称，或者主要（即使它不导致错误）中声明。

5. 的#var和#define指令不能被用于以这样运营商更换单个符号：“ ”，“ - ”，“* =”，“/ =”，“ =”，“ - =” ，“==”，“<=”，“> =”，“！=”，“&&”，“||”，“^^”。

例如：

#var EQUAL =
...
a *EQUAL b;
...

6. #include指令的使用不应该包含文件的混淆中产生歧义。当多个着色器纳入相同的文件，上面定义的指令（如#var或者将#define）可以对任何人的影响，可能发生这种情况。此外，最好不要使用未声明的函数和变量中包含文件。

7. 多级包括或相同的多个纳入到包括不支持相同的着色器。

8. 着色器的故障也可以通过使用非平凡的预处理，例如，创建一个无效的GLSL代码引起的：

#if TYPE
void function1() {
#else
void function1(int i) {
#endif
    ...
}

9. 不要声明与这样的名字变量 node_ [NODE_NAME] _var_ [IN_OUT_NODE]，其中 NODE_NAME —一些节点的名称，IN_OUT_NODE —输入或输出的名称节点。

10. 重复使用 ＃nodes_main，＃nodes_global 或 ＃lamps_main 指令是不是一个单一的着色器内禁止。

11. 在 ＃nodes_main，＃nodes_global 和 ＃lamps_main 指令，建议在该文件中使用，包含这些着色器节点的说明，例如，在同一个包含文件。这是必要的正确的着色器验证。

WebGL的扩展¶

如果他们以某种方式影响着色语言所使用的编译可能取决于WebGL的扩展。目前以下扩展名由编译器的支持：

• OES_standard_derivatives

编译错误¶

在发生错误时，编译器会在控制台输出相应的消息。

可能发生的错误的表：