HLSL Tools for Visual Studio 使用教程

HLSL Tools for Visual Studio 使用教程

HlslTools A Visual Studio extension that provides enhanced support for editing High Level Shading Language (HLSL) files 项目地址: https://gitcode.com/gh_mirrors/hl/HlslTools

1. 项目的目录结构及介绍

HLSL Tools for Visual Studio 是一个为 Visual Studio 2019 和 2022 提供增强 HLSL 文件编辑支持的扩展。以下是项目的目录结构及其介绍：

HlslTools/
├── .github/
│   └── workflows/
├── scripts/
├── src/
│   └── tools/
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── appveyor.yml
├── azure-pipelines.yml
└── build.cmd

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• scripts/: 包含项目的脚本文件。
• src/tools/: 包含项目的源代码文件，特别是与 HLSL 工具相关的代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目的变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• appveyor.yml: AppVeyor CI 配置文件。
• azure-pipelines.yml: Azure Pipelines CI 配置文件。
• build.cmd: 项目的构建脚本。

2. 项目的启动文件介绍

HLSL Tools for Visual Studio 的启动文件主要是 build.cmd。这个文件是一个批处理脚本，用于构建项目。通过运行这个脚本，可以编译项目的源代码并生成可执行文件或扩展包。

3. 项目的配置文件介绍

HLSL Tools for Visual Studio 的配置文件主要包括以下几个：

• .gitattributes: 用于配置 Git 的属性，例如文件的换行符处理等。
• .gitignore: 用于指定 Git 应该忽略的文件和目录。
• appveyor.yml: 用于配置 AppVeyor CI 的构建和测试流程。
• azure-pipelines.yml: 用于配置 Azure Pipelines 的构建和测试流程。
• shadertoolsconfig.json: 这是一个可选的配置文件，用于自定义 HLSL Tools 的预处理器定义和包含目录。

shadertoolsconfig.json 配置示例

{
  "hlsl": {
    "preprocessorDefinitions": {
      "MY_PREPROCESSOR_DEFINE_1": "Foo",
      "MY_PREPROCESSOR_DEFINE_2": 1
    },
    "additionalIncludeDirectories": [
      "C:\\Code\\MyDirectoryA",
      "C:\\Code\\MyDirectoryB",
      ".",
      ".\\RelativeDirectory"
    ],
    "virtualDirectoryMappings": [
      "/Project": "C:\\MyProject\\Shaders"
    ]
  }
}

• preprocessorDefinitions: 定义额外的预处理器定义。
• additionalIncludeDirectories: 指定额外的包含目录。
• virtualDirectoryMappings: 配置虚拟目录映射，通常用于 Unreal Engine 项目。

通过这些配置文件，用户可以自定义 HLSL Tools 的行为，以适应不同的开发环境和需求。

HlslTools A Visual Studio extension that provides enhanced support for editing High Level Shading Language (HLSL) files 项目地址: https://gitcode.com/gh_mirrors/hl/HlslTools