Settings for stereoscopic rendering [gpuSupport=(partial)] More...

Inherits VRay.Plugins.Plugin, VRay.Plugins.IPluginRef< VRayStereoscopicSettings >, and VRay.Plugins.ISettingsPluginCategory.

Public Member Functions
bool	Get_AdjustResolution (double time)
	Gets the value of VRayStereoscopicSettings.AdjustResolution More...

float	Get_BottomMergeAngle (double time)
	Gets the value of VRayStereoscopicSettings.BottomMergeAngle More...

IList< object >	Get_ExcludeList (double time)
	Gets the value of VRayStereoscopicSettings.ExcludeList More...

bool	Get_ExcludeListInclusive (double time)
	Gets the value of VRayStereoscopicSettings.ExcludeListInclusive More...

int	Get_ExrCompression (double time)
	Gets the value of VRayStereoscopicSettings.ExrCompression More...

float	Get_EyeDistance (double time)
	Gets the value of VRayStereoscopicSettings.EyeDistance More...

float	Get_FilmOffsetXLeft (double time)
	Gets the value of VRayStereoscopicSettings.FilmOffsetXLeft More...

float	Get_FilmOffsetXRight (double time)
	Gets the value of VRayStereoscopicSettings.FilmOffsetXRight More...

float	Get_FilmOffsetYLeft (double time)
	Gets the value of VRayStereoscopicSettings.FilmOffsetYLeft More...

float	Get_FilmOffsetYRight (double time)
	Gets the value of VRayStereoscopicSettings.FilmOffsetYRight More...

bool	Get_FloatColorsMode (double time)
	Gets the value of VRayStereoscopicSettings.FloatColorsMode More...

float	Get_FocusDistance (double time)
	Gets the value of VRayStereoscopicSettings.FocusDistance More...

int	Get_FocusMethod (double time)
	Gets the value of VRayStereoscopicSettings.FocusMethod More...

int	Get_InterocularMethod (double time)
	Gets the value of VRayStereoscopicSettings.InterocularMethod More...

IPluginRef	Get_LeftCamera (double time)
	Gets the value of VRayStereoscopicSettings.LeftCamera More...

int	Get_OutputLayout (double time)
	Gets the value of VRayStereoscopicSettings.OutputLayout More...

int	Get_PoleMergeMethod (double time)
	Gets the value of VRayStereoscopicSettings.PoleMergeMethod More...

float	Get_ReuseThreshold (double time)
	Gets the value of VRayStereoscopicSettings.ReuseThreshold More...

IPluginRef	Get_RightCamera (double time)
	Gets the value of VRayStereoscopicSettings.RightCamera More...

string	Get_ShademapFile (double time)
	Gets the value of VRayStereoscopicSettings.ShademapFile More...

int	Get_SmMode (double time)
	Gets the value of VRayStereoscopicSettings.SmMode More...

bool	Get_SpecifyFocus (double time)
	Gets the value of VRayStereoscopicSettings.SpecifyFocus More...

float	Get_TopMergeAngle (double time)
	Gets the value of VRayStereoscopicSettings.TopMergeAngle More...

int	Get_View (double time)
	Gets the value of VRayStereoscopicSettings.View More...

int	Get_VrstCompression (double time)
	Gets the value of VRayStereoscopicSettings.VrstCompression More...

bool	Set_AdjustResolution (bool val, double time)
	Sets a value to VRayStereoscopicSettings.AdjustResolution More...

bool	Set_BottomMergeAngle (float val, double time)
	Sets a value to VRayStereoscopicSettings.BottomMergeAngle More...

bool	Set_ExcludeList (IList< object > val, double time)
	Sets a value to VRayStereoscopicSettings.ExcludeList More...

bool	Set_ExcludeListInclusive (bool val, double time)
	Sets a value to VRayStereoscopicSettings.ExcludeListInclusive More...

bool	Set_ExrCompression (int val, double time)
	Sets a value to VRayStereoscopicSettings.ExrCompression More...

bool	Set_EyeDistance (float val, double time)
	Sets a value to VRayStereoscopicSettings.EyeDistance More...

bool	Set_FilmOffsetXLeft (float val, double time)
	Sets a value to VRayStereoscopicSettings.FilmOffsetXLeft More...

bool	Set_FilmOffsetXRight (float val, double time)
	Sets a value to VRayStereoscopicSettings.FilmOffsetXRight More...

bool	Set_FilmOffsetYLeft (float val, double time)
	Sets a value to VRayStereoscopicSettings.FilmOffsetYLeft More...

bool	Set_FilmOffsetYRight (float val, double time)
	Sets a value to VRayStereoscopicSettings.FilmOffsetYRight More...

bool	Set_FloatColorsMode (bool val, double time)
	Sets a value to VRayStereoscopicSettings.FloatColorsMode More...

bool	Set_FocusDistance (float val, double time)
	Sets a value to VRayStereoscopicSettings.FocusDistance More...

bool	Set_FocusMethod (int val, double time)
	Sets a value to VRayStereoscopicSettings.FocusMethod More...

bool	Set_InterocularMethod (int val, double time)
	Sets a value to VRayStereoscopicSettings.InterocularMethod More...

bool	Set_LeftCamera (IPluginRef val, double time)
	Sets a value to VRayStereoscopicSettings.LeftCamera More...

bool	Set_OutputLayout (int val, double time)
	Sets a value to VRayStereoscopicSettings.OutputLayout More...

bool	Set_PoleMergeMethod (int val, double time)
	Sets a value to VRayStereoscopicSettings.PoleMergeMethod More...

bool	Set_ReuseThreshold (float val, double time)
	Sets a value to VRayStereoscopicSettings.ReuseThreshold More...

bool	Set_RightCamera (IPluginRef val, double time)
	Sets a value to VRayStereoscopicSettings.RightCamera More...

bool	Set_ShademapFile (string val, double time)
	Sets a value to VRayStereoscopicSettings.ShademapFile More...

bool	Set_SmMode (int val, double time)
	Sets a value to VRayStereoscopicSettings.SmMode More...

bool	Set_SpecifyFocus (bool val, double time)
	Sets a value to VRayStereoscopicSettings.SpecifyFocus More...

bool	Set_TopMergeAngle (float val, double time)
	Sets a value to VRayStereoscopicSettings.TopMergeAngle More...

bool	Set_View (int val, double time)
	Sets a value to VRayStereoscopicSettings.View More...

bool	Set_VrstCompression (int val, double time)
	Sets a value to VRayStereoscopicSettings.VrstCompression More...

Public Member Functions inherited from VRay.Plugins.Plugin
PluginCategories	GetCategories ()
	Gets all the plugin categories this plugin belongs to, such as being a Light or a Material, etc.

long	GetIntegerID ()
	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.

double[]	GetKeyframeTimes (string propertyName)
	Return an array of keyframe times if the property contains animated values or an empty array if the property is not animated. More...

PluginMeta	GetMeta ()
	Gets a plugin meta object.

string	GetName ()
	Gets the name of the plugin.

PropertyRuntimeMeta	GetPropertyRuntimeMeta (string propertyName)
	Gets an object with runtime meta information about the property. More...

VRayRenderer	GetRenderer ()
	Gets a reference to the renderer which created the plugin.

string	Gettype ()
	Gets the type of the plugin. More...

object	GetValue (string propertyName)
	Gets the value of the specified property as a generic object. More...

object	GetValue (string propertyName, double time)
	Gets the value of the specified property as a generic object. More...

AColor	GetValueAsAColor (string propertyName)
	Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...

AColor	GetValueAsAColor (string propertyName, double time)
	Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...

bool	GetValueAsBool (string propertyName)
	Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...

bool	GetValueAsBool (string propertyName, double time)
	Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...

Color	GetValueAsColor (string propertyName)
	Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...

Color	GetValueAsColor (string propertyName, double time)
	Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...

double	GetValueAsDouble (string propertyName)
	Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...

double	GetValueAsDouble (string propertyName, double time)
	Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...

float	GetValueAsFloat (string propertyName)
	Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...

float	GetValueAsFloat (string propertyName, double time)
	Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...

int	GetValueAsInt (string propertyName)
	Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...

int	GetValueAsInt (string propertyName, double time)
	Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...

IList	GetValueAsList (string propertyName)
	Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...

IList	GetValueAsList (string propertyName, double time)
	Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...

IList< T >	GetValueAsList< T > (string propertyName)
	Gets the value of the specified property if it is of a list type. More...

IList< T >	GetValueAsList< T > (string propertyName, double time)
	Gets the value of the specified property if it is of a list type. More...

Matrix	GetValueAsMatrix (string propertyName)
	Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...

Matrix	GetValueAsMatrix (string propertyName, double time)
	Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...

IPluginRef	GetValueAsPluginRef (string propertyName)
	Gets the value of the specified property if it is of type Plugin/PluginRef. More...

IPluginRef	GetValueAsPluginRef (string propertyName, double time)
	Gets the value of the specified property if it is of type Plugin/PluginRef. More...

string	GetValueAsString (string propertyName)
	Gets the string representation of the specified plugin property value. More...

string	GetValueAsString (string propertyName, double time)
	Gets the string representation of the specified plugin property value. More...

Transform	GetValueAsTransform (string propertyName)
	Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...

Transform	GetValueAsTransform (string propertyName, double time)
	Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...

Vector	GetValueAsVector (string propertyName)
	Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...

Vector	GetValueAsVector (string propertyName, double time)
	Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...

bool	IsPropertyAnimated (string propertyName)
	Returns whether the current value of the property is animated or not. More...

bool	IsValid ()
	Check whether this object contains a valid reference to a V-Ray plugin instance. (The reference may become invalid if the actual plugin it refers to has been deleted.) More...

bool	SetName (string newName)
	Sets a new name of the plugin. More...

bool	SetValue (string propertyName, AColor value)
	Sets the value of the specified property as AColor. More...

bool	SetValue (string propertyName, AColor value, double time)
	Sets the value of the specified property as AColor. More...

bool	SetValue (string propertyName, bool value)
	Sets the value of the specified property as bool. More...

bool	SetValue (string propertyName, bool value, double time)
	Sets the value of the specified property as bool. More...

bool	SetValue (string propertyName, Color value)
	Sets the value of the specified property as Color. More...

bool	SetValue (string propertyName, Color value, double time)
	Sets the value of the specified property as Color. More...

bool	SetValue (string propertyName, Color[] value)
	Sets the value of the specified property as an array of Colors. More...

bool	SetValue (string propertyName, Color[] value, double time)
	Sets the value of the specified property as an array of Colors. More...

bool	SetValue (string propertyName, Color[] value, int startIndex, int size)
	Sets the value of the specified property as a slice of a Color array. More...

bool	SetValue (string propertyName, Color[] value, int startIndex, int size, double time)
	Sets the value of the specified property as a slice of a Color array. More...

bool	SetValue (string propertyName, double value)
	Sets the value of the specified property as double. More...

bool	SetValue (string propertyName, double value, double time)
	Sets the value of the specified property as double. More...

bool	SetValue (string propertyName, double[] value)
	Sets the value of the specified property as an array of doubles. More...

bool	SetValue (string propertyName, double[] value, double time)
	Sets the value of the specified property as an array of doubles. More...

bool	SetValue (string propertyName, double[] value, int startIndex, int size)
	Sets the value of the specified property as a slice of a double array. More...

bool	SetValue (string propertyName, double[] value, int startIndex, int size, double time)
	Sets the value of the specified property as a slice of a double array. More...

bool	SetValue (string propertyName, float value)
	Sets the value of the specified property as float. More...

bool	SetValue (string propertyName, float value, double time)
	Sets the value of the specified property as float. More...

bool	SetValue (string propertyName, float[] value)
	Sets the value of the specified property as an array of floats. More...

bool	SetValue (string propertyName, float[] value, double time)
	Sets the value of the specified property as an array of floats. More...

bool	SetValue (string propertyName, float[] value, int startIndex, int size)
	Sets the value of the specified property as a slice of a float array. More...

bool	SetValue (string propertyName, float[] value, int startIndex, int size, double time)
	Sets the value of the specified property as a slice of a float array. More...

bool	SetValue (string propertyName, IList< Color > value)
	Sets the value of the specified property as a list of Colors. More...

bool	SetValue (string propertyName, IList< Color > value, double time)
	Sets the value of the specified property as a list of Colors. More...

bool	SetValue (string propertyName, IList< double > value)
	Sets the value of the specified property as alist of doubles. More...

bool	SetValue (string propertyName, IList< double > value, double time)
	Sets the value of the specified property as alist of doubles. More...

bool	SetValue (string propertyName, IList< float > value)
	Sets the value of the specified property as a list of floats. More...

bool	SetValue (string propertyName, IList< float > value, double time)
	Sets the value of the specified property as a list of floats. More...

bool	SetValue (string propertyName, IList< int > value)
	Sets the value of the specified property as a list of ints. More...

bool	SetValue (string propertyName, IList< int > value, double time)
	Sets the value of the specified property as a list of ints. More...

bool	SetValue (string propertyName, IList< Vector > value)
	Sets the value of the specified property as a list of Vectors. More...

bool	SetValue (string propertyName, IList< Vector > value, double time)
	Sets the value of the specified property as a list of Vectors. More...

bool	SetValue (string propertyName, int value)
	Sets the value of the specified property as int. More...

bool	SetValue (string propertyName, int value, double time)
	Sets the value of the specified property as int. More...

bool	SetValue (string propertyName, int[] value)
	Sets the value of the specified property as an array of ints. More...

bool	SetValue (string propertyName, int[] value, double time)
	Sets the value of the specified property as an array of ints. More...

bool	SetValue (string propertyName, int[] value, int startIndex, int size)
	Sets the value of the specified property as a slice of an int array. More...

bool	SetValue (string propertyName, int[] value, int startIndex, int size, double time)
	Sets the value of the specified property as a slice of an int array. More...

bool	SetValue (string propertyName, IPluginRef value)
	Sets the value of the specified property as Plugin or Plugin's output parameter. More...

bool	SetValue (string propertyName, IPluginRef value, double time)
	Sets the value of the specified property as Plugin or Plugin's output parameter. More...

bool	SetValue (string propertyName, Matrix value)
	Sets the value of the specified property as Matrix. More...

bool	SetValue (string propertyName, Matrix value, double time)
	Sets the value of the specified property as Matrix. More...

bool	SetValue (string propertyName, object value)
	Sets the value of the specified property as a generic object. The type is deduced internally. More...

bool	SetValue (string propertyName, object value, double time)
	Sets the value of the specified property as a generic object. The type is deduced internally. More...

bool	SetValue (string propertyName, Plugin outPlugin, string outPropertyName)
	Sets the value of the specified property as a Plugin's output parameter. More...

bool	SetValue (string propertyName, Plugin outPlugin, string outPropertyName, double time)
	Sets the value of the specified property as a Plugin's output parameter. More...

bool	SetValue (string propertyName, Plugin value)
	Sets the value of the specified property as Plugin. More...

bool	SetValue (string propertyName, Plugin value, double time)
	Sets the value of the specified property as Plugin. More...

bool	SetValue (string propertyName, string propertyValue)
	Updates the currently loaded V-Ray scene. More...

bool	SetValue (string propertyName, string propertyValue, double time)
	Updates the currently loaded V-Ray scene. More...

bool	SetValue (string propertyName, Transform value)
	Sets the value of the specified property as Transform. More...

bool	SetValue (string propertyName, Transform value, double time)
	Sets the value of the specified property as Transform. More...

bool	SetValue (string propertyName, Vector value)
	Sets the value of the specified property as Vector. More...

bool	SetValue (string propertyName, Vector value, double time)
	Sets the value of the specified property as Vector. More...

bool	SetValue (string propertyName, Vector[] value)
	Sets the value of the specified property as an array of Vectors. More...

bool	SetValue (string propertyName, Vector[] value, double time)
	Sets the value of the specified property as an array of Vectors. More...

bool	SetValue (string propertyName, Vector[] value, int startIndex, int size)
	Sets the value of the specified property as a slice of a Vector array. More...

bool	SetValue (string propertyName, Vector[] value, int startIndex, int size, double time)
	Sets the value of the specified property as a slice of a Vector array. More...

override string	ToString ()
	Returns the plugin name. More...

string	ToString ()

new string	ToString ()

Public Member Functions inherited from VRay.Plugins.IPluginRef< VRayStereoscopicSettings >
string	ToString ()

new string	ToString ()

Static Public Member Functions
static VRayStereoscopicSettings	GetInstance (VRayRenderer renderer, string name)
	Use renderer to find and return a VRayStereoscopicSettings instance with the given name

static VRayStereoscopicSettings	NewInstance (VRayRenderer renderer, string name)
	Use renderer to create and return a VRayStereoscopicSettings instance

Properties
bool	AdjustResolution `[get, set]`
	Unused parameter. [UI Guides] gpuSupport=full More...

float	BottomMergeAngle `[get, set]`
	Panoramic pole merging: from what angle near the bottom does the stereo effect start to fade when rendering with a spherical panorama camera. [UI Guides] minValue=0.0, maxValue=1.5707963, units=radians,gpuSupport=full More...

IList< object >	ExcludeList `[get, set]`
	A list of plugins for which the shade map won't be used. [UI Guides] enableIf: ?sm_mode!=0, attributes=objectSet,gpuSupport=none

bool	ExcludeListInclusive `[get, set]`
	When on, the exclude_list is considered an 'Include list'. [UI Guides] enableIf: ?sm_mode!=0,gpuSupport=none More...

int	ExrCompression `[get, set]`
	Compression type for the .exr files (0 - no compression, 1 - RLE compression, 2 - ZIPS compression). [UI Guides] displayName=EXR Compression, enum=0:None;1:RLE;2:ZIPS, enableIf: ?sm_mode=1,gpuSupport=none More...

float	EyeDistance `[get, set]`
	The eye distance for which the stereoscopic image will be rendered. [UI Guides] minValue=0.0, quantityType=distance,gpuSupport=full More...

float	FilmOffsetXLeft `[get, set]`
	Horizontal film offset for the left camera [UI Guides] gpuSupport=full More...

float	FilmOffsetXRight `[get, set]`
	Horizontal film offset for the right camera [UI Guides] gpuSupport=full More...

float	FilmOffsetYLeft `[get, set]`
	Vertical film offset for the left camera [UI Guides] gpuSupport=full More...

float	FilmOffsetYRight `[get, set]`
	Vertical film offset for the right camera [UI Guides] gpuSupport=full More...

bool	FloatColorsMode `[get, set]`
	Store 32 bit (single precision) color channels in the shade map. When off 16 bit (half precision) values are stored. [UI Guides] displayName=32 Bit Colors, enableIf: ?sm_mode=1,gpuSupport=none More...

float	FocusDistance `[get, set]`
	The focus distance when specify_focus is enabled. [UI Guides] minValue=0.0, quantityType=distance, enableIf: ?specify_focus=1,gpuSupport=full More...

int	FocusMethod `[get, set]`
	Specifies the focus method for the two views (0 - none/parallel; 1 - rotation; 2 - shear). [UI Guides] enum=0:None/parallel;1:Rotation;2:Shear,gpuSupport=partial More...

int	InterocularMethod `[get, set]`
	Specifies how the two virtual cameras will be placed in relation to the real camera in the scene (0 - symmetric/shift both; 1 - shift left; 2 - shift right). [UI Guides] enum=0:Symmetric/shift both;1:Shift left;2:Shift right,gpuSupport=none More...

IPluginRef	LeftCamera `[get, set]`
	A camera plugin for the left eye; if not specified, the left camera is computed based on the scene camera. [UI Guides] gpuSupport=full

int	OutputLayout `[get, set]`
	Layout of the output image (0 - side-by-side; 1 - top-bottom). [UI Guides] enum=0:Side-by-Side;1:Top-Bottom,gpuSupport=full More...

int	PoleMergeMethod `[get, set]`
	The method for pole merging (0 - the original V-Ray method; 1 - cosine method that matches other renderers) [UI Guides] gpuSupport=none More...

float	ReuseThreshold `[get, set]`
	Lower values will make V-Ray use less of the shade map and more real shading. [UI Guides] minValue=0.0, maxValue=100.0, enableIf: ?sm_mode=2,gpuSupport=none More...

IPluginRef	RightCamera `[get, set]`
	A camera plugin for the right eye; if not specified, the right camera is computed based on the scene camera. [UI Guides] gpuSupport=full

string	ShademapFile `[get, set]`
	The name of the file in which the shade map information is stored. [UI Guides] fileAsset=vrst;exr fileAssetNames=V-Ray shade map file;V-Ray deep image file;OpenEXR deep image file, fileAssetOp=bothLoadAndSave, enableIf: ?sm_mode!=0,gpuSupport=none More...

int	SmMode `[get, set]`
	Specifies the mode of operation for the shade map (0 - disabled; 1 - render shade map; 2 - use shade map). [UI Guides] displayName=Shade Map Mode, enum=0:Disabled;1:Render shade map;2:Use shade map, startRollout=,gpuSupport=none More...

bool	SpecifyFocus `[get, set]`
	If on then the focus is determined by focus_method and focus_distance. Otherwise it is determined from the camera target distance. [UI Guides] gpuSupport=full More...

float	TopMergeAngle `[get, set]`
	Panoramic pole merging: from what angle near the top does the stereo effect start to fade when rendering with a spherical panorama camera. [UI Guides] minValue=0.0, maxValue=1.5707963, units=radians,gpuSupport=full More...

int	View `[get, set]`
	Specifies which of the stereoscopic views will be rendered (0 - both; 1 - left; 2 - right). [UI Guides] enum=0:Both;1:Left;2:Right,gpuSupport=full More...

int	VrstCompression `[get, set]`
	Compression type for the .vrst files (0 - no compression, 1 - ZLIB compression). [UI Guides] displayName=VRST Compression, enum=0:None;1:ZLIB, enableIf: ?sm_mode=1,gpuSupport=none More...

Properties inherited from VRay.Plugins.Plugin
string	this[string property] `[get, set]`
	Gets or sets a property with the given name. More...

Properties inherited from VRay.Plugins.IPluginRef< T >
string	OutputName `[get]`
	The output property name of the plugin if any. More...

new string	OutputName `[get]`
	The output property name of the plugin if any. More...

Plugin	Plugin `[get]`
	The plugin. More...

new T	Plugin `[get]`
	The plugin. More...

Properties inherited from VRay.Plugins.IPluginRef< VRayStereoscopicSettings >
string	OutputName `[get]`
	The output property name of the plugin if any.

new string	OutputName `[get]`
	The output property name of the plugin if any.

Plugin	Plugin `[get]`
	The plugin.

new T	Plugin `[get]`
	The plugin.

Additional Inherited Members
Protected Member Functions inherited from VRay.Plugins.Plugin
	Plugin (VRayRenderer renderer, long id)

	Plugin (VRayRenderer renderer, string name)

void	Initialize (VRayRenderer vrayRenderer, long pluginId)

Detailed Description

Settings for stereoscopic rendering [gpuSupport=(partial)]

Member Function Documentation

◆ Get_AdjustResolution()

bool VRay.Plugins.VRayStereoscopicSettings.Get_AdjustResolution ( double time )

Gets the value of VRayStereoscopicSettings.AdjustResolution

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_BottomMergeAngle()

float VRay.Plugins.VRayStereoscopicSettings.Get_BottomMergeAngle ( double time )

Gets the value of VRayStereoscopicSettings.BottomMergeAngle

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ExcludeList()

IList< object > VRay.Plugins.VRayStereoscopicSettings.Get_ExcludeList ( double time )

Gets the value of VRayStereoscopicSettings.ExcludeList

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ExcludeListInclusive()

bool VRay.Plugins.VRayStereoscopicSettings.Get_ExcludeListInclusive ( double time )

Gets the value of VRayStereoscopicSettings.ExcludeListInclusive

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ExrCompression()

int VRay.Plugins.VRayStereoscopicSettings.Get_ExrCompression ( double time )

Gets the value of VRayStereoscopicSettings.ExrCompression

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_EyeDistance()

float VRay.Plugins.VRayStereoscopicSettings.Get_EyeDistance ( double time )

Gets the value of VRayStereoscopicSettings.EyeDistance

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FilmOffsetXLeft()

float VRay.Plugins.VRayStereoscopicSettings.Get_FilmOffsetXLeft ( double time )

Gets the value of VRayStereoscopicSettings.FilmOffsetXLeft

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FilmOffsetXRight()

float VRay.Plugins.VRayStereoscopicSettings.Get_FilmOffsetXRight ( double time )

Gets the value of VRayStereoscopicSettings.FilmOffsetXRight

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FilmOffsetYLeft()

float VRay.Plugins.VRayStereoscopicSettings.Get_FilmOffsetYLeft ( double time )

Gets the value of VRayStereoscopicSettings.FilmOffsetYLeft

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FilmOffsetYRight()

float VRay.Plugins.VRayStereoscopicSettings.Get_FilmOffsetYRight ( double time )

Gets the value of VRayStereoscopicSettings.FilmOffsetYRight

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FloatColorsMode()

bool VRay.Plugins.VRayStereoscopicSettings.Get_FloatColorsMode ( double time )

Gets the value of VRayStereoscopicSettings.FloatColorsMode

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FocusDistance()

float VRay.Plugins.VRayStereoscopicSettings.Get_FocusDistance ( double time )

Gets the value of VRayStereoscopicSettings.FocusDistance

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_FocusMethod()

int VRay.Plugins.VRayStereoscopicSettings.Get_FocusMethod ( double time )

Gets the value of VRayStereoscopicSettings.FocusMethod

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_InterocularMethod()

int VRay.Plugins.VRayStereoscopicSettings.Get_InterocularMethod ( double time )

Gets the value of VRayStereoscopicSettings.InterocularMethod

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_LeftCamera()

IPluginRef VRay.Plugins.VRayStereoscopicSettings.Get_LeftCamera ( double time )

Gets the value of VRayStereoscopicSettings.LeftCamera

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_OutputLayout()

int VRay.Plugins.VRayStereoscopicSettings.Get_OutputLayout ( double time )

Gets the value of VRayStereoscopicSettings.OutputLayout

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_PoleMergeMethod()

int VRay.Plugins.VRayStereoscopicSettings.Get_PoleMergeMethod ( double time )

Gets the value of VRayStereoscopicSettings.PoleMergeMethod

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ReuseThreshold()

float VRay.Plugins.VRayStereoscopicSettings.Get_ReuseThreshold ( double time )

Gets the value of VRayStereoscopicSettings.ReuseThreshold

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_RightCamera()

IPluginRef VRay.Plugins.VRayStereoscopicSettings.Get_RightCamera ( double time )

Gets the value of VRayStereoscopicSettings.RightCamera

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_ShademapFile()

string VRay.Plugins.VRayStereoscopicSettings.Get_ShademapFile ( double time )

Gets the value of VRayStereoscopicSettings.ShademapFile

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_SmMode()

int VRay.Plugins.VRayStereoscopicSettings.Get_SmMode ( double time )

Gets the value of VRayStereoscopicSettings.SmMode

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_SpecifyFocus()

bool VRay.Plugins.VRayStereoscopicSettings.Get_SpecifyFocus ( double time )

Gets the value of VRayStereoscopicSettings.SpecifyFocus

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_TopMergeAngle()

float VRay.Plugins.VRayStereoscopicSettings.Get_TopMergeAngle ( double time )

Gets the value of VRayStereoscopicSettings.TopMergeAngle

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_View()

int VRay.Plugins.VRayStereoscopicSettings.Get_View ( double time )

Gets the value of VRayStereoscopicSettings.View

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Get_VrstCompression()

int VRay.Plugins.VRayStereoscopicSettings.Get_VrstCompression ( double time )

Gets the value of VRayStereoscopicSettings.VrstCompression

Parameters

time	The time, when the value is requested.

Returns: The value of the property.

◆ Set_AdjustResolution()

bool VRay.Plugins.VRayStereoscopicSettings.Set_AdjustResolution	(	bool	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.AdjustResolution

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_BottomMergeAngle()

bool VRay.Plugins.VRayStereoscopicSettings.Set_BottomMergeAngle	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.BottomMergeAngle

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ExcludeList()

bool VRay.Plugins.VRayStereoscopicSettings.Set_ExcludeList	(	IList< object >	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.ExcludeList

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ExcludeListInclusive()

bool VRay.Plugins.VRayStereoscopicSettings.Set_ExcludeListInclusive	(	bool	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.ExcludeListInclusive

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ExrCompression()

bool VRay.Plugins.VRayStereoscopicSettings.Set_ExrCompression	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.ExrCompression

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_EyeDistance()

bool VRay.Plugins.VRayStereoscopicSettings.Set_EyeDistance	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.EyeDistance

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FilmOffsetXLeft()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FilmOffsetXLeft	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FilmOffsetXLeft

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FilmOffsetXRight()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FilmOffsetXRight	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FilmOffsetXRight

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FilmOffsetYLeft()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FilmOffsetYLeft	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FilmOffsetYLeft

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FilmOffsetYRight()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FilmOffsetYRight	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FilmOffsetYRight

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FloatColorsMode()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FloatColorsMode	(	bool	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FloatColorsMode

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FocusDistance()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FocusDistance	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FocusDistance

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_FocusMethod()

bool VRay.Plugins.VRayStereoscopicSettings.Set_FocusMethod	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.FocusMethod

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_InterocularMethod()

bool VRay.Plugins.VRayStereoscopicSettings.Set_InterocularMethod	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.InterocularMethod

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_LeftCamera()

bool VRay.Plugins.VRayStereoscopicSettings.Set_LeftCamera	(	IPluginRef	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.LeftCamera

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_OutputLayout()

bool VRay.Plugins.VRayStereoscopicSettings.Set_OutputLayout	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.OutputLayout

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_PoleMergeMethod()

bool VRay.Plugins.VRayStereoscopicSettings.Set_PoleMergeMethod	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.PoleMergeMethod

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ReuseThreshold()

bool VRay.Plugins.VRayStereoscopicSettings.Set_ReuseThreshold	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.ReuseThreshold

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_RightCamera()

bool VRay.Plugins.VRayStereoscopicSettings.Set_RightCamera	(	IPluginRef	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.RightCamera

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_ShademapFile()

bool VRay.Plugins.VRayStereoscopicSettings.Set_ShademapFile	(	string	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.ShademapFile

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_SmMode()

bool VRay.Plugins.VRayStereoscopicSettings.Set_SmMode	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.SmMode

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_SpecifyFocus()

bool VRay.Plugins.VRayStereoscopicSettings.Set_SpecifyFocus	(	bool	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.SpecifyFocus

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_TopMergeAngle()

bool VRay.Plugins.VRayStereoscopicSettings.Set_TopMergeAngle	(	float	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.TopMergeAngle

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_View()

bool VRay.Plugins.VRayStereoscopicSettings.Set_View	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.View

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

◆ Set_VrstCompression()

bool VRay.Plugins.VRayStereoscopicSettings.Set_VrstCompression	(	int	val,
		double	time
	)

Sets a value to VRayStereoscopicSettings.VrstCompression

Parameters

val	The value to be set.
time	The time, when the value will be changed.

Returns: false, in case an error occurred.

Property Documentation

◆ AdjustResolution

bool VRay.Plugins.VRayStereoscopicSettings.AdjustResolution

getset

Unused parameter. [UI Guides] gpuSupport=full

Default value: 0

◆ BottomMergeAngle

float VRay.Plugins.VRayStereoscopicSettings.BottomMergeAngle

getset

Panoramic pole merging: from what angle near the bottom does the stereo effect start to fade when rendering with a spherical panorama camera. [UI Guides] minValue=0.0, maxValue=1.5707963, units=radians,gpuSupport=full

Default value: 1.0472

◆ ExcludeListInclusive

bool VRay.Plugins.VRayStereoscopicSettings.ExcludeListInclusive

getset

When on, the exclude_list is considered an 'Include list'. [UI Guides] enableIf: ?sm_mode!=0,gpuSupport=none

Default value: 0

◆ ExrCompression

int VRay.Plugins.VRayStereoscopicSettings.ExrCompression

getset

Compression type for the .exr files (0 - no compression, 1 - RLE compression, 2 - ZIPS compression). [UI Guides] displayName=EXR Compression, enum=0:None;1:RLE;2:ZIPS, enableIf: ?sm_mode=1,gpuSupport=none

Default value: 2

◆ EyeDistance

float VRay.Plugins.VRayStereoscopicSettings.EyeDistance

getset

The eye distance for which the stereoscopic image will be rendered. [UI Guides] minValue=0.0, quantityType=distance,gpuSupport=full

Default value: 6.5

◆ FilmOffsetXLeft

float VRay.Plugins.VRayStereoscopicSettings.FilmOffsetXLeft

getset

Horizontal film offset for the left camera [UI Guides] gpuSupport=full

Default value: 0

◆ FilmOffsetXRight

float VRay.Plugins.VRayStereoscopicSettings.FilmOffsetXRight

getset

Horizontal film offset for the right camera [UI Guides] gpuSupport=full

Default value: 0

◆ FilmOffsetYLeft

float VRay.Plugins.VRayStereoscopicSettings.FilmOffsetYLeft

getset

Vertical film offset for the left camera [UI Guides] gpuSupport=full

Default value: 0

◆ FilmOffsetYRight

float VRay.Plugins.VRayStereoscopicSettings.FilmOffsetYRight

getset

Vertical film offset for the right camera [UI Guides] gpuSupport=full

Default value: 0

◆ FloatColorsMode

bool VRay.Plugins.VRayStereoscopicSettings.FloatColorsMode

getset

Store 32 bit (single precision) color channels in the shade map. When off 16 bit (half precision) values are stored. [UI Guides] displayName=32 Bit Colors, enableIf: ?sm_mode=1,gpuSupport=none

Default value: 0

◆ FocusDistance

float VRay.Plugins.VRayStereoscopicSettings.FocusDistance

getset

The focus distance when specify_focus is enabled. [UI Guides] minValue=0.0, quantityType=distance, enableIf: ?specify_focus=1,gpuSupport=full

Default value: 200

◆ FocusMethod

int VRay.Plugins.VRayStereoscopicSettings.FocusMethod

getset

Specifies the focus method for the two views (0 - none/parallel; 1 - rotation; 2 - shear). [UI Guides] enum=0:None/parallel;1:Rotation;2:Shear,gpuSupport=partial

Default value: 0

◆ InterocularMethod

int VRay.Plugins.VRayStereoscopicSettings.InterocularMethod

getset

Specifies how the two virtual cameras will be placed in relation to the real camera in the scene (0 - symmetric/shift both; 1 - shift left; 2 - shift right). [UI Guides] enum=0:Symmetric/shift both;1:Shift left;2:Shift right,gpuSupport=none

Default value: 0

◆ OutputLayout

int VRay.Plugins.VRayStereoscopicSettings.OutputLayout

getset

Layout of the output image (0 - side-by-side; 1 - top-bottom). [UI Guides] enum=0:Side-by-Side;1:Top-Bottom,gpuSupport=full

Default value: 0

◆ PoleMergeMethod

int VRay.Plugins.VRayStereoscopicSettings.PoleMergeMethod

getset

The method for pole merging (0 - the original V-Ray method; 1 - cosine method that matches other renderers) [UI Guides] gpuSupport=none

Default value: 0

◆ ReuseThreshold

float VRay.Plugins.VRayStereoscopicSettings.ReuseThreshold

getset

Lower values will make V-Ray use less of the shade map and more real shading. [UI Guides] minValue=0.0, maxValue=100.0, enableIf: ?sm_mode=2,gpuSupport=none

Default value: 1

◆ ShademapFile

string VRay.Plugins.VRayStereoscopicSettings.ShademapFile

getset

The name of the file in which the shade map information is stored. [UI Guides] fileAsset=vrst;exr fileAssetNames=V-Ray shade map file;V-Ray deep image file;OpenEXR deep image file, fileAssetOp=bothLoadAndSave, enableIf: ?sm_mode!=0,gpuSupport=none

Default value:

◆ SmMode

int VRay.Plugins.VRayStereoscopicSettings.SmMode

getset

Specifies the mode of operation for the shade map (0 - disabled; 1 - render shade map; 2 - use shade map). [UI Guides] displayName=Shade Map Mode, enum=0:Disabled;1:Render shade map;2:Use shade map, startRollout=,gpuSupport=none

Default value: 0

◆ SpecifyFocus

bool VRay.Plugins.VRayStereoscopicSettings.SpecifyFocus

getset

If on then the focus is determined by focus_method and focus_distance. Otherwise it is determined from the camera target distance. [UI Guides] gpuSupport=full

Default value: 0

◆ TopMergeAngle

float VRay.Plugins.VRayStereoscopicSettings.TopMergeAngle

getset

Panoramic pole merging: from what angle near the top does the stereo effect start to fade when rendering with a spherical panorama camera. [UI Guides] minValue=0.0, maxValue=1.5707963, units=radians,gpuSupport=full

Default value: 1.0472

◆ View

int VRay.Plugins.VRayStereoscopicSettings.View

getset

Specifies which of the stereoscopic views will be rendered (0 - both; 1 - left; 2 - right). [UI Guides] enum=0:Both;1:Left;2:Right,gpuSupport=full

Default value: 0

◆ VrstCompression

int VRay.Plugins.VRayStereoscopicSettings.VrstCompression

getset

Compression type for the .vrst files (0 - no compression, 1 - ZLIB compression). [UI Guides] displayName=VRST Compression, enum=0:None;1:ZLIB, enableIf: ?sm_mode=1,gpuSupport=none

Default value: 1

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/Plugins.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Get_AdjustResolution()

◆ Get_BottomMergeAngle()

◆ Get_ExcludeList()

◆ Get_ExcludeListInclusive()

◆ Get_ExrCompression()

◆ Get_EyeDistance()

◆ Get_FilmOffsetXLeft()

◆ Get_FilmOffsetXRight()

◆ Get_FilmOffsetYLeft()

◆ Get_FilmOffsetYRight()

◆ Get_FloatColorsMode()

◆ Get_FocusDistance()

◆ Get_FocusMethod()

◆ Get_InterocularMethod()

◆ Get_LeftCamera()

◆ Get_OutputLayout()

◆ Get_PoleMergeMethod()

◆ Get_ReuseThreshold()

◆ Get_RightCamera()

◆ Get_ShademapFile()

◆ Get_SmMode()

◆ Get_SpecifyFocus()

◆ Get_TopMergeAngle()

◆ Get_View()

◆ Get_VrstCompression()

◆ Set_AdjustResolution()

◆ Set_BottomMergeAngle()

◆ Set_ExcludeList()

◆ Set_ExcludeListInclusive()

◆ Set_ExrCompression()

◆ Set_EyeDistance()

◆ Set_FilmOffsetXLeft()

◆ Set_FilmOffsetXRight()

◆ Set_FilmOffsetYLeft()

◆ Set_FilmOffsetYRight()

◆ Set_FloatColorsMode()

◆ Set_FocusDistance()

◆ Set_FocusMethod()

◆ Set_InterocularMethod()

◆ Set_LeftCamera()

◆ Set_OutputLayout()

◆ Set_PoleMergeMethod()

◆ Set_ReuseThreshold()

◆ Set_RightCamera()

◆ Set_ShademapFile()

◆ Set_SmMode()

◆ Set_SpecifyFocus()

◆ Set_TopMergeAngle()

◆ Set_View()

◆ Set_VrstCompression()

Property Documentation

◆ AdjustResolution

◆ BottomMergeAngle

◆ ExcludeListInclusive

◆ ExrCompression

◆ EyeDistance

◆ FilmOffsetXLeft

◆ FilmOffsetXRight

◆ FilmOffsetYLeft

◆ FilmOffsetYRight

◆ FloatColorsMode

◆ FocusDistance

◆ FocusMethod

◆ InterocularMethod

◆ OutputLayout

◆ PoleMergeMethod

◆ ReuseThreshold

◆ ShademapFile

◆ SmMode

◆ SpecifyFocus

◆ TopMergeAngle

◆ View

◆ VrstCompression