Struct RtFilter 

pub struct RtFilter<'a> { /* private fields */ }

Ray tracing denoising filter (OIDN “RT” filter).

Denoises a beauty (color) image, optionally using albedo and normal AOVs. Reuse the same filter for multiple frames when dimensions match.

Implementations

impl<'a> RtFilter<'a>

pub fn new(device: &'a OidnDevice) -> Result<Self, Error>

Creates a new RT filter. Reuse the same filter for multiple frames when dimensions match.

Errors

Returns Error::FilterCreationFailed if the RT filter type is not available, or the device’s last error (e.g. Error::OidnError).

pub fn set_dimensions(&mut self, width: u32, height: u32) -> &mut Self

Image dimensions (must be set before execute).

pub fn set_hdr(&mut self, hdr: bool) -> &mut Self

Whether the input is HDR. Default: true.

pub fn set_srgb(&mut self, srgb: bool) -> &mut Self

Whether the input is sRGB (LDR). Default: false.

pub fn set_clean_aux(&mut self, clean: bool) -> &mut Self

Whether albedo/normal are noise-free (prefiltered). Default: false.

pub fn set_input_scale(&mut self, scale: f32) -> &mut Self

Input scale (e.g. for HDR). NaN = auto.

pub fn set_quality(&mut self, quality: Quality) -> &mut Self

Filter quality. Default: High.

pub fn get_bool(&self, name: &str) -> bool

Gets a boolean filter parameter (e.g. "hdr", "srgb").

pub fn get_int(&self, name: &str) -> i32

Gets an integer filter parameter (e.g. "quality").

pub fn get_float(&self, name: &str) -> f32

Gets a float filter parameter (e.g. "inputScale").

pub unsafe fn set_progress_monitor_raw( &self, func: Option<unsafe extern "C" fn(user_ptr: *mut c_void, n: f64) -> bool>, user_ptr: *mut c_void, )

Sets the progress monitor callback. Callback receives progress in [0,1]; return false to cancel. Safe to call with (None, null) to clear. Callback must not panic.

pub fn execute_in_place(&self, color: &mut [f32]) -> Result<(), Error>

Denoises color in-place. color must be width * height * 3 floats (RGB).

Errors

Returns Error::InvalidDimensions if dimensions are unset or buffer sizes do not match, or an OIDN error from the device.

pub fn execute_in_place_with_aux( &self, color: &mut [f32], albedo: Option<&[f32]>, normal: Option<&[f32]>, ) -> Result<(), Error>

Denoises color in-place with optional albedo and normal AOVs (each width * height * 3 floats).

pub fn execute( &self, color: Option<&[f32]>, output: &mut [f32], ) -> Result<(), Error>

Denoises color into output. Slices must be width * height * 3 floats (RGB).

pub fn execute_with_aux( &self, color: Option<&[f32]>, output: &mut [f32], albedo: Option<&[f32]>, normal: Option<&[f32]>, ) -> Result<(), Error>

Denoises color into output with optional albedo and normal AOVs (each width * height * 3 floats).

Trait Implementations

impl Debug for RtFilter<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RtFilter<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for RtFilter<'_>