Skip to content

Jzyzz/Ray-tracer

Repository files navigation

banner

Pseudo Photograph Company of ACM

ACM伪摄影公司,简称PPCA,于2021年成立😉

这个项目的主要工作是使用Rust语言实现一个光线追踪渲染器。以这个形式,你能通过学习一门新的(而且漂亮的)语言来加深对编程语言设计、编译原理的理解,同时又能趣味性地了解Computer Graphics的基础工作。

今年我们增设了作品互评环节。使用自己手写的渲染器,发挥艺术才能,创造出惊艳全场的超现实大作吧!

主要参考资料如下:

更多的参考资料信息在下方的Reference版块中。

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

Task 0: Preparation

  • raytracer/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 INF: Learn about Rust

我们希望在前一周的时间让大家熟悉Rust的语法。请阅读Rust书(或者你认为合适的教程)学习。

  • 通常来说,你只需要用到前 6 章和第 10.2 节的内容。
  • 如果碰到了 lifetime 相关的问题,请仔细阅读第 4 章,特别是 4.2 的例子。
  • 当然,你也可以通过第 15 章中的智能指针解决一部分 lifetime 导致的问题。
  • Rust 的面向对象特性(trait,对应 C++ 的类)可以在 10.2 中找到。
  • (Advanced)涉及到多线程渲染时,你可以阅读第 15、16 章的内容。

Task 1: One Weekend

  • Ray Tracing book 1,轻巧的一个周末。

初定code review:第二周周一。

  • book 1相关细节
  • Rust特性掌握(简易,不超出要求章节外)

Task 2: Next Week

  • Ray Tracing book 2 (Motion Blur / Fog可二选一)
  • 多线程渲染

初定code review:第二周周五

  • book 2相关细节
  • 工科同学结课🎉 作品互评🤯

Task 3: Rest of Your Life & Extra work

  • Ray Tracing book 3
  • Advanced features

初定code review:第四周周五

  • book 3相关细节
  • advanced features相关细节
  • ACM班同学结课🎉 作品互评🤯

Advanced features

这个部分尚未确定,可以暂时不看。目前移用去年的任务。

  • Track 1: New Features 完成 Rest of Your Life 的剩余部分,重构代码并渲染带玻璃球的 Cornell Box。
  • Track 2: More Features 完成 Next Week 中除 Motion Blur 外的部分,渲染噪点较少的最终场景。
  • Track 3: Reduce Contention 此项工作的前提条件是完成多线程渲染。在多线程环境中,clone / drop Arc 可能会导致性能下降。因此,我们要尽量减少 Arc 的使用。这项任务的目标是,仅在线程创建的时候 clone Arc;其他地方不出现 Arc,将 Arc 改为引用。
  • Track 4: Static Dispatch 调用 Box<dyn trait> / Arc<dyn trait> / &dyn trait 中的函数时会产生额外的开销。我们可以通过泛型来解决这个问题。
    • 这个任务的目标是,通过定义新的泛型材质、变换和物体,比如 LambertianStatic<T>,并在场景中使用他们,从而减少动态调用的开销。你也可以另开一个模块定义和之前的材质同名的 struct。
    • 你可以在 material.rs 里找到泛型的相关用法。
    • 仅在 HitRecord, ScatterRecord (这个在 Rest of Your Life 的剩余部分中出现), HittableListBVHNode 中使用 dyn
    • 如果感兴趣,可以探索如何使用 macro_rules 来减少几乎相同的代码写两遍的冗余。
  • Track 5: Code Generation 此项工作的前提条件是完成 BVH。
    • 目前,BVHNode 是在运行时构造的。这个过程其实可以在编译期完成。我们可以通过过程宏生成所有的物体,并构造静态的 BVHNode,从而提升渲染效率。
    • 为了使用过程宏,在这个工程中,我们已经重新组织了目录结构。请参考这个 PR进行修改。
    • 你可以使用 cargo expand 来查看过程宏处理过后的代码。你也可以在编译过程中直接输出过程宏生成的代码。
    • codegen 部分不需要通过 clippy。
    • 如果感兴趣,你也可以探索给过程宏传参的方法。e.g. 通过 make_spheres_impl! { 100 } 生成可以产生 100 个球的函数。
  • Track 6: PDF Static Dispatch 此项工作的前提条件是完成 Rest of your Life 的剩余部分。PDF 中需要处理的物体使用泛型完成,去除代码路径中的 &dyn
  • Track 7: More Code Generation 在过程宏中,读取文件,直接从 yaml 或 JSON 文件(选择一种即可)生成场景对应的程序。
    • data 文件夹中给出了一些例子。
    • 例子中 BVHNode 里的 bounding_box 是冗余数据。你可以不使用这个数据。
    • 读 JSON / yaml 可以调包。
  • Track 8: Advanced Features 增加对 Transform 的 PDF 支持。
  • 如果你有多余的时间,你可以通过 benchmark 来测试实现功能前后的区别。
    • 完成 Track 3 前请备份代码 (比如记录 git 的 commit id)。完成 Track 4, 5, 6 时请保留原先的场景和程序,在此基础上添加新的内容。
    • 你可以使用 criterion crate 做 benchmark。benchmark 的内容可以是往构造好的场景中随机打光线,记录打一条光线所需的时间。

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

进程

必做部分:

  • [√] book 1
  • [√] 3 BVH
  • [√] 7 Rectangles and Lights

选做部分:

  • [√] 2 Motion Blur
  • [√] 4 Solid Textures
  • [√] 5 Perlin Noise
  • [√] 6 Image Texture Mapping
  • [√] 8 Instances
  • [√] 9 Volumes
  • [√] 10 book 2 final scene

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published