oidn

Crates.iooidn
lib.rsoidn
version2.2.4
sourcesrc
created_at2019-02-09 23:42:22.957474
updated_at2024-08-31 22:23:58.006393
descriptionA wrapper for the Intel OpenImageDenoise image denoising library.
homepagehttps://github.com/Twinklebear/oidn-rs
repositoryhttps://github.com/Twinklebear/oidn-rs
max_upload_size
id113832
size41,744
Will Usher (Twinklebear)

documentation

https://docs.rs/oidn

README

oidn

Crates.io CI

Rust bindings to Intel’s Open Image Denoise library.

Documentation

Rust docs can be found here.

Open Image Denoise documentation can be found here.

Example

The crate provides a lightweight wrapper over the Open Image Denoise library, along with raw C bindings exposed under oidn::sys. Below is an example of using the RT filter from Open Image Denoise (the RayTracing filter) to denoise an image.

extern crate oidn;

fn main() {
    // Load scene, render image, etc.

    let input_img: Vec<f32> = // A float3 RGB image produced by your renderer
    let mut filter_output = vec![0.0f32; input_img.len()];

    let device = oidn::Device::new();
    oidn::RayTracing::new(&device)
        // Optionally add float3 normal and albedo buffers as well
        .srgb(true)
        .image_dimensions(input.width() as usize, input.height() as usize);
        .filter(&input_img[..], &mut filter_output[..])
        .expect("Filter config error!");

    if let Err(e) = device.get_error() {
        println!("Error denosing image: {}", e.1);
    }

    // Save out or display filter_output image
}

The simple example loads a JPG, denoises it, and saves the output image to a JPG. The denoise_exr example loads an HDR color EXR file, denoises it and saves the tonemapped result out to a JPG. The denoise_exr app can also take albedo and normal data through additional EXR files.

Commit count: 75

cargo fmt