Skip to content

Personal attempt at The Ray Tracer Challenge, using Rust 2021. Commenced April 2023...

License

Notifications You must be signed in to change notification settings

DavidAntliff/RTC-Rust

Repository files navigation

The Ray Tracer Challenge - Rust

workflow

chapter11_refraction_20230423_123159.png

Based on the book "The Ray Tracer Challenge" by Jamis Buck, 1st Edition 2019.

Written in Rust 2021, with some code ported from RTC-CPP, a partial implementation in C++20.

Gallery

Here

Features

  • Outputs PPM files.
  • World scene with primitives:
    • Spheres,
    • Planes (infinite),
    • Cubes,
    • Cylinders,
    • Cones.
  • Transformations:
    • Translation,
    • Rotation (Euler),
    • Scaling (independent axes),
    • Skewing (6 DoF).
  • Multiple point-light sources.
  • Procedural patterns:
    • Stripes (linear, ring),
    • Gradients (linear, radial),
    • 3D checkerboard,
    • Blended patterns,
    • Nested patterns of arbitrary depth,
    • Perlin-noise perturbed patterns.
  • Phong shading.
  • Reflection.
  • Refraction.
  • Single and multi-threaded rendering.
  • Command-line interface.

TODO

Apart from continuing through the book:

  • Command line parameters for:
  • Resolution (e.g. "SVGA", "1024x768") - DONE
  • Rendering subrange within current resolution (e.g. "200+50,300+380", "200-250,300-380", "200-,300-", "-100,-100")
  • Output to filename - DONE (PPM only)
  • PNG rendering
  • Scene description files or DSL?
  • Gamma Correction (https://bheisler.github.io/post/writing-raytracer-in-rust-part-3/)
  • Beer's Law for transparency.
  • Emmissive colours.
  • HDR.

Conventions

This codebase uses the Left Hand Coordinate system.

Building

 $ cargo build

Development Notes

TODO

Comparison with RTC-CPP

RTC-CPP perf stats:

$ perf stat cpp/ray_tracer_challenge/cmake-build-release/src/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'cpp/ray_tracer_challenge/cmake-build-release/src/chapter10_perturbed_patterns':

          7,039.55 msec task-clock                #    1.000 CPUs utilized          
                20      context-switches          #    2.841 /sec                   
                 5      cpu-migrations            #    0.710 /sec                   
            52,504      page-faults               #    7.458 K/sec                  
    29,017,092,620      cycles                    #    4.122 GHz                    
    97,401,205,035      instructions              #    3.36  insn per cycle         
    13,300,398,903      branches                  #    1.889 G/sec                  
        78,188,392      branch-misses             #    0.59% of all branches        
   144,275,900,080      slots                     #   20.495 G/sec                  
    90,526,054,952      topdown-retiring          #     62.6% retiring              
    11,881,544,712      topdown-bad-spec          #      8.2% bad speculation       
    39,039,361,198      topdown-fe-bound          #     27.0% frontend bound        
     3,206,197,698      topdown-be-bound          #      2.2% backend bound         

       7.040438559 seconds time elapsed

       6.992133000 seconds user
       0.048000000 seconds sys


$ perf stat -e L1-dcache-load-misses,L1-icache-load-misses cpp/ray_tracer_challenge/cmake-build-release/src/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'cpp/ray_tracer_challenge/cmake-build-release/src/chapter10_perturbed_patterns':

        16,584,237      L1-dcache-load-misses                                       
         9,472,442      L1-icache-load-misses                                       

       6.863133956 seconds time elapsed

       6.794779000 seconds user
       0.068027000 seconds sys

RTC-Rust, before caching inverted transform matrices:

$ perf stat target/release/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'target/release/chapter10_perturbed_patterns':

          3,099.29 msec task-clock                #    1.000 CPUs utilized          
                10      context-switches          #    3.227 /sec                   
                 3      cpu-migrations            #    0.968 /sec                   
            37,371      page-faults               #   12.058 K/sec                  
    13,185,017,404      cycles                    #    4.254 GHz                    
    42,668,214,735      instructions              #    3.24  insn per cycle         
     5,032,009,860      branches                  #    1.624 G/sec                  
        52,054,965      branch-misses             #    1.03% of all branches        
    65,775,579,875      slots                     #   21.223 G/sec                  
    40,755,065,177      topdown-retiring          #     61.7% retiring              
     6,190,642,811      topdown-bad-spec          #      9.4% bad speculation       
    11,233,919,860      topdown-fe-bound          #     17.0% frontend bound        
     7,912,705,896      topdown-be-bound          #     12.0% backend bound         

       3.099916796 seconds time elapsed

       3.043758000 seconds user
       0.055995000 seconds sys


$ perf stat -e L1-dcache-load-misses,L1-icache-load-misses target/release/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'target/release/chapter10_perturbed_patterns':

        11,160,830      L1-dcache-load-misses                                       
         5,510,678      L1-icache-load-misses                                       

       3.101941357 seconds time elapsed

       3.053837000 seconds user
       0.048028000 seconds sys

RTC-Rust, after caching inverted transform matrices:

$ perf stat target/release/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'target/release/chapter10_perturbed_patterns':

          2,281.92 msec task-clock                #    1.000 CPUs utilized          
                 6      context-switches          #    2.629 /sec                   
                 2      cpu-migrations            #    0.876 /sec                   
            37,409      page-faults               #   16.394 K/sec                  
     9,850,975,494      cycles                    #    4.317 GHz                    
    31,482,049,466      instructions              #    3.20  insn per cycle         
     4,953,545,286      branches                  #    2.171 G/sec                  
        52,700,609      branch-misses             #    1.06% of all branches        
    49,167,467,990      slots                     #   21.547 G/sec                  
    29,500,480,794      topdown-retiring          #     60.0% retiring              
     5,205,967,198      topdown-bad-spec          #     10.6% bad speculation       
     8,483,798,398      topdown-fe-bound          #     17.3% frontend bound        
     5,977,221,598      topdown-be-bound          #     12.2% backend bound         

       2.282860171 seconds time elapsed

       2.218686000 seconds user
       0.064077000 seconds sys


$ perf stat -e L1-dcache-load-misses,L1-icache-load-misses target/release/chapter10_perturbed_patterns > image.ppm

 Performance counter stats for 'target/release/chapter10_perturbed_patterns':

        10,653,812      L1-dcache-load-misses                                       
         4,428,316      L1-icache-load-misses                                       

       2.324244012 seconds time elapsed

       2.264039000 seconds user
       0.060001000 seconds sys

Converting Large Images

When converting large PPM images to PNG, ImageMagick needs certain limits increased, otherwise this error occurs:

$ convert image.ppm hires.png
convert-im6.q16: width or height exceeds limit `image.ppm' @ error/cache.c/OpenPixelCache/3909.
convert-im6.q16: no images defined `hires.png' @ error/convert.c/ConvertImageCommand/3229.

Copy /etc/ImageMagick-6/policy.xml into the current directory and change the following lines:

$ diff -u /etc/ImageMagick-6/policy.xml policy.xml 
--- /etc/ImageMagick-6/policy.xml	2022-02-06 23:53:27.000000000 +1100
+++ policy.xml	2023-04-21 22:41:05.691912163 +1000
@@ -57,13 +57,13 @@
 -->
 <policymap>
   <!-- <policy domain="resource" name="temporary-path" value="/tmp"/> -->
-  <policy domain="resource" name="memory" value="256MiB"/>
-  <policy domain="resource" name="map" value="512MiB"/>
-  <policy domain="resource" name="width" value="16KP"/>
-  <policy domain="resource" name="height" value="16KP"/>
+  <policy domain="resource" name="memory" value="16GiB"/>
+  <policy domain="resource" name="map" value="4GiB"/>
+  <policy domain="resource" name="width" value="32KP"/>
+  <policy domain="resource" name="height" value="32KP"/>
   <!-- <policy domain="resource" name="list-length" value="128"/> -->
-  <policy domain="resource" name="area" value="128MP"/>
-  <policy domain="resource" name="disk" value="1GiB"/>
+  <policy domain="resource" name="area" value="1024MP"/>
+  <policy domain="resource" name="disk" value="10GiB"/>
   <!-- <policy domain="resource" name="file" value="768"/> -->
   <!-- <policy domain="resource" name="thread" value="4"/> -->
   <!-- <policy domain="resource" name="throttle" value="0"/> -->

The conversion can now take place, using MAGICK_CONFIGURE_PATH to set the location of the temporary policy.xml file:

$ MAGICK_CONFIGURE_PATH=. convert -verbose image.ppm hires.png
image.ppm PPM 20480x15360 20480x15360+0+0 8-bit sRGB 2.68126GiB 18.050u 0:18.058
image.ppm=>hires.png PPM 20480x15360 20480x15360+0+0 8-bit sRGB 21.1562MiB 13.000u 0:10.258

About

Personal attempt at The Ray Tracer Challenge, using Rust 2021. Commenced April 2023...

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published