docs.gl, OpenGL参考文档

分享于 

5分钟阅读

GitHub

  繁體 雙語
OpenGL Reference Documentation
  • 源代码名称:docs.gl
  • 源代码网址:http://www.github.com/BSVino/docs.gl
  • docs.gl源代码文档
  • docs.gl源代码下载
  • Git URL:
    git://www.github.com/BSVino/docs.gl.git
    Git Clone代码到本地:
    git clone http://www.github.com/BSVino/docs.gl
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/BSVino/docs.gl
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    docs.gl

    docs.gl 是用于OpenGL文档的public 域网络搭建。 Khronos提供的实际文档网站的格式和格式不正确,难以导航和搜索。 docs.gl 旨在提高OpenGL文档的外形和质量。

    捐赠欢迎

    docs.gl 应该被认为是一个由GitHub支持的public wiki。 如果你认为你可以改进文档,请考虑提交请求请求。 我已经在这里上传了所有总账版本的,为了方便。

    :如何构建它

    docs.gl 是一个 python 脚本,它读取每个手册页,处理它,并输出 static HTML。 没有数据库或者服务器端脚本。 所有的模板和处理都是由 python 脚本在构建时完成的。 它的执行方式如下:

    
    python compile.py
    
    
    
    

    如果你为最终版本建立,那么你可以使用 --full 参数,该参数可以进行HTML缩小和Unicode处理。 它看起来像这样:

    
    python compile.py --full
    
    
    
    

    如果运行 Windows,就有一个 build.bat 和 build_full.bat 来方便。 脚本完成构建后,完成的站点将位于名为 htdocs的文件夹中。

    文件结构

    8 目录称为 el3sl4es1es2es3gl2gl3gl4 包含每个OpenGL和GLSL命令的手册页。 它们只是带有 header/页脚元素的内部 HTML,如 headhtml。 这些页面由 compile.py 读取和处理以生成最终的站点。

    html 目录包含用于编译站点的更多资源。 直接位于 html 目录中的文件是模板文件,用于进一步处理手动页面。 inside 模板文件是 compile.py 在编译过程中搜索和动态替换的标记。 例如根据所编译的命令的最新版本,令牌 {$current_api} 将替换为 3.3 或者 4.2。 站点中基于编译的手册页更改的所有内容都以这种方式处理。

    copy 文件夹中的文件没有更改。

    examples 文件夹中的文件包含手册页中使用的源代码示例。 在这些文件中,使用特殊标记提供指向命令页的链接。 例如如果该示例出现在GL4页面中,则 {%glBindTexture} 将提供指向 http://docs.gl/gl4/glBindTexture的链接。 如果该示例出现在gl3页中,则该链接将相应更新。

    在主目录中有一些额外的helper python 脚本。 opengl.pyglsl.py 包含 helper 表,指定哪些示例应该出现在哪些页面上,以及指定每个页面内容的目录中显示的类别。 insert_additional.pymake_copyright.pystrip.py 是专门的one-time-use程序,它们在最初从Khronos下载后用于处理手册页。 它们可以被重复使用以进行额外的处理。 read_spec.py 读取在 specs/gl.xml 中找到的XML OpenGL规范文件并输出 opengl_spec.py,其中包含命令所属的原始数据。 opengl_spec.py 仅在Khronos更新规范时才应生成。

    • 扩展显示一个扩展可用的版本列表。 显示哪个扩展引入了命令。
    • 在每个页面上显示"版本/核心自版本以来",就像 OpenGL一样。
    • 将来自常见错误文件的信息集成到页面中,以便它们所对应的每个命令
    • 使用规格中可能存在但手册中缺少的信息更新每个页面
    • 显示可能导致管道停顿的每个页面上的命令( 例如 glGet )
    • 左。右。右( 如 vs。CS。FS等) 中的GLSL命令可以在左侧显示
    • CamelCase搜索- 例如BFDLI查找 glBindFragDataLocationIndexed
    • GLSL 1/3
    • WebGL
    • GLSL语法备忘单。/输出中的比如 属性/变化 vs

    感谢i ##opengl 中的大人,在我写这篇文章时,我提供了很好的反馈。


    DOC  REF  Opengl  Refer  
    相关文章