Skip to content

Commit

Permalink
doc: update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hanatos committed Jan 13, 2025
1 parent f668450 commit 26da0cc
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 5 deletions.
4 changes: 1 addition & 3 deletions doc/howto/colour-display/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ shaper curve.

## gui
all gui colours need to be given in rec2020 tristimulus values.
`gui/render.cc` has a function to convert user/theme supplied
srgb values to linear rec2020.

## thumbnails
bc1 thumbnails are stored in gamma/sRGB. they are loaded as
Expand All @@ -66,6 +64,6 @@ will be rendered at that precision (all our internal buffers
have higher precision).

## cli
the command line interface explicitly inserts `f2srgb` nodes before
the command line interface explicitly inserts `colenc` nodes before
the `o-*` nodes if the output format requires gamma encoding,
such as jpeg.
6 changes: 6 additions & 0 deletions src/pipe/modules/colenc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ possible choices for the trc are: `linear`, `709` (SMPTE RP 431-2),
`sRGB` (IEC 61966-2-1), `PQ` (SMPTE ST 2084), `DCI` (SMPTE ST 428-1),
`HLG` (Rec. ITU-R BT.2100-1), and `gamma`.

if you are looking for the reverse operation, colour decoding, the [`colour`
module](../colour/readme.md) is probably what you need. it will pick up the
primaries and trc from metadata that travels with the buffers.
some input modules such as the [`i-exr` module](../i-exr/readme.md) allow you
to overwrite these annotations.

## connectors

* `input` scene referred linear rec2020
Expand Down
2 changes: 2 additions & 0 deletions src/pipe/modules/i-pfm/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ point maps. does not flip y coordinate.

* `filename` the name of the input file, potentially containing %04d for sequences
* `startid` the index of the first file if loading a sequence
* `noise a` the gaussian part of the noise estimation
* `noise b` the poissonian part of the noise estimation

## connectors

Expand Down
4 changes: 2 additions & 2 deletions src/pipe/modules/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ also see the [list of presets shipped with vkdt](../../../doc/howto/presets/pres
* [i-lut: half float lut input module](./i-lut/readme.md)
* [i-mcraw: read motioncam raw video](./i-mcraw/readme.md)
* [i-mlv: magic lantern raw video input module](./i-mlv/readme.md)
* [i-obj: load triangle meshes from wavefront obj files](./i-obj/readme.md)
* [i-pfm: 32-bit floating point map input module](./i-pfm/readme.md)
* [i-raw: input module for raw-format photographic stills or timelapses](./i-raw/readme.md)
* [i-v4l2: webcam input module](./i-v4l2/readme.md)
Expand Down Expand Up @@ -57,6 +58,7 @@ also see the [list of presets shipped with vkdt](../../../doc/howto/presets/pres

**colour processing**

* [colenc: encode colour for colour managed output like adobeRGB, P3, etc](./colenc/readme.md)
* [colour: generic colour manipulation/input transform](./colour/readme.md)
* [grade: simple ACES CDL grading tool](./grade/readme.md)

Expand Down Expand Up @@ -101,7 +103,6 @@ also see the [list of presets shipped with vkdt](../../../doc/howto/presets/pres
* [align: align animation frames or burst photographs](./align/readme.md)
* [blend: masked frame blending](./blend/readme.md)
* [cnngenin: generate random input for neural network training](./cnngenin/readme.md)
* [colenc: encode colour for colour managed output like adobeRGB, P3, etc](./colenc/readme.md)
* [format: change texture format (number of channels and data type)](./format/readme.md)
* [f2srgb: convert linear floating point data to 8-bit sRGB for output](./f2srgb/readme.md)
* [kpn-t: kernel prediction neural network for denoising, training](./kpn-t/readme.md)
Expand All @@ -114,7 +115,6 @@ also see the [list of presets shipped with vkdt](../../../doc/howto/presets/pres

* [accum: accumulate frames in a frame buffer](./accum/readme.md)
* [bvh: append triangle mesh to ray tracing acceleration structure](./bvh/readme.md)
* [i-obj: load triangle meshes from wavefront obj files](./i-obj/readme.md)
* [logo: render the animated vkdt icon](./logo/readme.md)
* [quake: the 1996 game ray traced based on QSS](./quake/readme.md)
* [rt: real-time ray tracing](./rt/readme.md)
Expand Down

0 comments on commit 26da0cc

Please sign in to comment.