summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSakarias Johansson <sakarias.johansson@goodbyekansas.com>2023-03-13 22:00:44 +0100
committerSakarias Johansson <sakarias.johansson@goodbyekansas.com>2023-03-13 22:23:18 +0100
commitf19c8cc40c5caf8abb4f04aaf9f91ec3a8c1ccbc (patch)
treea54a074ece82eafd8793cd0fb68a1b938286c923 /README.md
parent3cabf77da8b9681ed9683fe92c23054d6f49d848 (diff)
downloadracer-tracer-f19c8cc40c5caf8abb4f04aaf9f91ec3a8c1ccbc.tar.gz
racer-tracer-f19c8cc40c5caf8abb4f04aaf9f91ec3a8c1ccbc.tar.xz
racer-tracer-f19c8cc40c5caf8abb4f04aaf9f91ec3a8c1ccbc.zip
📸 Add Camera defocus blur + Other
Just wanted to add defocus blur but ended up changing a bunch of other this as well. - Moved scenes to a separate folder. - Updated readme with more pretty images. - Add interface for loading scenes. There is currently one for yaml and another if you want a slightly random scene. - Add image action to decide what to do with the final image once its rendered. Currently supports just showing the buffer until you press the render buffer again and saving the image as `png`. - When you use nix shell you will be dropped in the proper folder so you can just do cargo build etc without having to do `cd`.
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index b716c16..efbbeef 100644
--- a/README.md
+++ b/README.md
@@ -25,14 +25,44 @@ crate to work.
# Running
The application accepts the following arguments.
`--config` path to the config file.
-`--scene` path to the scene file.
+`--scene` path to the scene file (only supports yml).
+`--image-action` (png, show).
+ Png saves the resulting image to `image_output_dir`.
+ Show just stops the rendering once its done and waits
+ for you to press `R` again to continue with the real-time render.
+
Just running it without any arguments will use the default config and
scene provided by this repository. Once the application starts it will
present a crude preview image of the scene.
+![preview](./assets/preview.png)
+
+## Configuration
+The configuration file has two blocks that controls the preview
+quality and the render quality. You can set the number of samples,
+max_depth etc through threre.
## Controls
`WASD` Moves the camera in a currently crude way.
`R` Starts rendering the image.
+## Rendering Progress
+As you start rendering the image it will replace preview image with a
+more refined one with the settings from the render block in your
+configuration file.
+
+![preview](./assets/preview.png)
+
+
+![in_progress](./assets/in_progress.png)
+
+
+![in_progress2](./assets/in_progress_2.png)
+
+
+![sample](./assets/trace_sample.png)
+
+
+Once the image is done rendering it will go forward with the selected
+image action.