The settings passed to the VRayRenderer::setVRayProfiler() interface. More...

#include <vraysdk.hpp>

Public Types
enum	FileType : int { FileType_HTML =0 , FileType_JSON }

enum class	Mode { Off = 0 , Simple , Full , Process }

Public Attributes
std::string	htmlTemplatePath
	The full path to the profiler html template. If this is left empty, the default location will be searched.

int	maxDepth
	The maximum ray bounces that will be profiled. Range [1, 8].

Mode	mode
	Specifies the operational mode of the Profiler.

std::string	outputDirectory
	The directory where the profiler reports will be created. If nullptr is passed, temp directory is used.

std::string	productName
	Name of the host product.

std::string	productVersion
	Version of the host product.

std::string	sceneName
	Name of the scene that will be profiled. Used as a suffix to the generated filename.

Detailed Description

The settings passed to the VRayRenderer::setVRayProfiler() interface.

Member Enumeration Documentation

Possible output file types from the V-Ray profiler. They are not currently set directly, but the values are used by the OnVRayProfilerWrite callback.

Enumerator
FileType_HTML	An html output file. Needs a valid htmlTemplatePath or valid installation of the default path.
FileType_JSON	This is the raw profiler output, which is passed when an HTML file could not be generated.

strong

Enumerator
Off	No profiling.
Simple	Do not use, this mode will be mapped to Full mode.
Full	Profile the whole rendering process.
Process	Only profile the PREPARING state (e.g., plugin initialization, geometry compilation, etc).

The documentation for this struct was generated from the following file: