exr 0.9.0

Read and write OpenEXR files without any unsafe code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96



//! Read and write OpenEXR images.
//! This library uses no foreign code or unsafe Rust.
//!
//! See the [README.md](https://github.com/johannesvollmer/exrs/blob/master/README.md) for more information,
//! or check out the [examples](https://github.com/johannesvollmer/exrs/tree/master/examples).

#![warn(
    rust_2018_idioms,
    future_incompatible,
    unused_extern_crates,
    unused,

    missing_copy_implementations,
    missing_debug_implementations,

    clippy::all,
    clippy::restriction,
    clippy::pedantic,
    clippy::nursery,
    clippy::cargo,
)]

#![deny(
    unused_variables,
    unused_assignments,
    dead_code,
    unused_must_use,
    missing_copy_implementations,
    trivial_numeric_casts,
    redundant_semicolons
)]

#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod io; // public to allow for custom attribute byte parsing

pub mod math;
pub mod compression;
pub mod meta;
pub mod image;

pub mod error;
pub mod block;

#[macro_use]
extern crate smallvec;


/// Use either `exr::prelude::rgba_image::*` or `exr::prelude::simple_image::*` for simply reading an image.
pub mod prelude {

    /// Re-exports of all common elements needed for reading or writing an `exrs::image::rgba`.
    pub mod rgba_image {
        pub use super::common::*;
        pub use crate::image::rgba::*;
    }

    /// Re-exports of all common elements needed for reading or writing an `exrs::image::simple`.
    pub mod simple_image {
        pub use super::common::*;
        pub use crate::image::simple::*;
    }

    // TODO
    #[doc(hidden)]
    mod full {
        pub use super::common::*;
        pub use crate::image::full::*;
    }

    /// Exports of all modules types commonly required for reading and writing of an exr image.
    /// Use either `exr::prelude::rgba_image::*` or `exr::prelude::simple_image::*` for reading an image.
    /// _Note: This includes a type called `Result`, possibly overwriting the default `std::Result` type usage._
    pub mod common {
        pub use crate::meta::{self, MetaData, attribute, header::{LayerAttributes, ImageAttributes } };
        pub use crate::meta::attribute::{ AttributeValue, Compression, Text, IntegerBounds, LineOrder, SampleType, TileDescription };
        pub use crate::error::{ Result, Error };
        pub use crate::math::Vec2;

        pub use crate::image::{
            write_options, read_options,
            WriteOptions, ReadOptions
        };

        // re-export external stuff
        pub use half::f16;
        pub use smallvec::SmallVec;
        pub use std::convert::TryInto;
    }
}