VRay::Plugins::SettingsRTEngine Class Reference

Settings for V-Ray Interactive and V-Ray GPU Interactive/Production. [gpuSupport=(partial)]. More...

#include <vrayplugins.hpp>

Inheritance diagram for VRay::Plugins::SettingsRTEngine:

Public Member Functions
bool	get_coherent_tracing (double time=TiMe::Default()) const
int	get_cpu_bundle_size (double time=TiMe::Default()) const
int	get_cpu_samples_per_pixel (double time=TiMe::Default()) const
bool	get_disable_auto_rpp (double time=TiMe::Default()) const
bool	get_disable_render_elements (double time=TiMe::Default()) const
int	get_enable_bucket_sampler (double time=TiMe::Default()) const
int	get_gi_depth (double time=TiMe::Default()) const
int	get_gpu_bundle_size (double time=TiMe::Default()) const
int	get_gpu_samples_per_pixel (double time=TiMe::Default()) const
int	get_interactive (double time=TiMe::Default()) const
bool	get_low_gpu_thread_priority (double time=TiMe::Default()) const
int	get_max_draw_interval (double time=TiMe::Default()) const
float	get_max_render_time (double time=TiMe::Default()) const
int	get_max_sample_level (double time=TiMe::Default()) const
int	get_min_draw_interval (double time=TiMe::Default()) const
float	get_noise_threshold (double time=TiMe::Default()) const
int	get_opencl_resizeTextures (double time=TiMe::Default()) const
int	get_opencl_texsize (double time=TiMe::Default()) const
int	get_opencl_textureFormat (double time=TiMe::Default()) const
bool	get_out_of_core (double time=TiMe::Default()) const
bool	get_out_of_core_textures (double time=TiMe::Default()) const
int	get_out_of_core_textures_threshold (double time=TiMe::Default()) const
bool	get_progressive_samples_per_pixel (double time=TiMe::Default()) const
float	get_stereo_eye_distance (double time=TiMe::Default()) const
int	get_stereo_focus (double time=TiMe::Default()) const
bool	get_stereo_mode (double time=TiMe::Default()) const
int	get_trace_depth (double time=TiMe::Default()) const
int	get_undersampling (double time=TiMe::Default()) const
	operator SettingsPluginCategory ()
bool	set_coherent_tracing (bool val, double time=TiMe::Default())
bool	set_cpu_bundle_size (int val, double time=TiMe::Default())
bool	set_cpu_samples_per_pixel (int val, double time=TiMe::Default())
bool	set_disable_auto_rpp (bool val, double time=TiMe::Default())
bool	set_disable_render_elements (bool val, double time=TiMe::Default())
bool	set_enable_bucket_sampler (int val, double time=TiMe::Default())
bool	set_gi_depth (int val, double time=TiMe::Default())
bool	set_gpu_bundle_size (int val, double time=TiMe::Default())
bool	set_gpu_samples_per_pixel (int val, double time=TiMe::Default())
bool	set_interactive (int val, double time=TiMe::Default())
bool	set_low_gpu_thread_priority (bool val, double time=TiMe::Default())
bool	set_max_draw_interval (int val, double time=TiMe::Default())
bool	set_max_render_time (float val, double time=TiMe::Default())
bool	set_max_sample_level (int val, double time=TiMe::Default())
bool	set_min_draw_interval (int val, double time=TiMe::Default())
bool	set_noise_threshold (float val, double time=TiMe::Default())
bool	set_opencl_resizeTextures (int val, double time=TiMe::Default())
bool	set_opencl_texsize (int val, double time=TiMe::Default())
bool	set_opencl_textureFormat (int val, double time=TiMe::Default())
bool	set_out_of_core (bool val, double time=TiMe::Default())
bool	set_out_of_core_textures (bool val, double time=TiMe::Default())
bool	set_out_of_core_textures_threshold (int val, double time=TiMe::Default())
bool	set_progressive_samples_per_pixel (bool val, double time=TiMe::Default())
bool	set_stereo_eye_distance (float val, double time=TiMe::Default())
bool	set_stereo_focus (int val, double time=TiMe::Default())
bool	set_stereo_mode (bool val, double time=TiMe::Default())
bool	set_trace_depth (int val, double time=TiMe::Default())
bool	set_undersampling (int val, double time=TiMe::Default())
Public Member Functions inherited from VRay::Plugin
	Plugin () noexcept
	Default construct an invalid Plugin - not referencing a V-Ray scene object.
	Plugin (const Plugin &plugin) noexcept
	Copy construct from another Plugin. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
AColor	getAColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
AColor	getAColor (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as AColor.
AColor	getAColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
AColor	getAColor (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	getBool (const char *propertyName, bool &ok, double time=TiMe::Default()) const
bool	getBool (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as bool.
bool	getBool (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	getBool (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginCategories	getCategories () const
VUtils::CharString	getCharString (const char *propertyName)
VUtils::CharString	getCharString (const char *propertyName, bool &ok)
VUtils::CharString	getCharString (const std::string &propertyName)
VUtils::CharString	getCharString (const std::string &propertyName, bool &ok)
VUtils::CharString	getCharStringAtTime (const char *propertyName, double time)
VUtils::CharString	getCharStringAtTime (const char *propertyName, double time, bool &ok)
VUtils::CharString	getCharStringAtTime (const std::string &propertyName, double time)
VUtils::CharString	getCharStringAtTime (const std::string &propertyName, double time, bool &ok)
Color	getColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Color	getColor (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Color.
Color	getColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Color	getColor (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ColorList	getColorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
ColorList	getColorList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as ColorList.
ColorList	getColorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ColorList	getColorList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::ColorRefList	getColorRefList (const char *propertyName)
VUtils::ColorRefList	getColorRefList (const char *propertyName, bool &ok)
VUtils::ColorRefList	getColorRefList (const std::string &propertyName)
VUtils::ColorRefList	getColorRefList (const std::string &propertyName, bool &ok)
VUtils::ColorRefList	getColorRefListAtTime (const char *propertyName, double time)
VUtils::ColorRefList	getColorRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::ColorRefList	getColorRefListAtTime (const std::string &propertyName, double time)
VUtils::ColorRefList	getColorRefListAtTime (const std::string &propertyName, double time, bool &ok)
double	getDouble (const char *propertyName, bool &ok, double time=TiMe::Default()) const
double	getDouble (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as double.
double	getDouble (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
double	getDouble (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
float	getFloat (const char *propertyName, bool &ok, double time=TiMe::Default()) const
float	getFloat (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as float.
float	getFloat (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
float	getFloat (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
FloatList	getFloatList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
FloatList	getFloatList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as FloatList.
FloatList	getFloatList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
FloatList	getFloatList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::FloatRefList	getFloatRefList (const char *propertyName)
VUtils::FloatRefList	getFloatRefList (const char *propertyName, bool &ok)
VUtils::FloatRefList	getFloatRefList (const std::string &propertyName)
VUtils::FloatRefList	getFloatRefList (const std::string &propertyName, bool &ok)
VUtils::FloatRefList	getFloatRefListAtTime (const char *propertyName, double time)
VUtils::FloatRefList	getFloatRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::FloatRefList	getFloatRefListAtTime (const std::string &propertyName, double time)
VUtils::FloatRefList	getFloatRefListAtTime (const std::string &propertyName, double time, bool &ok)
int	getInt (const char *propertyName, bool &ok, double time=TiMe::Default()) const
int	getInt (const char *propertyName, double time=TiMe::Default()) const
int	getInt (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int	getInt (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
unsigned long long	getIntegerID () const noexcept
	Returns the ID of the plugin instance. The ID is unique per scene contained in a VRayRenderer instance. Can be used as a hash value.
IntList	getIntList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
IntList	getIntList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as IntList.
IntList	getIntList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
IntList	getIntList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::IntRefList	getIntRefList (const char *propertyName)
VUtils::IntRefList	getIntRefList (const char *propertyName, bool &ok)
VUtils::IntRefList	getIntRefList (const std::string &propertyName)
VUtils::IntRefList	getIntRefList (const std::string &propertyName, bool &ok)
VUtils::IntRefList	getIntRefListAtTime (const char *propertyName, double time)
VUtils::IntRefList	getIntRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::IntRefList	getIntRefListAtTime (const std::string &propertyName, double time)
VUtils::IntRefList	getIntRefListAtTime (const std::string &propertyName, double time, bool &ok)
std::vector< double >	getKeyframeTimes (const char *propertyName) const
std::vector< double >	getKeyframeTimes (const char *propertyName, bool &ok) const
std::vector< double >	getKeyframeTimes (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::vector< double >	getKeyframeTimes (const std::string &propertyName, bool &ok) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Matrix	getMatrix (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Matrix	getMatrix (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Matrix.
Matrix	getMatrix (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Matrix	getMatrix (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginMeta	getMeta () const
const char *	getName () const
PluginRefT< Plugin >	getPlugin (const char *propertyName, bool &ok, double time=TiMe::Default()) const
PluginRefT< Plugin >	getPlugin (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as a Plugin reference.
PluginRefT< Plugin >	getPlugin (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginRefT< Plugin >	getPlugin (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginList	getPluginList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
PluginList	getPluginList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as PluginList.
PluginList	getPluginList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginList	getPluginList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PropertyRuntimeMeta	getPropertyRuntimeMeta (const char *propertyName) const
PropertyRuntimeMeta	getPropertyRuntimeMeta (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VRayRenderer *	getRenderer () const noexcept
	Return the renderer this Plugin is associated with, can be null on empty plugins.
std::string	getString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
std::string	getString (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as string.
std::string	getString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getString (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
StringList	getStringList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
StringList	getStringList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as StringList.
StringList	getStringList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
StringList	getStringList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::CharStringRefList	getStringRefList (const char *propertyName)
VUtils::CharStringRefList	getStringRefList (const char *propertyName, bool &ok)
VUtils::CharStringRefList	getStringRefList (const std::string &propertyName)
VUtils::CharStringRefList	getStringRefList (const std::string &propertyName, bool &ok)
VUtils::CharStringRefList	getStringRefListAtTime (const char *propertyName, double time)
VUtils::CharStringRefList	getStringRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::CharStringRefList	getStringRefListAtTime (const std::string &propertyName, double time)
VUtils::CharStringRefList	getStringRefListAtTime (const std::string &propertyName, double time, bool &ok)
Transform	getTransform (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Transform	getTransform (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Transform.
Transform	getTransform (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Transform	getTransform (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
TransformList	getTransformList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
TransformList	getTransformList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as TransformList.
TransformList	getTransformList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
TransformList	getTransformList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const char *	getType () const
	Returns the type of this plugin as string.
PluginTypeId	getTypeId () const noexcept
	Returns the type id of this plugin as long.
Value	getValue (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Value	getValue (const char *propertyName, double time=TiMe::Default()) const
Value	getValue (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Value	getValue (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getValueAsString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
std::string	getValueAsString (const char *propertyName, double time=TiMe::Default()) const
std::string	getValueAsString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getValueAsString (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ValueList	getValueList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
ValueList	getValueList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as ValueList. Works only if it really is a generic list.
ValueList	getValueList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ValueList	getValueList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::ValueRefList	getValueRefList (const char *propertyName)
VUtils::ValueRefList	getValueRefList (const char *propertyName, bool &ok)
VUtils::ValueRefList	getValueRefList (const std::string &propertyName)
VUtils::ValueRefList	getValueRefList (const std::string &propertyName, bool &ok)
VUtils::ValueRefList	getValueRefListAtTime (const char *propertyName, double time)
VUtils::ValueRefList	getValueRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::ValueRefList	getValueRefListAtTime (const std::string &propertyName, double time)
VUtils::ValueRefList	getValueRefListAtTime (const std::string &propertyName, double time, bool &ok)
Vector	getVector (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Vector	getVector (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Vector.
Vector	getVector (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Vector	getVector (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VectorList	getVectorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
VectorList	getVectorList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as VectorList.
VectorList	getVectorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VectorList	getVectorList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::VectorRefList	getVectorRefList (const char *propertyName)
VUtils::VectorRefList	getVectorRefList (const char *propertyName, bool &ok)
VUtils::VectorRefList	getVectorRefList (const std::string &propertyName)
VUtils::VectorRefList	getVectorRefList (const std::string &propertyName, bool &ok)
VUtils::VectorRefList	getVectorRefListAtTime (const char *propertyName, double time)
VUtils::VectorRefList	getVectorRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::VectorRefList	getVectorRefListAtTime (const std::string &propertyName, double time)
VUtils::VectorRefList	getVectorRefListAtTime (const std::string &propertyName, double time, bool &ok)
bool	isEmpty () const noexcept
bool	isNotEmpty () const noexcept
bool	isPropertyAnimated (const char *propertyName) const
bool	isPropertyAnimated (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	isValid () const
bool	operator!= (const Plugin &plugin) const noexcept
	Returns false if both Plugins belong to the same renderer and point to the same scene object instance.
Plugin &	operator= (const Plugin &plugin) noexcept
	Assign from another Plugin. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
bool	operator== (const Plugin &plugin) const noexcept
	Returns true if both Plugins belong to the same renderer and point to the same scene object instance.
bool	setArray (const char *propertyName, const char *const data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const char *propertyName, const Color data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const double data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const float data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const int data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const std::string data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Transform data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Value values[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Vector data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
bool	setArray (const std::string &propertyName, const char *const data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Color data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const double data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const float data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const int data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const std::string data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Transform data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Value values[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Vector data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArrayAtTime (const char *propertyName, const Color data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const double data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const float data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const int data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const Plugin data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const std::string data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const Vector data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Color data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const double data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const float data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const int data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Plugin data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const std::string data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Vector data[], size_t count, double time)
bool	setName (const char *newName)
bool	setName (const std::string &newName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, ColorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, const AColor &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const bool value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const char *str, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Color &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const ColorList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const double value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const float value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const FloatList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const int value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const IntList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Matrix &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const PluginList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
bool	setValue (const char *propertyName, const std::string &str, double time=TiMe::Default())
bool	setValue (const char *propertyName, const StringList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Transform &transform, double time=TiMe::Default())
bool	setValue (const char *propertyName, const TransformList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Value &value, double time=TiMe::Default())
template<size_t count>
bool	setValue (const char *propertyName, const Value(&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, const ValueList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Vector &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const VectorList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const void *data, size_t size, double time=TiMe::Default())
bool	setValue (const char *propertyName, const VUtils::CharString &str)
bool	setValue (const char *propertyName, const VUtils::CharStringRefList &stringList)
bool	setValue (const char *propertyName, const VUtils::ColorRefList &colorList)
bool	setValue (const char *propertyName, const VUtils::FloatRefList &floatList)
bool	setValue (const char *propertyName, const VUtils::IntRefList &intList)
bool	setValue (const char *propertyName, const VUtils::TransformRefList &transformList)
bool	setValue (const char *propertyName, const VUtils::ValueRefList &valueList)
bool	setValue (const char *propertyName, const VUtils::VectorRefList &vectorList)
bool	setValue (const char *propertyName, FloatList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, IntList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, Value &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const char *propertyName, Value(&&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, ValueList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, VectorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, ColorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const AColor &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const bool value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const char *str, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Color &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const ColorList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const double value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const float value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const FloatList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const int value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const IntList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Matrix &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const PluginList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const std::string &str, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const StringList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Transform &transform, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const TransformList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Value &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const std::string &propertyName, const Value(&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const ValueList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Vector &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const VectorList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const void *data, size_t size, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const VUtils::CharString &str)
bool	setValue (const std::string &propertyName, const VUtils::CharStringRefList &stringList)
bool	setValue (const std::string &propertyName, const VUtils::ColorRefList &colorList)
bool	setValue (const std::string &propertyName, const VUtils::FloatRefList &floatList)
bool	setValue (const std::string &propertyName, const VUtils::IntRefList &intList)
bool	setValue (const std::string &propertyName, const VUtils::TransformRefList &transformList)
bool	setValue (const std::string &propertyName, const VUtils::ValueRefList &valueList)
bool	setValue (const std::string &propertyName, const VUtils::VectorRefList &vectorList)
bool	setValue (const std::string &propertyName, FloatList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, IntList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, Value &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const std::string &propertyName, Value(&&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, ValueList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, VectorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const char *propertyName, const char *value)
bool	setValueAsString (const char *propertyName, const std::string &value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const std::string &propertyName, const char *value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const std::string &propertyName, const std::string &value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsStringAtTime (const char *propertyName, const char *value, double time)
bool	setValueAsStringAtTime (const char *propertyName, const std::string &value, double time)
bool	setValueAsStringAtTime (const std::string &propertyName, const char *value, double time)
bool	setValueAsStringAtTime (const std::string &propertyName, const std::string &value, double time)
bool	setValueAtTime (const char *propertyName, const AColor &value, double time)
bool	setValueAtTime (const char *propertyName, const bool value, double time)
bool	setValueAtTime (const char *propertyName, const char *str, double time)
bool	setValueAtTime (const char *propertyName, const Color &value, double time)
bool	setValueAtTime (const char *propertyName, const ColorList &value, double time)
bool	setValueAtTime (const char *propertyName, const double value, double time)
bool	setValueAtTime (const char *propertyName, const float value, double time)
bool	setValueAtTime (const char *propertyName, const FloatList &value, double time)
bool	setValueAtTime (const char *propertyName, const int value, double time)
bool	setValueAtTime (const char *propertyName, const IntList &value, double time)
bool	setValueAtTime (const char *propertyName, const Matrix &value, double time)
bool	setValueAtTime (const char *propertyName, const PluginList &value, double time)
bool	setValueAtTime (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time)
bool	setValueAtTime (const char *propertyName, const std::string &str, double time)
bool	setValueAtTime (const char *propertyName, const StringList &value, double time)
bool	setValueAtTime (const char *propertyName, const Transform &transform, double time)
bool	setValueAtTime (const char *propertyName, const Value &value, double time)
bool	setValueAtTime (const char *propertyName, const ValueList &value, double time)
bool	setValueAtTime (const char *propertyName, const Vector &value, double time)
bool	setValueAtTime (const char *propertyName, const VectorList &value, double time)
bool	setValueAtTime (const char *propertyName, const void *data, size_t size, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::CharString &str, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::CharStringRefList &stringList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::ColorRefList &colorList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::FloatRefList &floatList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::IntRefList &intList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::TransformRefList &transformList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::ValueRefList &valueList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::VectorRefList &vectorList, double time)
bool	setValueAtTime (const std::string &propertyName, const AColor &value, double time)
bool	setValueAtTime (const std::string &propertyName, const bool value, double time)
bool	setValueAtTime (const std::string &propertyName, const char *str, double time)
bool	setValueAtTime (const std::string &propertyName, const Color &value, double time)
bool	setValueAtTime (const std::string &propertyName, const ColorList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const double value, double time)
bool	setValueAtTime (const std::string &propertyName, const float value, double time)
bool	setValueAtTime (const std::string &propertyName, const FloatList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const int value, double time)
bool	setValueAtTime (const std::string &propertyName, const IntList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Matrix &value, double time)
bool	setValueAtTime (const std::string &propertyName, const PluginList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time)
bool	setValueAtTime (const std::string &propertyName, const std::string &str, double time)
bool	setValueAtTime (const std::string &propertyName, const StringList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Transform &transform, double time)
bool	setValueAtTime (const std::string &propertyName, const Value &value, double time)
bool	setValueAtTime (const std::string &propertyName, const ValueList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Vector &value, double time)
bool	setValueAtTime (const std::string &propertyName, const VectorList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const void *data, size_t size, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::CharString &str, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::CharStringRefList &stringList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::ColorRefList &colorList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::FloatRefList &floatList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::IntRefList &intList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::TransformRefList &transformList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::ValueRefList &valueList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::VectorRefList &vectorList, double time)
void	swap (Plugin &plugin) noexcept
	Swaps the underlying scene object instance reference and associated renderer reference.
std::string	toString () const
	Returns a string representation of the plugin which currently is the name of the plugin.

Static Public Member Functions
static constexpr const char *	getType ()
	Return the name of the plugin type.
static constexpr const PluginTypeId	getTypeId ()
	Plugin type ID.

Additional Inherited Members
Protected Member Functions inherited from VRay::Plugin
	Plugin (VRayRenderer &renderer, const char *name)
	Plugin (VRayRenderer &renderer, InstanceId id) noexcept
	Plugin (VRayRenderer &renderer, InstanceId id, int typeIdIdx) noexcept
	Plugin (VRayRenderer &renderer, InstanceId id, PluginTypeId typeId) noexcept
InstanceId	id () const
template<typename T , int TYPE>
bool	setArrayAtTimeTemplate (const char *propertyName, size_t count, const T &value, double time)
template<typename LengthFn , typename PointerFn >
bool	setStringArrayTemplate (const char *propertyName, size_t count, LengthFn lengthAt, PointerFn pointerAt, double time)
template<typename T , int TYPE>
bool	setValueAtTimeTemplate (const char *propertyName, const T &value, double time)
Protected Attributes inherited from VRay::Plugin
InstanceId	internalId
const VRayRenderer *	pRenderer

Detailed Description

Settings for V-Ray Interactive and V-Ray GPU Interactive/Production. [gpuSupport=(partial)].

Member Function Documentation

get_coherent_tracing()

bool VRay::Plugins::SettingsRTEngine::get_coherent_tracing ( double  time = TiMe::Default() ) const

inline

true to enable coherent tracing of gi/reflections/refractions etc. [UI Guides] displayName=Coherent tracing, gpuSupport=partial [Default value] 0

get_cpu_bundle_size()

int VRay::Plugins::SettingsRTEngine::get_cpu_bundle_size ( double  time = TiMe::Default() ) const

inline

Number of samples to bundle for the V-Ray engine in one thread [UI Guides] displayName=CPU Ray bundle size, minValue=1, maxValue=1024, gpuSupport=none [Default value] 64

get_cpu_samples_per_pixel()

int VRay::Plugins::SettingsRTEngine::get_cpu_samples_per_pixel ( double  time = TiMe::Default() ) const

inline

Number of samples per pixel for the V-Ray engine [UI Guides] displayName=CPU Rays per pixel, minValue=1, maxValue=128, gpuSupport=none [Default value] 4

get_disable_auto_rpp()

bool VRay::Plugins::SettingsRTEngine::get_disable_auto_rpp ( double  time = TiMe::Default() ) const

inline

When true, overrides and disables the auto RPP and auto bundle size options [UI Guides] displayName=Disable auto RPP, gpuSupport=full [Default value] 0

get_disable_render_elements()

bool VRay::Plugins::SettingsRTEngine::get_disable_render_elements ( double  time = TiMe::Default() ) const

inline

If true, the interactive engine will produce only RGBA. Default is false. [UI Guides] displayName=Disable render elements, gpuSupport=full [Default value] 0

get_enable_bucket_sampler()

int VRay::Plugins::SettingsRTEngine::get_enable_bucket_sampler ( double  time = TiMe::Default() ) const

inline

If 1, V-Ray GPU will check the sampler type in SettingsImageSampler, and it will use the settings there, if there sampler type is "bucket". Default is (0=use progressive) [Default value] 0

get_gi_depth()

int VRay::Plugins::SettingsRTEngine::get_gi_depth ( double  time = TiMe::Default() ) const

inline

Maximum trace depth for GI. [UI Guides] displayName=GI depth, minValue=0, maxValue=100, tier=basic, gpuSupport=full [Default value] 3

get_gpu_bundle_size()

int VRay::Plugins::SettingsRTEngine::get_gpu_bundle_size ( double  time = TiMe::Default() ) const

inline

Number of samples to bundle for the V-Ray GPU engine in one thread [UI Guides] displayName=GPU Ray bundle size, minValue=1, maxValue=1024, gpuSupport=full [Default value] 256

get_gpu_samples_per_pixel()

int VRay::Plugins::SettingsRTEngine::get_gpu_samples_per_pixel ( double  time = TiMe::Default() ) const

inline

Number of samples per pixel for the V-Ray GPU engine [UI Guides] displayName=GPU Rays per pixel, minValue=1, maxValue=128, gpuSupport=full [Default value] 16

get_interactive()

int VRay::Plugins::SettingsRTEngine::get_interactive ( double  time = TiMe::Default() ) const

inline

Flag used to disable some production-only features in interactive mode [UI Guides] gpuSupport=none [Default value] 0

get_low_gpu_thread_priority()

bool VRay::Plugins::SettingsRTEngine::get_low_gpu_thread_priority ( double  time = TiMe::Default() ) const

inline

When true, V-Ray GPU tries to utilize the GPUs with attached displays less. If this is true, it works best with gpu_samples_per_pixel=1 and gpu_bundle_size=64 (or less) [UI Guides] displayName=Low GPU thread priority, gpuSupport=full [Default value] 0

get_max_draw_interval()

int VRay::Plugins::SettingsRTEngine::get_max_draw_interval ( double  time = TiMe::Default() ) const

inline

Max time, in milliseconds, between (partial) image updates (0=disable partial image updates) [UI Guides] gpuSupport=full [Default value] 0

get_max_render_time()

float VRay::Plugins::SettingsRTEngine::get_max_render_time ( double  time = TiMe::Default() ) const

inline

Max render time in minutes (0 = inf) [UI Guides] displayName=Max. render time min, minValue=0.0, maxValue=525600.0, tier=basic, gpuSupport=full [Default value] 0

get_max_sample_level()

int VRay::Plugins::SettingsRTEngine::get_max_sample_level ( double  time = TiMe::Default() ) const

inline

Max paths per pixel (0 = inf) [UI Guides] displayName=Max. paths per pixel, minValue=0, maxValue=1e9, tier=basic, gpuSupport=full [Default value] 10000

get_min_draw_interval()

int VRay::Plugins::SettingsRTEngine::get_min_draw_interval ( double  time = TiMe::Default() ) const

inline

Min time, in milliseconds, between image updates (0=show all frames) [UI Guides] gpuSupport=full [Default value] 0

get_noise_threshold()

float VRay::Plugins::SettingsRTEngine::get_noise_threshold ( double  time = TiMe::Default() ) const

inline

Noise threshold for the image sampler (0 = none) [UI Guides] displayName=Max. noise, tier=basic, gpuSupport=full [Default value] 0.001

get_opencl_resizeTextures()

int VRay::Plugins::SettingsRTEngine::get_opencl_resizeTextures ( double  time = TiMe::Default() ) const

inline

Texture transfer mode for the GPU. Note that on-demand mipmapping is available only in non-interactive mode. [UI Guides] enum=0:Full size textures;1:Resize textures;2:On-demand mipmapping;3:Compressed, displayName=GPU Resize textures, gpuSupport=full [Default value] 1

get_opencl_texsize()

int VRay::Plugins::SettingsRTEngine::get_opencl_texsize ( double  time = TiMe::Default() ) const

inline

GPU maximum texture size if the value of opencl_resizeTextures allows resizing. Bigger textures are scaled to fit this size [UI Guides] displayName=GPU Texture Size, enableIf: ?opencl_resizeTextures==1, minValue=64, maxValue=8192, gpuSupport=full [Default value] 512

get_opencl_textureFormat()

int VRay::Plugins::SettingsRTEngine::get_opencl_textureFormat ( double  time = TiMe::Default() ) const

inline

Format for the textures on the GPU (0 - 32-bit float per channel; 1 - 16-bit half float per channel; 2 - 8-bit per channel) [UI Guides] enum=0:32-bit float per channel;1:16-bit half float per channel;2:8-bit per channel, displayName=GPU Texture Format, gpuSupport=full [Default value] 1

get_out_of_core()

bool VRay::Plugins::SettingsRTEngine::get_out_of_core ( double  time = TiMe::Default() ) const

inline

When true, V-Ray GPU Out-of-core codepath will be used [UI Guides] displayName=Out of core, gpuSupport=full [Default value] 0

get_out_of_core_textures()

bool VRay::Plugins::SettingsRTEngine::get_out_of_core_textures ( double  time = TiMe::Default() ) const

inline

When true, V-Ray GPU Out-of-core pinned memory allocation will be used [UI Guides] displayName=Out of core textures, gpuSupport=full [Default value] 0

get_out_of_core_textures_threshold()

int VRay::Plugins::SettingsRTEngine::get_out_of_core_textures_threshold ( double  time = TiMe::Default() ) const

inline

Textures larger than this threshold (in MB) will get allocated in pinned memory [UI Guides] displayName=Out of core textures threshold, minValue=0, maxValue=10000, gpuSupport=full [Default value] 1

get_progressive_samples_per_pixel()

bool VRay::Plugins::SettingsRTEngine::get_progressive_samples_per_pixel ( double  time = TiMe::Default() ) const

inline

Progressive increase for 'Rays per pixel' (from 1 to real value). Use this for faster feadback. [UI Guides] displayName=Progressive rays per pixel, gpuSupport=full [Default value] 0

get_stereo_eye_distance()

float VRay::Plugins::SettingsRTEngine::get_stereo_eye_distance ( double  time = TiMe::Default() ) const

inline

Distance between the two cameras for stereo mode. [UI Guides] displayName=Stereo eye distance, gpuSupport=partial [Default value] 6.5

get_stereo_focus()

int VRay::Plugins::SettingsRTEngine::get_stereo_focus ( double  time = TiMe::Default() ) const

inline

Focus mode (0 - none, 1 - rotation, 2 - shear) [UI Guides] enum=0:None;1:Rotation;2:Shear, displayName=Stereo focus mode, gpuSupport=partial [Default value] 2

get_stereo_mode()

bool VRay::Plugins::SettingsRTEngine::get_stereo_mode ( double  time = TiMe::Default() ) const

inline

Non-zero to enable side-by-side stereo rendering. [UI Guides] displayName=Enable stereo, gpuSupport=partial [Default value] 0

get_trace_depth()

int VRay::Plugins::SettingsRTEngine::get_trace_depth ( double  time = TiMe::Default() ) const

inline

Deprecated, use SettingsOptions::mtl_maxDepth. Use Maximum trace depth for reflections/refractions etc. [UI Guides] displayName=Trace depth, minValue=0, maxValue=100, tier=basic, gpuSupport=full [Default value] 5

get_undersampling()

int VRay::Plugins::SettingsRTEngine::get_undersampling ( double  time = TiMe::Default() ) const

inline

Non-zero to use undersampling, 0 otherwise. The value specifies the blur resolution. Value of n means 1/(2^n) initial resolution in each dimension. [UI Guides] displayName=Undersampling, minValue=0, maxValue=5, gpuSupport=full [Default value] 4

set_coherent_tracing()

bool VRay::Plugins::SettingsRTEngine::set_coherent_tracing ( bool  val, double  time = TiMe::Default()  )

inline

true to enable coherent tracing of gi/reflections/refractions etc. [UI Guides] displayName=Coherent tracing, gpuSupport=partial [Default value] 0

set_cpu_bundle_size()

bool VRay::Plugins::SettingsRTEngine::set_cpu_bundle_size ( int  val, double  time = TiMe::Default()  )

inline

Number of samples to bundle for the V-Ray engine in one thread [UI Guides] displayName=CPU Ray bundle size, minValue=1, maxValue=1024, gpuSupport=none [Default value] 64

set_cpu_samples_per_pixel()

bool VRay::Plugins::SettingsRTEngine::set_cpu_samples_per_pixel ( int  val, double  time = TiMe::Default()  )

inline

Number of samples per pixel for the V-Ray engine [UI Guides] displayName=CPU Rays per pixel, minValue=1, maxValue=128, gpuSupport=none [Default value] 4

set_disable_auto_rpp()

bool VRay::Plugins::SettingsRTEngine::set_disable_auto_rpp ( bool  val, double  time = TiMe::Default()  )

inline

When true, overrides and disables the auto RPP and auto bundle size options [UI Guides] displayName=Disable auto RPP, gpuSupport=full [Default value] 0

set_disable_render_elements()

bool VRay::Plugins::SettingsRTEngine::set_disable_render_elements ( bool  val, double  time = TiMe::Default()  )

inline

If true, the interactive engine will produce only RGBA. Default is false. [UI Guides] displayName=Disable render elements, gpuSupport=full [Default value] 0

set_enable_bucket_sampler()

bool VRay::Plugins::SettingsRTEngine::set_enable_bucket_sampler ( int  val, double  time = TiMe::Default()  )

inline

If 1, V-Ray GPU will check the sampler type in SettingsImageSampler, and it will use the settings there, if there sampler type is "bucket". Default is (0=use progressive) [Default value] 0

set_gi_depth()

bool VRay::Plugins::SettingsRTEngine::set_gi_depth ( int  val, double  time = TiMe::Default()  )

inline

Maximum trace depth for GI. [UI Guides] displayName=GI depth, minValue=0, maxValue=100, tier=basic, gpuSupport=full [Default value] 3

set_gpu_bundle_size()

bool VRay::Plugins::SettingsRTEngine::set_gpu_bundle_size ( int  val, double  time = TiMe::Default()  )

inline

Number of samples to bundle for the V-Ray GPU engine in one thread [UI Guides] displayName=GPU Ray bundle size, minValue=1, maxValue=1024, gpuSupport=full [Default value] 256

set_gpu_samples_per_pixel()

bool VRay::Plugins::SettingsRTEngine::set_gpu_samples_per_pixel ( int  val, double  time = TiMe::Default()  )

inline

Number of samples per pixel for the V-Ray GPU engine [UI Guides] displayName=GPU Rays per pixel, minValue=1, maxValue=128, gpuSupport=full [Default value] 16

set_interactive()

bool VRay::Plugins::SettingsRTEngine::set_interactive ( int  val, double  time = TiMe::Default()  )

inline

Flag used to disable some production-only features in interactive mode [UI Guides] gpuSupport=none [Default value] 0

set_low_gpu_thread_priority()

bool VRay::Plugins::SettingsRTEngine::set_low_gpu_thread_priority ( bool  val, double  time = TiMe::Default()  )

inline

When true, V-Ray GPU tries to utilize the GPUs with attached displays less. If this is true, it works best with gpu_samples_per_pixel=1 and gpu_bundle_size=64 (or less) [UI Guides] displayName=Low GPU thread priority, gpuSupport=full [Default value] 0

set_max_draw_interval()

bool VRay::Plugins::SettingsRTEngine::set_max_draw_interval ( int  val, double  time = TiMe::Default()  )

inline

Max time, in milliseconds, between (partial) image updates (0=disable partial image updates) [UI Guides] gpuSupport=full [Default value] 0

set_max_render_time()

bool VRay::Plugins::SettingsRTEngine::set_max_render_time ( float  val, double  time = TiMe::Default()  )

inline

Max render time in minutes (0 = inf) [UI Guides] displayName=Max. render time min, minValue=0.0, maxValue=525600.0, tier=basic, gpuSupport=full [Default value] 0

set_max_sample_level()

bool VRay::Plugins::SettingsRTEngine::set_max_sample_level ( int  val, double  time = TiMe::Default()  )

inline

Max paths per pixel (0 = inf) [UI Guides] displayName=Max. paths per pixel, minValue=0, maxValue=1e9, tier=basic, gpuSupport=full [Default value] 10000

set_min_draw_interval()

bool VRay::Plugins::SettingsRTEngine::set_min_draw_interval ( int  val, double  time = TiMe::Default()  )

inline

Min time, in milliseconds, between image updates (0=show all frames) [UI Guides] gpuSupport=full [Default value] 0

set_noise_threshold()

bool VRay::Plugins::SettingsRTEngine::set_noise_threshold ( float  val, double  time = TiMe::Default()  )

inline

Noise threshold for the image sampler (0 = none) [UI Guides] displayName=Max. noise, tier=basic, gpuSupport=full [Default value] 0.001

set_opencl_resizeTextures()

bool VRay::Plugins::SettingsRTEngine::set_opencl_resizeTextures ( int  val, double  time = TiMe::Default()  )

inline

Texture transfer mode for the GPU. Note that on-demand mipmapping is available only in non-interactive mode. [UI Guides] enum=0:Full size textures;1:Resize textures;2:On-demand mipmapping;3:Compressed, displayName=GPU Resize textures, gpuSupport=full [Default value] 1

set_opencl_texsize()

bool VRay::Plugins::SettingsRTEngine::set_opencl_texsize ( int  val, double  time = TiMe::Default()  )

inline

GPU maximum texture size if the value of opencl_resizeTextures allows resizing. Bigger textures are scaled to fit this size [UI Guides] displayName=GPU Texture Size, enableIf: ?opencl_resizeTextures==1, minValue=64, maxValue=8192, gpuSupport=full [Default value] 512

set_opencl_textureFormat()

bool VRay::Plugins::SettingsRTEngine::set_opencl_textureFormat ( int  val, double  time = TiMe::Default()  )

inline

Format for the textures on the GPU (0 - 32-bit float per channel; 1 - 16-bit half float per channel; 2 - 8-bit per channel) [UI Guides] enum=0:32-bit float per channel;1:16-bit half float per channel;2:8-bit per channel, displayName=GPU Texture Format, gpuSupport=full [Default value] 1

set_out_of_core()

bool VRay::Plugins::SettingsRTEngine::set_out_of_core ( bool  val, double  time = TiMe::Default()  )

inline

When true, V-Ray GPU Out-of-core codepath will be used [UI Guides] displayName=Out of core, gpuSupport=full [Default value] 0

set_out_of_core_textures()

bool VRay::Plugins::SettingsRTEngine::set_out_of_core_textures ( bool  val, double  time = TiMe::Default()  )

inline

When true, V-Ray GPU Out-of-core pinned memory allocation will be used [UI Guides] displayName=Out of core textures, gpuSupport=full [Default value] 0

set_out_of_core_textures_threshold()

bool VRay::Plugins::SettingsRTEngine::set_out_of_core_textures_threshold ( int  val, double  time = TiMe::Default()  )

inline

Textures larger than this threshold (in MB) will get allocated in pinned memory [UI Guides] displayName=Out of core textures threshold, minValue=0, maxValue=10000, gpuSupport=full [Default value] 1

set_progressive_samples_per_pixel()

bool VRay::Plugins::SettingsRTEngine::set_progressive_samples_per_pixel ( bool  val, double  time = TiMe::Default()  )

inline

Progressive increase for 'Rays per pixel' (from 1 to real value). Use this for faster feadback. [UI Guides] displayName=Progressive rays per pixel, gpuSupport=full [Default value] 0

set_stereo_eye_distance()

bool VRay::Plugins::SettingsRTEngine::set_stereo_eye_distance ( float  val, double  time = TiMe::Default()  )

inline

Distance between the two cameras for stereo mode. [UI Guides] displayName=Stereo eye distance, gpuSupport=partial [Default value] 6.5

set_stereo_focus()

bool VRay::Plugins::SettingsRTEngine::set_stereo_focus ( int  val, double  time = TiMe::Default()  )

inline

Focus mode (0 - none, 1 - rotation, 2 - shear) [UI Guides] enum=0:None;1:Rotation;2:Shear, displayName=Stereo focus mode, gpuSupport=partial [Default value] 2

set_stereo_mode()

bool VRay::Plugins::SettingsRTEngine::set_stereo_mode ( bool  val, double  time = TiMe::Default()  )

inline

Non-zero to enable side-by-side stereo rendering. [UI Guides] displayName=Enable stereo, gpuSupport=partial [Default value] 0

set_trace_depth()

bool VRay::Plugins::SettingsRTEngine::set_trace_depth ( int  val, double  time = TiMe::Default()  )

inline

Deprecated, use SettingsOptions::mtl_maxDepth. Use Maximum trace depth for reflections/refractions etc. [UI Guides] displayName=Trace depth, minValue=0, maxValue=100, tier=basic, gpuSupport=full [Default value] 5

set_undersampling()

bool VRay::Plugins::SettingsRTEngine::set_undersampling ( int  val, double  time = TiMe::Default()  )

inline

Non-zero to use undersampling, 0 otherwise. The value specifies the blur resolution. Value of n means 1/(2^n) initial resolution in each dimension. [UI Guides] displayName=Undersampling, minValue=0, maxValue=5, gpuSupport=full [Default value] 4

---

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

• /home/jenkins/ci/j/workspace/core/vray_appsdk_lin_build/build/APPSDK/centos7/appsdk/cpp/generated/vrayplugins.hpp