Vulkan 指南项目教程
项目的目录结构及介绍
Vulkan 指南项目的目录结构如下:
Vulkan-Guide/
├── CODE_OF_CONDUCT.adoc
├── CONTRIBUTING.adoc
├── LICENSE
├── Makefile
├── README.adoc
├── README.md
├── guide.adoc
├── antora/
│ └── antora-playbook.yml
├── chapters/
│ ├── 01-introduction.adoc
│ ├── 02-vulkan-api.adoc
│ ├── 03-vulkan-usage.adoc
│ ├── 04-project-layout-and-libraries.adoc
│ ├── 05-project-setup.adoc
│ ├── 06-building-project.adoc
│ ├── 07-code-walkthrough.adoc
│ ├── 08-initializing-vulkan.adoc
│ ├── 09-drawing-with-compute.adoc
│ ├── 10-graphics-pipelines.adoc
│ ├── 11-textures-and-engine-architecture.adoc
│ ├── 12-gltf-loading.adoc
│ └── extra-chapter.adoc
├── images/
│ └── ...
├── lang/
│ └── ...
└── gitignore
目录结构说明
CODE_OF_CONDUCT.adoc
: 行为准则文件。CONTRIBUTING.adoc
: 贡献指南文件。LICENSE
: 项目许可证文件。Makefile
: 用于构建项目的 Makefile 文件。README.adoc
和README.md
: 项目介绍文件。guide.adoc
: 主指南文件。antora/
: 包含 Antora 配置文件的目录。chapters/
: 包含各个章节内容的目录。images/
: 包含项目所需图片的目录。lang/
: 包含不同语言版本的目录。gitignore
: Git 忽略文件。
项目的启动文件介绍
项目的启动文件主要是 guide.adoc
,它是整个 Vulkan 指南的主文件,包含了各个章节的链接和内容。
guide.adoc 文件内容概述
- Introduction: 概述 Vulkan API 和项目使用的库。
- Chapter 0: Setting up the guide initial code: 设置初始代码。
- Chapter 1: Vulkan initialization and render loop setup: Vulkan 初始化和渲染循环设置。
- Chapter 2: Vulkan compute shaders and drawing: Vulkan 计算着色器和绘制。
- Chapter 3: Vulkan mesh drawing: Vulkan 网格绘制。
- Chapter 4: Textures and better descriptor set management: 纹理和更好的描述符集管理。
- Chapter 5: Full GLTF scene loading and high performance rendering: 完整的 GLTF 场景加载和高性能渲染。
项目的配置文件介绍
项目的配置文件主要包括 Makefile
和 antora/antora-playbook.yml
。
Makefile 文件内容概述
Makefile
文件用于构建和生成指南文档,包含了一些常用的命令,如 make build
用于构建项目,make clean
用于清理生成的文件等。
antora-playbook.yml 文件内容概述
antora-playbook.yml
文件是 Antora 的配置文件,用于定义如何构建和发布文档。它包含了项目的元数据、模块、组件和版本等信息。
name: vulkan-guide
title: Vulkan Guide
version: latest
start_page: chapters/01-introduction.adoc
nav:
- chapters/01-introduction.adoc
- chapters/02-vulkan-api.adoc
- chapters/03-vulkan-usage.adoc
- chapters/04-project-layout-and-libraries.adoc
- chapters/05-project-setup.adoc
- chapters/06-building-project.adoc
- chapters/07-code-walkthrough.adoc
- chapters/08-initializing-vulkan.adoc
- chapters/09-drawing-with-compute.adoc
- chapters/10-graphics-pipelines.adoc
- chapters/11-textures-and-engine-architecture.adoc
- chapters/12-gltf-loading.adoc
- chapters/extra