实用脚本

一系列使生活更轻松的助手。

生成

帮助为项目生成新文件。

生成示例

所有标志都是可选的。建议设置 --name。如果未设置 --output-dir,则示例将生成在指定类别下的 samples 目录中。

./scripts/generate.py sample --name <SampleName> --category <category> --output-dir <output_dir>

运行上述行将生成以下文件

samples/category/my_sample/CMakeLists.txt
samples/category/my_sample/sample_name.cpp
samples/category/my_sample/sample_name.h

还将生成一个新的类

class SampleName : public VulkanSample {
...
};

生成 API 示例

可以使用以下命令生成 API 示例

./scripts/generate.py sample_api --name <SampleName> --category <category> --output-dir <output_dir>

运行上述行将生成以下文件

samples/category/my_sample/CMakeLists.txt
samples/category/my_sample/sample_name.cpp
samples/category/my_sample/sample_name.h

还将生成一个新的类

class SampleName :public ApiVulkanSample {
...
};

生成 Android 项目

./scripts/generate.py android
./scripts/generate.py android --output-dir build/<another_folder_name>

Clang 格式化

当从存储库的根目录调用时,此脚本将对存储库中已在 git diff 中更改的所有文件运行 clang-format。

./scripts/clang-format.py <brand_to_diff>

当从存储库的根目录调用时,此脚本将检查存储库中已在 git diff 中更改的所有文件,以确保它们具有正确的许可证标头。

./scripts/copyright.py <branch_to_diff>

这类似于版权 CI 检查,除了当使用 --fix 运行时,此脚本将更新存储库中已在 git diff 中更改的所有文件中的许可证标头。

./scripts/copyright.py <branch_to_diff> --fix