OpenGL杂谈之复用GLSL代码

欢迎访问我的个人主页了解更多关于OpenGL的知识

前言

GLSL是OpenGL的着色语言，在编写GLSL的过程中，复用代码是一件比较麻烦的事情，GLSL基本是不支持#include预编译指令的。
目前我已知的OpenGL对于GLSL include的支持仅限于扩展ARB_shading_language_include，如果你的系统支持该OpenGL扩展，那么你就可以在GLSL中使用include。不过似乎只有nvidia的OpenGL驱动对它有支持。

复用GLSL代码的级别

既然官方的include使用如此艰难，我们就来自己造轮子吧。首先我们要确定在什么级别复用代码。有两种选择：

1. 程序代码运行时将可复用的GLSL代码块合并成可运行的GLSL代码。
2. 程序编译时跑一个脚本，将可复用的GLSL代码合并成可运行的GLSL文件，然后在运行时使用生成好的GLSL文件。

我之前尝试过第一种方法，运行时合并GLSL代码，不过调试不是很方便，报错时不好定位到哪行，而且运行时生成终究会消耗一些性能。所以这一次我打算探索第二条路。

预编译工具m4

在研究第二种方式时，碰巧找到了一个非常符合解决本次问题的工具m4。m4说白的就是一个预编译工具，将写有宏的文本进行预编译展开。如果你使用Mac。在终端输入

m4 --version

如果得到如下，恭喜你，你已经拥有了此工具。

GNU M4 1.4.6
Copyright (C) 2006 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Written by Rene' Seindal.

当然你也可能是其他版本。如果没有出现，你可以使用homebrew安装。

brew install m4

如果你喜欢使用源码安装，可以访问m4的官网。

m4的使用示例

我们先来写一个例子来感受一下m4的功能。在同一个目录下创建2个文件，Test.m4和inc.m4。

在inc.m4中输入下面内容。
这里是被包含的内容

在Test.m4中我们做两件事情，包含inc.m4，定义一个变量。

include(`inc.m4')

define(`content', `例子')

这是一个content

注意，inc.m4左边不是单引号，是`，右边是单引号。content和 例子也是一样。include(`inc.m4')将inc.m4包含到Test.m4中，define(`content', `例子')将例子这个值赋给content。我们使用m4预处理一下看看结果。在终端运行。

m4 Test.m4

结果如下。

这里是被包含的内容




这是一个例子

将m4运用于GLSL

下面是我的一个GLSL程序结构目录，我使用m4将这些复用代码合并到一起。

这里我写了两个光照模型，lambert_phong和lambert_blinn，它们大部分代码都是一样的，只有高光部分代码不一样。targets文件夹下是最终被m4处理的文件。处理完后直接被OpenGL使用。我们看一下其中的一个文件frag_lambert_phong.glsl。

// defines
include(`fragment shader components/frag_base_header.glsl')
include(`fragment shader components/frag_structs.glsl')
include(`fragment shader components/frag_in_vars.glsl')
include(`fragment shader components/frag_uniform_vars.glsl')

// functions
include(`fragment shader components/frag_normal.glsl')
include(`fragment shader components/frag_light_base.glsl')
include(`fragment shader components/frag_light_lambert.glsl')
include(`fragment shader components/frag_light_phong.glsl')

// light model
include(`fragment shader light model/frag_light_model_lambert_phong.glsl')

其实我只用到了m4的include功能，我们将这个文件和frag_lambert_blinn对比一下。

// defines
include(`fragment shader components/frag_base_header.glsl')
include(`fragment shader components/frag_structs.glsl')
include(`fragment shader components/frag_in_vars.glsl')
include(`fragment shader components/frag_uniform_vars.glsl')

// functions
include(`fragment shader components/frag_normal.glsl')
include(`fragment shader components/frag_light_base.glsl')
include(`fragment shader components/frag_light_lambert.glsl')
include(`fragment shader components/frag_light_blinn.glsl')

// light model
include(`fragment shader light model/frag_light_model_lambert_blinn.glsl')

只有最后两个include不一样，很好的满足了我复用GLSL的需求。最后我写了一个简单的脚本批量处理targets下的文件。

#!env python

import os
import subprocess

target_files = os.listdir("./targets")

for file in target_files:
    print("building " + file + "...")
    command = str.format("m4 ./targets/{0} > ../{0}", file)
    subprocess.call(command, shell=True)
    print(file + " build finish.")

将这个脚本集成到你的编译系统中，就可以做到完全自动化复用和预处理GLSL了。