Raytrace is a CPU-based ray tracing project implemented in Rust. This project serves as both a hands-on experiment to deepen my understanding of ray tracing concepts and a personal exploration of the Rust programming language.
The ray tracing techniques and concepts used in this project are inspired by a three-part book series on implementing ray tracing with C++. https://raytracing.github.io/
$ raytrace --help
Usage: raytrace [OPTIONS] --config <CONFIG>
Options:
-c, --config <CONFIG> Path of toml configuration file
-o, --output <OUTPUT> Path of file to save the render to [default: render.png]
-s, --samples <SAMPLES> Directly override the sample count listed in the configuration file
-h, --help Print help
-V, --version Print version
$ raytrace --config examples/basic/render.toml --output render.png
┌─── Render Settings ────────────────────────────────────────────────────────────┐
│ Dimensions: 600x337 │
│ Aspect Ratio: 16:9 │
│ Samples: 300 │
│ Max Bounces: 64 │
│ Threads: 11 │
│ Field of View: 20 │
│ Look From: [13 , 2 , 3 ] │
│ Look At: [0 , 0 , 0 ] │
│ Vup: [0 , 1 , 0 ] │
│ Defocus Angle: 0.6 │
│Focus Distance: 10 │
│ Objects: 487 │
└────────────────────────────────────────────────────────────────────────────────┘
Rendering: 100% (202200/202200) 3sThe camera settings define how the scene is viewed and rendered. Below are the parameters that control the camera's behavior:
[camera]
aspect_ratio = "square"
image_width = 600
samples = 10000
threads = 8
max_bounces = 64
fov = 40
look_from = [278.0, 278.0, -800.0]
look_at = [278.0, 278.0, 0.0]
vup = [0.0, 1.0, 0.0]
background = [0.70, 0.80, 0.99]
defocus_angle = 0.6
focus_dist = 10.0aspect_ratio: Specifies the aspect ration of the rendered image.widescreen(16:9)square(1:1)smartphone(9:16)standard(4:3)cinema(1.85:1)
image_width: The width of the rendered image.samples: The number of samples per pixel, controlling the quality of the image.threads: Determines how many CPU threads will be utilized during the rendering process, allowing for parallel computation to speed up the rendering. (Defaults to the n-1 number of cores on your machine)max_bounces: Limits the number of light bounces for each ray.fov: The camera's field of view in degrees.look_from: The coordinates from which the camera views the scene.look_at: The point the camera is focused on.vup: Defines the camera's orientation. (Defaults to the[0.0, 1.0, 0.0]where y positive is "up")background: Set the rgb values for default color when a ray misses hitting an object. (Defaults to black[0.0, 0.0, 0.0])defocus_angle: Variation angle of rays through each pixel (Defaults to being disabled)focus_dist: Distance from camera lookfrom point to plane of perfect focus (Defaults to being disabled)
A scene consists of various objects, which are represented with combination of "material" and "geometry" and can be configured using adding items to the list of "objects".
[[objects]]
shape = "sphere"
position = [0.0, 2.2, 0.0]
radius = 1.5position: The coordinates of the sphere's center.radius: The radius of the sphere.
[[objects]]
shape = "quad"
position = [2.0, 2.2, 2.0]
u = [-4.0, 0.0, 0.0]
v = [0.0, 0.0, -4.0]position: The origin point of the quad.u: The vector defining one side of the quad.v: The vector defining the adjacent side of the quad.
[[objects]]
shape = "cube"
a = [-1.0, -1.0, -1.0]
b = [1.0, 1.0, 1.0]a: The first corner of the cube (usually the minimum coordinate).b: The opposite corner (usually the maximum coordinate).
[[objects]]
shape = "triangle"
a = [2.0, 0.0, 2.0]
b = [2.0, 0.0, -2.0]
c = [-2.0, 0.0, 0.0]a: The first verticesb: The second verticesc: The third vertices
[[objects]]
shape = "wavefront"
file = "teapot.obj"file: Path to the.objfile (relative to config location)group: Optional name of the specific "group" to load from the.objfile.
Materials define the visual properties of the objects. Below are the supported material types and their configurations in the TOML file.
[[objects]]
material = "lambertian"
albedo = [1.0, 0.2, 0.3] # redalbedo: The diffuse reflection color as an RGB array.
[[objects]]
material = "checkered"
even = [0.2, 0.3, 0.1] # light green
odd = [0.9, 0.9, 0.9] # white
scale = 0.2even: The color of the even checkered squares.odd: The color of the odd checkered squares.scale: Scaling factor to adjust the size of the checkered pattern.
[[objects]]
material = "texture"
file = "path/to/texture.png"file: Path to the texture file (relative to config location)
[[objects]]
material = "noise"
scale = 0.2
turbulance = 7scale: Controls the frequency of the noise pattern.turbulence: Level of turbulence in the noise.
[[objects]]
material = "metal"
albedo = [0.7, 0.7, 0.7]
roughness = 0.13albedo: The reflective color of the metal.roughness: Controls the scattering of reflected light. (The higher more the more scattering)
[[objects]]
material = "dielectric"
refraction_index = 1.5refraction_index: The index of refraction for the material.
[[objects]]
material = "glass"This is a dielectric of with an index of refraction of 1.5
[[objects]]
material = "water"This is a dielectric of with an index of refraction of 1.33
[[objects]]
material = "light"
emit = [7.0, 7.0, 7.0]emit: The RGB color of the emitted light.