sdfgen 项目使用教程

sdfgen 项目使用教程

sdfgen GPU-based SDF generator 项目地址: https://gitcode.com/gh_mirrors/sdf/sdfgen

1. 项目目录结构及介绍

sdfgen/
├── build/
│   └── krom/
│       ├── run_windows.bat
│       ├── run_linux.sh
│       └── run_macos.sh
├── Libraries/
├── Shaders/
├── Sources/
├── viewer/
│   └── build/
│       └── krom/
│           ├── run_windows.bat
│           ├── run_linux.sh
│           └── run_macos.sh
├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
└── khafile.js

目录结构介绍

• build/: 包含用于不同操作系统的启动脚本。
  • krom/: 包含 Windows、Linux 和 MacOS 的启动脚本。
• Libraries/: 项目依赖的库文件。
• Shaders/: 项目使用的着色器文件。
• Sources/: 项目的源代码文件。
• viewer/: 包含一个简单的查看器，用于查看生成的 SDF 文件。
  • build/krom/: 包含查看器的启动脚本。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• khafile.js: 项目配置文件。

2. 项目启动文件介绍

启动脚本

• run_windows.bat: Windows 系统下的启动脚本。
• run_linux.sh: Linux 系统下的启动脚本。
• run_macos.sh: MacOS 系统下的启动脚本。

使用方法

1. 克隆项目到本地：

   git clone https://github.com/armory3d/sdfgen.git
   cd sdfgen/build/krom
   

2. 根据操作系统运行相应的启动脚本：

   • Windows: 双击 run_windows.bat 或运行 ./run_windows.bat。
   • Linux: 运行 ./run_linux.sh。
   • MacOS: 运行 ./run_macos.sh。

3. 项目配置文件介绍

khafile.js

khafile.js 是项目的配置文件，用于配置项目的构建选项和依赖项。以下是文件的基本结构：

// khafile.js 配置示例
let project = new Project('sdfgen');

project.addSources('Sources');
project.addShaders('Shaders');
project.addLibrary('Libraries');

resolve(project);

配置项说明

• project.addSources('Sources'): 添加项目的源代码目录。
• project.addShaders('Shaders'): 添加项目的着色器目录。
• project.addLibrary('Libraries'): 添加项目的库文件目录。

通过这些配置项，可以指定项目所需的资源和依赖项，确保项目能够正确构建和运行。

sdfgen GPU-based SDF generator 项目地址: https://gitcode.com/gh_mirrors/sdf/sdfgen