banner

PPCA raytracer

UPDATE 工科 PPCA 已结课。我们在这里保存了同学们的作品。

Welcome! 你可以直接点击右上角的“Use this template”将这个项目复制到自己的 GitHub Profile 中。接下来,你需要做一些准备工作。

Task 0: Preparation

  • Cargo.toml 中,修改作者信息。
  • LICENSE 中,将作者修改为自己。你也可以换成其他许可证。
  • 使用 rustup 安装 Rust。如果下载速度很慢,可以考虑使用 SJTUG Mirror 的 rust-static 和 crates.io 镜像。
  • 之后,你需要安装一些工具。首先,你需要定位到项目目录。而后,运行 rustup component add clippy rustfmt
  • 接着,运行 make ci。如果程序可以正常运行,那么环境就已经配置成功了。
  • 将这些更改 push 到 GitHub 上。在 GitHub Action 中,“Lint and Test”和“Build and Upload”都应当通过。
  • 程序生成的结果会出现在 GitHub Action 的 artifacts 中。output 文件夹下的内容应当是程序运行时生成的。 对 output 文件夹的修改不应该被同步到 GitHub 上(这个文件夹在 .gitignore 中有设置,会被 git 忽略)。
  • 最后,你可以把 README.md 的教程部分删除,换成自己程序的描述、运行方法等信息。

Task 1: Ray-tracer From Scratch

TA Wenxin Zheng 会有更详细的说明。

More Information

Makefile

Makefile 中包含了运行 raytracer 的常用指令。如果没有安装 make,你也可以直接运行 cargo balahbalah

  • make fmt 会自动格式化所有的 Rust 代码。
  • make clippy 会对代码风格做进一步约束。
  • make test 会运行程序中的单元测试。你编写的 Vec3 需要通过所有测试。
  • make run_release 会运行优化后的程序。通常来说,你需要用这个选项运行 raytracer。否则,渲染会非常慢。
  • make run 以 debug 模式运行程序。
  • make ci = fmt + clippy + test + run_release。建议在把代码 push 到远程仓库之前运行一下 make ci

GitHub Action

这个仓库已经配置好了 GitHub Action。只要把代码 push 到远程仓库,GitHub 就会进行下面两个检查。

  • Lint and Test 会运行所有单元测试,并检查代码风格。
  • Build and Upload 会运行优化后的程序,并将 output 目录下生成的文件传到 build artifacts 中。

Reference

  • The Rust Programming Language
    • 通常来说,你只需要用到前 6 章和第 10.2 节的内容。
    • 如果碰到了 lifetime 相关的问题,请仔细阅读第 4 章,特别是 4.2 的例子。
    • 当然,你也可以通过第 15 章中的智能指针解决一部分 lifetime 导致的问题。
    • Rust 的面向对象特性(trait,对应 C++ 的类)可以在 10.2 中找到。
    • 如果你希望编写一个多线程的渲染器,可以阅读第 15、16 章的内容。
  • rustlings 包含许多 Rust 小练习。如果你希望通过练习来学习 Rust 语言,可以尝试一下这个参考资料。
  • Ray Tracing in One Weekend