Blender V5.3
Denoiser Class Referenceabstract

#include <denoiser.h>

Inherited by DenoiserGPU, and OIDNDenoiser.

Public Member Functions

virtual ~Denoiser ()=default
void set_params (const DenoiseParams &params)
const DenoiseParams & get_params () const
virtual bool load_kernels (Progress *progress)
virtual bool denoise_buffer (const BufferParams &buffer_params, const BufferParams &denoised_buffer_params, RenderBuffers *render_buffers, int num_samples, bool allow_inplace_modification, float2 pixel_jitter={})=0
Device * get_denoiser_device () const
bool is_cancelled () const
void set_error (const string &error)

Static Public Member Functions

static unique_ptr< Denoiser > create (Device *denoiser_device, Device *cpu_fallback_device, const DenoiseParams &params, const GraphicsInteropDevice &interop_device)
static bool is_device_supported (DenoiserType type, const DeviceInfo &denoise_device_info)
static DenoiserType automatic_viewport_denoiser_type (const DeviceInfo &denoise_device_info)

Public Attributes

std::function< bool(void)> is_cancelled_cb

Protected Member Functions

 Denoiser (Device *denoiser_device, const DenoiseParams &params)

Protected Attributes

Device * denoiser_device_
bool denoise_kernels_are_loaded_
DenoiseParams params_

Detailed Description

Definition at line 42 of file denoiser.h.

Constructor & Destructor Documentation

◆ ~Denoiser()

virtual Denoiser::~Denoiser ( )
virtualdefault

◆ Denoiser()

Denoiser::Denoiser ( Device * denoiser_device,
const DenoiseParams & params )
protected

Member Function Documentation

◆ automatic_viewport_denoiser_type()

DenoiserType Denoiser::automatic_viewport_denoiser_type ( const DeviceInfo & denoise_device_info)
static

◆ create()

unique_ptr< Denoiser > Denoiser::create ( Device * denoiser_device,
Device * cpu_fallback_device,
const DenoiseParams & params,
const GraphicsInteropDevice & interop_device )
static

◆ denoise_buffer()

virtual bool Denoiser::denoise_buffer ( const BufferParams & buffer_params,
const BufferParams & denoised_buffer_params,
RenderBuffers * render_buffers,
int num_samples,
bool allow_inplace_modification,
float2 pixel_jitter = {} )
pure virtual

Implemented in DenoiserGPU, and OIDNDenoiser.

◆ get_denoiser_device()

Device * Denoiser::get_denoiser_device ( ) const

Definition at line 309 of file denoiser.cpp.

References denoiser_device_.

Referenced by DenoiserGPU::denoise_buffer(), and denoiser_device_report().

◆ get_params()

const DenoiseParams & Denoiser::get_params ( ) const

Definition at line 271 of file denoiser.cpp.

References params_.

Referenced by denoiser_device_report(), and ~Denoiser().

◆ is_cancelled()

bool Denoiser::is_cancelled ( ) const
inline

Definition at line 117 of file denoiser.h.

References is_cancelled_cb.

Referenced by OIDNDenoiser::denoise_buffer().

◆ is_device_supported()

bool Denoiser::is_device_supported ( DenoiserType type,
const DeviceInfo & denoise_device_info )
static

Definition at line 205 of file denoiser.cpp.

References DENOISER_DLSS, DENOISER_OPENIMAGEDENOISE, and DENOISER_OPTIX.

Referenced by BlenderSync::get_denoise_params(), and ~Denoiser().

◆ load_kernels()

◆ set_error()

void Denoiser::set_error ( const string & error)
inline

Definition at line 125 of file denoiser.h.

References denoiser_device_, and Device::set_error().

Referenced by load_kernels(), and OIDNDenoiser::OIDNDenoiser().

◆ set_params()

void Denoiser::set_params ( const DenoiseParams & params)

Definition at line 259 of file denoiser.cpp.

References DCHECK_EQ, LOG_ERROR, params_, and DenoiseParams::type.

Referenced by ~Denoiser().

Member Data Documentation

◆ denoise_kernels_are_loaded_

bool Denoiser::denoise_kernels_are_loaded_
protected

Definition at line 134 of file denoiser.h.

Referenced by Denoiser(), and load_kernels().

◆ denoiser_device_

Device* Denoiser::denoiser_device_
protected

Definition at line 133 of file denoiser.h.

Referenced by Denoiser(), get_denoiser_device(), load_kernels(), and set_error().

◆ is_cancelled_cb

std::function<bool(void)> Denoiser::is_cancelled_cb

Definition at line 115 of file denoiser.h.

Referenced by is_cancelled().

◆ params_


The documentation for this class was generated from the following files: