summaryrefslogtreecommitdiff
path: root/vendor/exr/examples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/exr/examples/README.md')
-rw-r--r--vendor/exr/examples/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/vendor/exr/examples/README.md b/vendor/exr/examples/README.md
new file mode 100644
index 0000000..7e9453e
--- /dev/null
+++ b/vendor/exr/examples/README.md
@@ -0,0 +1,24 @@
+# Examples
+
+These are examples that demonstrate how to use `exrs`.
+
+Some of these examples read image files
+that can be generated by running a different example beforehand.
+The examples are named such that running all examples alphabetically
+will generate any image before it is used.
+
+Only the cropping examples use images from the source repository's test folder.
+
+## Things you can find in the examples:
+- Read image data into a custom data structure, without loosing any meta information:
+ `2_rgba_adjust_exposure`
+- Access all pixel information in a file, fully dynamic:
+ `6_extract_mip_map_pngs`
+
+
+## Older Versions
+The examples for any specific `exrs` version can be found on the `docs.rs` page:
+- [docs.rs/crate/exr/1.71.0/source/examples/](https://docs.rs/crate/exr/1.7.0/source/examples/)
+- [docs.rs/crate/exr/1.7.0/source/examples/](https://docs.rs/crate/exr/1.7.0/source/examples/)
+- [docs.rs/crate/exr/1.6.5/source/examples/](https://docs.rs/crate/exr/1.6.5/source/examples/)
+- ... \ No newline at end of file