开源项目 `glsl-sdf-primitives` 使用教程

开源项目 glsl-sdf-primitives 使用教程

glsl-sdf-primitivesA bunch of distance field primitives for ray marching项目地址:https://gitcode.com/gh_mirrors/gl/glsl-sdf-primitives

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

glsl-sdf-primitives 是一个用于光线行进（ray marching）的距离场（Signed Distance Field, SDF）原语集合。项目的目录结构如下：

glsl-sdf-primitives/
├── LICENSE
├── README.md
├── package.json
├── sdBox.glsl
├── sdCappedCone.glsl
├── sdCappedCylinder.glsl
├── sdCapsule.glsl
├── sdCone.glsl
├── sdCylinder.glsl
├── sdHexPrism.glsl
├── sdPlane.glsl
├── sdSphere.glsl
├── sdTorus.glsl
├── sdTriPrism.glsl
├── udBox.glsl
├── udQuad.glsl
├── udRoundBox.glsl
└── udTriangle.glsl

目录结构介绍

• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档。
• package.json: 项目的元数据文件，包含依赖信息等。
• sd*.glsl: 一系列的 SDF 原语文件，如 sdBox.glsl 表示有符号的盒子原语。
• ud*.glsl: 一系列的无符号 SDF 原语文件，如 udBox.glsl 表示无符号的盒子原语。

2. 项目的启动文件介绍

glsl-sdf-primitives 项目本身是一个库，没有特定的启动文件。用户在使用时需要根据具体需求引入相应的 SDF 原语文件。例如，如果需要使用有符号的球体原语，可以引入 sdSphere.glsl 文件。

3. 项目的配置文件介绍

glsl-sdf-primitives 项目没有特定的配置文件。用户在使用时直接引入所需的 SDF 原语文件即可。项目的元数据和依赖信息存储在 package.json 文件中，但这个文件主要用于 npm 包管理，不涉及运行时的配置。

使用示例

以下是一个简单的使用示例，展示如何在 GLSL 代码中引入并使用 sdTorus 原语：

#pragma glslify: sdTorus = require('glsl-sdf-primitives/sdTorus')

vec2 doModel(vec3 p) {
    return vec2(sdTorus(p, vec2(0.20, 0.05)), 0.0);
}

在这个示例中，我们通过 #pragma glslify 指令引入 sdTorus 原语，并在 doModel 函数中使用它来定义一个环形物体。

---

通过以上内容，您应该对 glsl-sdf-primitives 项目有了基本的了解，并能够开始使用其中的 SDF 原语进行光线行进相关的开发工作。

glsl-sdf-primitivesA bunch of distance field primitives for ray marching项目地址:https://gitcode.com/gh_mirrors/gl/glsl-sdf-primitives