GLSL

OpenGL

GLSL是OpenGL Shader的编程语言，为了更好的进行视频编辑和特效开发，抽空学习了其语法和特性，并做此记录，留作备忘查询。

类型

类型概述

向量构造器有两种参数构造方式：
1. 单标量参数：向量中的所有分量都会初始化为该标量值。
2. 多标量参数、向量参数、或者标量和向量混合参数：按照参数顺序初始化向量的所有分量，需要保证参数个数（向量参数的分量拆分开）不少于向量分量个数。

vec4 aVec4 = vec4(1.0, 1.0, 1.0, 1.0);
// 全部分量都为1.0
vec4 bVec4 = vec4(1.0);
vec3 aVec3 = vec3(1.0);
// 通过向量和标量初始化4维向量
vec4 cVec4 = vec4(aVec3, 1.0);

类型转换：GLSL不支持隐式类型转换，必须进行显示类型转换，向量也支持直接类型转换。即只有类型一致时，变量才能完成赋值或其它操作。

float floatParam = 1.0;
// float -> bool
bool boolParam = bool(floatParam);
vec4 fVec4 = vec4(1.0, 1.0, 1.0, 1.0);
// 4维float向量 -> 4维int向量
ivec4 iVec4 = ivec4(fVec4);
// 4维float向量 -> 3维int向量
ivec3 iVec3 = ivec3(fVec4);

矩阵构造器也有两种参数构造方式：
1. 单标量参数：用于主对角线上分量的初始化，其他分量皆为0.0。
2. 多标量参数、向量参数、或者标量和向量混合参数：按照参数顺序初始化矩阵的所有分量（列优先），需要保证参数个数（向量参数的分量拆分开）不少于矩阵分量个数。

// 通过多个标量为矩阵的各个分量赋值
mat3 aMat3 = mat3(1.0, 0.0, 0.0,  // 第一列
                  0.0, 1.0, 0.0,  // 第二列
                  0.0, 0.0, 1.0); // 第三列
// 单个标量用于主对角线上分量的初始化，其他分量皆为0.0                  
mat3 bMat3 = mat3(1.0);
vec3 aVec3 = vec3(1.0,0.0,0.0);
vec3 bVec3 = vec3(0.0,1.0,0.0);
mat3 cMat3 = mat3(aVec3,  // 通过向量初始化第一列
                  bVec3,  // 通过向量初始化第二列
                  0.0, 0.0, 1.0); // 通过多个标量初始化第三列

向量和矩阵操作

向量和矩阵都是由分量构成的，我们可以通过多种方式访问分量。
针对向量，可以通过.和数组下标访问，也可以通过xyzw、rgba或者strq来访问，其中，xyzw通常用于位置相关向量，rgba通常用于颜色相关向量，strq通常用于纹理坐标相关向量。x、r、s分别表示向量的第一个分量。上述三种方式不能混用，比如：xgr是不允许的。

针对矩阵，可以认为是向量的组合，一个mat3可以当做三个vec3，所以可以通过数组下标获取某一列的向量，然后再通过上述方法访问向量分量。

// 向量访问
vec3 aVec3 = vec3(0.0, 1.0, 2.0); 
vec3 temp;
temp = aVec3.xyz; // temp = {0.0, 1.0, 2.0}
temp = aVec3.xxx; // temp = {0.0, 0.0, 0.0}
temp = aVec3.zyx; // temp = {2.0, 1.0, 0.0}
// 矩阵访问
mat4 aMat4 = mat4(1.0); 
vec4 column0 = aMat4[0];            // column0 = {1.0, 0.0, 0.0,0.0}
float column1_row1 = aMat4[1][1];   // column1_row1 = 1.0
float column2_row2 = myMat4[2].z;   // column2_row2 = 1.0

结构体

与C语言类似，glsl支持定义结构体，同时会自动为结构体创建构造器（与结构体同名），用于生成结构体实例。

// Leon是新的结构体类型，leon是结构体变量，是可选的。
struct Leon {
    vec4 aVec4; 
    mat4 bMat4;
    float cF;
} leon;
// 通过结构体构造器初始化结构体参数，构造器的参数和结构体的元素必须有精确的对应关系    
leon = Leon(vec4(1.0),mat4(1.0),1.0); 
// 通过.操作符访问成员变量
vec4 dVec4 = leon.aVec4;
mat4 eMat4 = leon.bMat4;

数组

与C语言类似，glsl支持定义数组，数组类型可以是任意基本类型和结构体类型。glsl有两点特殊之处：

1. 除了uniform变量之外，数组的索引必须是编译期常量。
2. 数组的定义和初始化是分开的，即数组中的元素必须在数组定义之后逐个初始化，且数组不能使用const限定符。

// 定义数组
float fArray[2];
vec2 vec2Array[2];
mat2 mat2Array[2];
Leon leonArray[2];
// 数组元素必须逐一被初始化    
fArray[0] = 0.0;
fArray[1] = 1.0;
vec2Array[0] = vec2(0.0);
vec2Array[1] = vec2(1.0);
mat2Array[0] = mat2(0.0);
mat2Array[1] = mat2(1.0);
leonArray[0] = Leon(vec4(1.0),mat4(1.0),1.0);
leonArray[1] = Leon(vec4(1.0),mat4(1.0),1.0);

语句

流程控制语句

流程控制语句与C语言非常相似。

循环语句

GLSL支持通过continue跳过单次循环，break退出整个循环。

// 通过计数器控制的循环
for(int i = 0; i <= 99; i++) {
    function(); 
}
// 通过前置（循环）条件控制的循环
int i = 0;
while(i <= 99) { 
    function();
    i++;
}
// 通过后置（循环）条件控制的循环
do { 
    function();  
    i++;
} while(i <= 99);

条件语句

与C语言类似

if(condition){
    functionA();
} else {
    functionB();
}

discard语句

discard关键字一般用于片元着色器中，用于丢弃当前片元，即：立即退出当前片元的着色程序，当前片元最终是默认色。

Start语句

// main函数是顶点和片元着色器入口，相当于C语言的主函数
void main(void) {
    function();  
}

运算符

GLSL运算符与C语言类似，此处不再赘述，只说不同点：

• GLSL要求运算符两侧的变量必须具有相同的数据类型。
• 对于二目运算符（*，/，+，-），操作数必须为浮点型或者整型。
• 比较运算符只能用于标量，有专门的内置函数用于向量比较，后续内置函数会介绍。

限定符

存储限定符

声明变量时，可以使用存储限定符进行修饰，类似C语言中的说明符。

const

const用于修饰编译时常量（声明时必须赋初值），或者只读的函数参数。结构体成员不能被声明为常量，但是结构体变量可以被声明为常量，并且需要在初始化时使用构造器初始化其值。

attribute

attribute变量是应用程序传输给顶点着色器的逐顶点数据，即每个顶点都需要一份数据，通常用于表示顶点坐标、顶点颜色、纹理坐标等数据。attribute变量在shader中是只读的，不能在顶点着色器中进行修改。此外，attribute变量必须由执行着色器的应用程序传输数据进行赋值。

可使用的最大attribute数量是有上限的，可以使用内置函数glGetIntegerv来查询GL_MAX_VERTEX_ATTRIBS。OpenGL ES 2.0至少支持8个attribute变量。

uniform

uniform可用在顶点和片元着色器中，用于修饰全局变量，即它们不限于某个顶点或者某个像素。通常用于表示变换矩阵、纹理等数据。uniform变量在shader中是只读的，不能在着色器中进行修改。此外，uniform变量必须由执行着色器的应用程序传输数据进行赋值。

着色器可以使用的uniform个数是有限的，可以使用内置函数glGetIntegerv来查询GL_MAX_VERTEX_UNIFORM_VECTORS和GL_MAX_FRAGMENT_UNIFORM_VECTORS。OpenGL ES 2.0至少支持128个顶点uniform以及16个片元uniform。

varying

varying用于声明顶点着色器和片元着色器之间共享的变量。在顶点和片元着色器中，必须有相同的varying变量声明。首先，顶点着色器为每个顶点的varying变量赋值，然后光栅化阶段会对varying变量进行插值计算（光栅化后的每个片元都会得到一个对应的varying变量值），最后把插值结果交给片元着色器进行着色。varying只能用于修饰浮点标量、浮点向量、浮点矩阵以及包含这些类型的数组。

varying数量也存在限制，可以使用glGetIntegerv来查询GL_MAX_VARYING_VECTORS。OpenGL ES 2.0至少支持8个varying变量。

本地变量和函数参数只能使用const限定符，函数返回值和结构体成员不能使用限定符。
attribute和uniform变量不能在初始化时赋值，这些变量必须由应用程序主动进行赋值。

参数限定符

GLSL提供了参数限定符用于修饰函数参数，表示参数是否可读写。

in（只读参数）

in是默认修饰符，表示参数是值传递，并且在函数内不能修改该值。

out（只写参数）

out表示参数是引用传递，但是参数没有被初始化，所以在函数内不可读，只可写，并且函数结束后，修改依然生效。

inout（可读写参数）

inout表示参数是引用传递，在函数内可以对参数进行读写。并且函数结束后，修改依然生效（类似于C++中的引用）。

int newFunction(in bvec4 aBvec4,   // read-only 
                out vec3 aVec3,    // write-only
                inout int aInt);   // read-write

精度限定符

精度限定符明确指定了着色器变量使用的精度范围，包括：lowp、mediump和highp三种精度。当使用低精度时，OpenGL ES可以更快速和低功耗地运行着色器，效率的提高得益于精度的舍弃，如果精度选择不合理，着色器运行的结果会出现失真。所以需要测试不同的精度才能确定最合适的配置。

精度限定符可以修饰整型或者浮点型标量、向量和矩阵。在顶点着色器中，精度限定符是可选的，假如没有指定限定符，那么默认使用最高精度。在片元着色器中，精度限定符是必须的，要么在定义变量时直接指定精度，要么指定类型的默认精度。

// 为类型指定精度，若定义float变量时，没有指定精度限定符，那么默认是highp精度
precision highp float;
precision mediump int;
// 为变量指定精度
highp vec4 position;
varying lowp vec4 color;

在OpenGL ES中，精度的定义及范围取决于具体的实现，不是完全一致。精度限定符指定了存储这些变量时，必须满足的最小范围和精度。具体实现可能会使用比要求更大的范围和精度，但绝对不会比要求少。

不同着色器支持的不同精度限定符的范围与精度可以使下面的函数查询：

void GL_APIENTRY glGetShaderPrecisionFormat (GLenum shadertype, GLenum precisiontype, GLint *range, GLint *precision);

其中，shadertype必须是VERTEX_SHADER或FRAGMENT_SHADER；precisiontype必须是GL_LOW_FLOAT、GL_MEDIUM_FLOAT、GL_HIGH_FLOAT、GL_LOW_INT、GL_MEDIUM_INT或GL_HIGH_INT；range是指向长度为2的整数数组的指针，这两个整数表示数值范围：

range[0] = log2(|min|)
range[1] = log2(|max|)

precision是指向整数的指针，该整数是对应的精度位数（用log2取对数值）。

当表达式中出现多种精度时，选择精度最高的那个；当一个精度都没找到时，则使用默认或最大精度。

限定符的顺序

当出现多种限定度时，需要遵循一定的顺序：

• 一般变量：存储限定符 -> 精度限定符
• 函数参数：存储限定符 -> 参数限定符 -> 精度限定符

// 变量
varying highp float color; // storage -> precision
void fun(const in lowp float size){ // storage -> parameter -> precision
}

预处理

GLSL中的预处理指令与C语言类似，都是以#开头，每个指令独占一行。常见的预处理指令如下所示：

// 定义和取消定义
#define
#undef
// 条件判断
#if
#ifdef
#ifndef
#else
#elif
#endif
#pragma
#extension
#version
#line

#pragma表示编译指示，用来控制编译器行为。

#pragma debug(on)
#pragma debug(off)

开发和调试时可以打开debug选项，以便获取更多的调试信息，默认为off。

#version指定使用哪个GLSL版本编译着色器，必须写在编译单元的最前面，其前面只能有注释或空白，不能有其他字符。

#extension用来启用某些扩展功能，每个显卡驱动厂商都可以定义自己的OpenGL扩展，如：GL_OES_EGL_image_external。启用扩展的命令如下所示：

// 为某个扩展设置行为
#extension extension_name: behavior
// 为所有扩展设置行为
#extension all : behavior
// 启用OES纹理
#extension GL_OES_EGL_image_external : require

extension_name表示具体某个扩展，all表示编译器支持的所有扩展，behavior表示对扩展的具体操作，比如启用、禁用等，如下所示：

对于每一个被支持的扩展，都有一个对应的宏定义，我们可以用它来判断编译器是否支持该扩展。

#ifdef OES_extension_name
#extension OES_extension_name : enable
#else
#endif

除此之外，还有一些预定义的系统变量：

__LINE__    // int类型，当前源码中的行号.
__FILE__    // int类型，当前Source String的唯一ID标识
__VERSION__ // int类型，当前的glsl版本，比如100（100 = v1.00）
GL_ES       // 如果当前是在OpenGL ES环境，为1，否则为0

内置变量

OpenGL着色语言包含一些内置变量，这里主要介绍顶点和片元着色器的内置变量。

顶点着色器内置变量

gl_Position

gl_Position是输出变量，用来保存顶点位置的齐次坐标。该值用作图元装配、裁剪以及其他固定管道操作。如果顶点着色器中没有对gl_Position赋值，那么在后续阶段它的值是不确定的。gl_Position可以被写入多次，后续步骤以最后一次写入值为准。

gl_PointSize

gl_PointSize是输出变量，是着色器用来控制被栅格化点的大小，以像素为单位。如果顶点着色器中没有对gl_PointSize赋值，那么在后续阶段它的值是不确定的。

片元着色器内置变量

gl_FragColor

gl_FragColor是输出变量，定义了后续管线中片元的颜色值。gl_FragColor可以被写入多次，后续步骤以最后一次写入值为准。如果执行了discard操作，则片元会被丢弃，gl_FragColor将不再有意义。

gl_FragCoord

gl_FragCoord是只读变量，保存当前片元的窗口坐标(x, y, z, 1/w)，该值是图元装配阶段对图元插值计算所得，z分量表示当前片元的深度值。

gl_FragDepth

gl_FragDepth是输出变量，用于改变片元的深度值（替代gl_FragCoord.z深度值）。如果在任何地方写入了它的值，那么务必在所有执行路径中都写入它的值，否则未写入的路径上它的值有可能不明确。

gl_FrontFacing

gl_FrontFacing是只读变量，如果片元属于面朝前的图元，那么它的值为true。该变量可以选取顶点着色器计算出的两个颜色之一以模拟双面光照。

gl_PointCoord

gl_PointCoord是只读变量，表示当前片元在点图元中的二维坐标，范围是0.0到1.0。如果当前图元不是点，那么gl_PointCoord读取的值将是不明确的。

函数

自定义函数

GLSL支持自定义函数，但是函数不能嵌套，不支持递归调用，必须声明函数返回值类型（无返回值时声明为void）。如果一个函数在定义前被调用，则需要先声明其函数原型。

vec4 getPosition(){ 
    vec4 v4 = vec4(0.,0.,0.,1.);
    return v4;
}

内嵌函数

三角形函数

ParamType可以是float、vec2、vec3、vec4，参数类型和返回类型是一致的。

指数函数

ParamType可以是float、vec2、vec3、vec4，参数类型和返回类型是一致的。

通用函数

ParamType可以是float、vec2、vec3、vec4，参数类型和返回类型是一致的。

几何函数

ParamType可以是float、vec2、vec3、vec4。

矩阵函数

不同于传统的向量相乘，这里matrixCompMult返回一个向量，该向量的各分量等于x和y向量各个分量的乘积。

mat2 matrixCompMult(mat2 x, mat2 y)  
mat3 matrixCompMult(mat3 x, mat3 y)  
mat4 matrixCompMult(mat4 x, mat4 y)
// 结果向量z
z[i][j] = x[i][j] * y[i][j]

矢量（向量）关系函数

矢量（向量）关系函数主要包含：<, <=, >, >=, ==, !=），函数参数是整型或者浮点型向量，函数返回值是参数向量各个分量比较产生的一个布尔型向量。
下面用bvec表示bvec2、bvec3、bvec4；ivec表示ivec2、ivec3、ivec4；vec表示 vec2、vec3、vec4。参数向量和返回值向量的大小必须一致。

纹理查找函数

纹理查询的目的是从纹理中提取指定坐标的颜色信息。OpenGL中纹理有两种：

• 2D纹理（sampler2D）
• 3D纹理（samplerCube）

顶点着色器和片元着色器中都可以使用纹理查找函数。但是顶点着色器中不会计算细节级别（level of detail），所以二者的纹理查找函数略有不同。

以下函数只在顶点着色器中可用：

vec4 texture2DLod(sampler2D sampler, vec2 coord, float lod);
vec4 texture2DProjLod(sampler2D sampler, vec3 coord, float lod);
vec4 texture2DProjLod(sampler2D sampler, vec4 coord, float lod);
vec4 textureCubeLod(samplerCube sampler, vec3 coord, float lod);

以下函数只在片元着色器中可用：

vec4 texture2D(sampler2D sampler, vec2 coord, float bias);
vec4 texture2DProj(sampler2D sampler, vec3 coord, float bias);
vec4 texture2DProj(sampler2D sampler, vec4 coord, float bias);
vec4 textureCube(samplerCube sampler, vec3 coord, float bias);

float类型参数bias表示：使用mipmaps计算纹理的适当细节级别之后，在执行实际的纹理查找操作之前添加的偏差。

以下函数在顶点着色器和片元着色器中都可用:

vec4 texture2D(sampler2D sampler, vec2 coord);
vec4 texture2DProj(sampler2D sampler, vec3 coord);
vec4 texture2DProj(sampler2D sampler, vec4 coord);
vec4 textureCube(samplerCube sampler, vec3 coord);

参考文档

1. GLSL 详解（基础篇）
2. GLSL 详解（高级篇）
3. OpenGL ES Shading Language Reference
4. shadertoy