Blender: Denoiser Class Reference

Blender V5.0

#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, RenderBuffers *render_buffers, const int num_samples, bool allow_inplace_modification)=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 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)
virtual uint	get_device_type_mask () const =0

Protected Attributes
Device *	denoiser_device_
bool	denoise_kernels_are_loaded_
DenoiseParams	params_

Detailed Description

Definition at line 40 of file denoiser.h.

Constructor & Destructor Documentation

◆ ~Denoiser()

virtual Denoiser::~Denoiser ( )

virtualdefault

References params.

◆ Denoiser()

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

protected

Definition at line 211 of file denoiser.cpp.

References DCHECK, denoise_kernels_are_loaded_, denoiser_device_, false, params, and params_.

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

Member Function Documentation

◆ automatic_viewport_denoiser_type()

DenoiserType Denoiser::automatic_viewport_denoiser_type ( const DeviceInfo & denoise_device_info )

static

Definition at line 184 of file denoiser.cpp.

References DENOISER_NONE, DENOISER_OPENIMAGEDENOISE, DENOISER_OPTIX, DEVICE_CPU, openimagedenoise_supported(), and DeviceInfo::type.

Referenced by BlenderSync::get_denoise_params().

◆ create()

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

static

Definition at line 148 of file denoiser.cpp.

References DEVICE_CPU, get_effective_denoise_params(), Device::info, openimagedenoise_supported(), params, DeviceInfo::type, use_gpu_oidn_denoiser(), and use_optix_denoiser().

Referenced by DenoiserPipeline::DenoiserPipeline(), and PathTrace::set_denoiser_params().

◆ denoise_buffer()

virtual bool Denoiser::denoise_buffer	(	const BufferParams &	buffer_params,
		RenderBuffers *	render_buffers,
		const int	num_samples,
		bool	allow_inplace_modification )

pure virtual

Implemented in DenoiserGPU, and OIDNDenoiser.

◆ get_denoiser_device()

Device * Denoiser::get_denoiser_device ( ) const

Definition at line 268 of file denoiser.cpp.

References denoiser_device_.

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

◆ get_device_type_mask()

virtual uint Denoiser::get_device_type_mask ( ) const

protectedpure virtual

Implemented in OIDNDenoiser.

◆ get_params()

const DenoiseParams & Denoiser::get_params ( ) const

Definition at line 230 of file denoiser.cpp.

References params_.

Referenced by denoiser_device_report().

◆ is_cancelled()

bool Denoiser::is_cancelled ( ) const

inline

Definition at line 111 of file denoiser.h.

References is_cancelled_cb.

Referenced by OIDNDenoiser::denoise_buffer().

◆ load_kernels()

bool Denoiser::load_kernels ( Progress * progress )

virtual

Definition at line 235 of file denoiser.cpp.

References denoise_kernels_are_loaded_, denoiser_device_, KERNEL_FEATURE_DENOISING, LOG_DEBUG, set_error(), and Progress::set_status().

◆ set_error()

void Denoiser::set_error ( const string & error )

inline

Definition at line 119 of file denoiser.h.

References denoiser_device_, and error().

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

◆ set_params()

void Denoiser::set_params ( const DenoiseParams & params )

Definition at line 218 of file denoiser.cpp.

References DCHECK_EQ, LOG_ERROR, params, and params_.

Member Data Documentation

◆ denoise_kernels_are_loaded_

bool Denoiser::denoise_kernels_are_loaded_

protected

Definition at line 132 of file denoiser.h.

Referenced by Denoiser(), and load_kernels().

◆ denoiser_device_

Device* Denoiser::denoiser_device_

protected

Definition at line 131 of file denoiser.h.

Referenced by DenoiserGPU::denoise_buffer(), Denoiser(), get_denoiser_device(), load_kernels(), and set_error().

◆ is_cancelled_cb

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

Definition at line 109 of file denoiser.h.

Referenced by is_cancelled().

◆ params_

DenoiseParams Denoiser::params_

protected

Definition at line 133 of file denoiser.h.

Referenced by DenoiserGPU::denoise_buffer(), OIDNDenoiser::denoise_buffer(), Denoiser(), get_params(), and set_params().

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