ocio 0.2.2

A pure Rust port of OpenColorIO, the color management framework for visual effects and animation.
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

//! # ocio
//!
//! A pure Rust port of [OpenColorIO](https://opencolorio.org), the color
//! management framework for visual effects and animation.
//!
//! ```no_run
//! use ocio::Config;
//!
//! let config = Config::create_from_file("config.ocio").unwrap();
//! let processor = config.get_processor("ACEScg", "sRGB - Display").unwrap();
//! let cpu = processor.default_cpu_processor();
//! let mut pixel = [0.18f32, 0.18, 0.18];
//! cpu.apply_rgb(&mut pixel);
//! ```

// Lints that conflict with a faithful port of the C++ numerics: float
// literals are kept exactly as in OCIO, index loops mirror the original
// code, and negated comparisons preserve the NaN semantics of the C++.
#![allow(
    clippy::excessive_precision,
    clippy::needless_range_loop,
    clippy::neg_cmp_op_on_partial_ord,
    clippy::too_many_arguments,
    clippy::field_reassign_with_default,
    clippy::manual_clamp,
    clippy::neg_multiply,
    clippy::nonminimal_bool,
    clippy::enum_variant_names,
    clippy::blocks_in_conditions,
    clippy::redundant_closure_call,
    clippy::wrong_self_convention,
    clippy::ptr_arg
)]
#![cfg_attr(test, allow(clippy::approx_constant))]
#![warn(missing_docs)]

pub mod apphelpers;
pub mod baker;
pub mod builtins;
pub mod config;
pub mod context;
pub mod dynamic_property;
pub mod error;
pub mod fileformats;
pub mod format_metadata;
pub mod gpu;
pub mod hash_utils;
pub mod image_desc;
pub mod math_utils;
pub mod ops;
pub mod path_utils;
pub mod processor;
pub mod transforms;
pub mod types;

pub use baker::Baker;
pub use config::Config;
pub use context::Context;
pub use dynamic_property::{DynamicProperty, SharedValue};
pub use error::{Error, Result};
pub use format_metadata::FormatMetadata;
pub use image_desc::{ImageData, ImageDesc, PackedImageDesc, PlanarImageDesc};
pub use processor::{CpuProcessor, Processor, ProcessorMetadata};
pub use transforms::grading::*;
pub use transforms::*;
pub use types::*;

/// Clear all the caches of the library (port of `ClearAllCaches`): the file
/// transform cache (files are read again on the next use).
pub fn clear_all_caches() {
    fileformats::file_transform::clear_file_transform_caches();
}

/// Library version: the latest OCIO release fully covered by this port
/// (see `UPSTREAM.md`).
pub const OCIO_VERSION: &str = "2.5.2";
/// Version of this crate.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Whether the test fixture `tests/data/files/<name>` exists. The largest
/// fixtures are listed under `[package] exclude` in `Cargo.toml` to keep the
/// published crate small, so the tests using them skip when it is missing.
#[cfg(test)]
pub(crate) fn test_fixture_present(name: &str) -> bool {
    let path = format!("{}/tests/data/files/{name}", env!("CARGO_MANIFEST_DIR"));
    let present = std::path::Path::new(&path).exists();
    if !present {
        eprintln!("skipped: tests/data/files/{name} is not in the published crate");
    }
    present
}