VRay SDK for C#
Loading...
Searching...
No Matches
VRay.Plugins.RenderChannelExtraTexFloat Class Reference

Contains the result of rendering a specified float texture More...

Inherits VRay.Plugins.Plugin, VRay.Plugins.IPluginRef< RenderChannelExtraTexFloat >, and VRay.Plugins.IRenderChannelPluginCategory.

Public Member Functions

bool Get_AffectMatteObjects (double time)
 Gets the value of RenderChannelExtraTexFloat.AffectMatteObjects More...
 
float Get_DefaultValue (double time)
 Gets the value of RenderChannelExtraTexFloat.DefaultValue More...
 
bool Get_EnableDeepOutput (double time)
 Gets the value of RenderChannelExtraTexFloat.EnableDeepOutput More...
 
IList< object > Get_ExcludeList (double time)
 Gets the value of RenderChannelExtraTexFloat.ExcludeList More...
 
bool Get_ExcludeListAsInclusiveSet (double time)
 Gets the value of RenderChannelExtraTexFloat.ExcludeListAsInclusiveSet More...
 
bool Get_Force32BitOutput (double time)
 Gets the value of RenderChannelExtraTexFloat.Force32BitOutput More...
 
bool Get_ForceLosslessCompression (double time)
 Gets the value of RenderChannelExtraTexFloat.ForceLosslessCompression More...
 
string Get_RenderChannelExtraTexFloatName (double time)
 Gets the value of RenderChannelExtraTexFloat.RenderChannelExtraTexFloatName More...
 
object Get_Texmap (double time)
 Gets the value of RenderChannelExtraTexFloat.Texmap More...
 
bool Set_AffectMatteObjects (bool val, double time)
 Sets a value to RenderChannelExtraTexFloat.AffectMatteObjects More...
 
bool Set_DefaultValue (float val, double time)
 Sets a value to RenderChannelExtraTexFloat.DefaultValue More...
 
bool Set_EnableDeepOutput (bool val, double time)
 Sets a value to RenderChannelExtraTexFloat.EnableDeepOutput More...
 
bool Set_ExcludeList (IList< object > val, double time)
 Sets a value to RenderChannelExtraTexFloat.ExcludeList More...
 
bool Set_ExcludeListAsInclusiveSet (bool val, double time)
 Sets a value to RenderChannelExtraTexFloat.ExcludeListAsInclusiveSet More...
 
bool Set_Force32BitOutput (bool val, double time)
 Sets a value to RenderChannelExtraTexFloat.Force32BitOutput More...
 
bool Set_ForceLosslessCompression (bool val, double time)
 Sets a value to RenderChannelExtraTexFloat.ForceLosslessCompression More...
 
bool Set_RenderChannelExtraTexFloatName (string val, double time)
 Sets a value to RenderChannelExtraTexFloat.RenderChannelExtraTexFloatName More...
 
bool Set_Texmap (object val, double time)
 Sets a value to RenderChannelExtraTexFloat.Texmap 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< RenderChannelExtraTexFloat >
string ToString ()
 
new string ToString ()
 

Static Public Member Functions

static RenderChannelExtraTexFloat GetInstance (VRayRenderer renderer, string name)
 Use renderer to find and return a RenderChannelExtraTexFloat instance with the given name
 
static RenderChannelExtraTexFloat NewInstance (VRayRenderer renderer, string name)
 Use renderer to create and return a RenderChannelExtraTexFloat instance
 

Properties

bool AffectMatteObjects [get, set]
 false to not affect Matte Objects More...
 
float DefaultValue [get, set]
 The value where no intersection occurred (e.g. background) [UI Guides] gpuSupport=none More...
 
bool EnableDeepOutput [get, set]
 (description missing) [UI Guides] gpuSupport=none More...
 
IList< object > ExcludeList [get, set]
 Depending on the value of exclude_list_as_inclusive_set, a list of plugins that will be affected or ignored by the texture
 
bool ExcludeListAsInclusiveSet [get, set]
 When true apply extra texture only to objects in exclude_list. When false apply extra texture to all objects out of exclude_list More...
 
bool Force32BitOutput [get, set]
 Forces 32-bit float output even in half-float images More...
 
bool ForceLosslessCompression [get, set]
 Forces lossless compression for this channel when DWAA/DWAB compression is used More...
 
string RenderChannelExtraTexFloatName [get, set]
 Display name of this render channel More...
 
object Texmap [get, set]
 The texture that will be rendered into this channel 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< RenderChannelExtraTexFloat >
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

Contains the result of rendering a specified float texture

Member Function Documentation

◆ Get_AffectMatteObjects()

bool VRay.Plugins.RenderChannelExtraTexFloat.Get_AffectMatteObjects ( double  time)

Gets the value of RenderChannelExtraTexFloat.AffectMatteObjects

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_DefaultValue()

float VRay.Plugins.RenderChannelExtraTexFloat.Get_DefaultValue ( double  time)

Gets the value of RenderChannelExtraTexFloat.DefaultValue

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_EnableDeepOutput()

bool VRay.Plugins.RenderChannelExtraTexFloat.Get_EnableDeepOutput ( double  time)

Gets the value of RenderChannelExtraTexFloat.EnableDeepOutput

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ExcludeList()

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

Gets the value of RenderChannelExtraTexFloat.ExcludeList

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ExcludeListAsInclusiveSet()

bool VRay.Plugins.RenderChannelExtraTexFloat.Get_ExcludeListAsInclusiveSet ( double  time)

Gets the value of RenderChannelExtraTexFloat.ExcludeListAsInclusiveSet

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Force32BitOutput()

bool VRay.Plugins.RenderChannelExtraTexFloat.Get_Force32BitOutput ( double  time)

Gets the value of RenderChannelExtraTexFloat.Force32BitOutput

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_ForceLosslessCompression()

bool VRay.Plugins.RenderChannelExtraTexFloat.Get_ForceLosslessCompression ( double  time)

Gets the value of RenderChannelExtraTexFloat.ForceLosslessCompression

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_RenderChannelExtraTexFloatName()

string VRay.Plugins.RenderChannelExtraTexFloat.Get_RenderChannelExtraTexFloatName ( double  time)

Gets the value of RenderChannelExtraTexFloat.RenderChannelExtraTexFloatName

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Get_Texmap()

object VRay.Plugins.RenderChannelExtraTexFloat.Get_Texmap ( double  time)

Gets the value of RenderChannelExtraTexFloat.Texmap

Parameters
timeThe time, when the value is requested.
Returns
The value of the property.

◆ Set_AffectMatteObjects()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_AffectMatteObjects ( bool  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.AffectMatteObjects

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_DefaultValue()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_DefaultValue ( float  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.DefaultValue

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_EnableDeepOutput()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_EnableDeepOutput ( bool  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.EnableDeepOutput

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ExcludeList()

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

Sets a value to RenderChannelExtraTexFloat.ExcludeList

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ExcludeListAsInclusiveSet()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_ExcludeListAsInclusiveSet ( bool  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.ExcludeListAsInclusiveSet

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Force32BitOutput()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_Force32BitOutput ( bool  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.Force32BitOutput

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_ForceLosslessCompression()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_ForceLosslessCompression ( bool  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.ForceLosslessCompression

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_RenderChannelExtraTexFloatName()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_RenderChannelExtraTexFloatName ( string  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.RenderChannelExtraTexFloatName

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

◆ Set_Texmap()

bool VRay.Plugins.RenderChannelExtraTexFloat.Set_Texmap ( object  val,
double  time 
)

Sets a value to RenderChannelExtraTexFloat.Texmap

Parameters
valThe value to be set.
timeThe time, when the value will be changed.
Returns
false, in case an error occurred.

Property Documentation

◆ AffectMatteObjects

bool VRay.Plugins.RenderChannelExtraTexFloat.AffectMatteObjects
getset

false to not affect Matte Objects

Default value: 1

◆ DefaultValue

float VRay.Plugins.RenderChannelExtraTexFloat.DefaultValue
getset

The value where no intersection occurred (e.g. background) [UI Guides] gpuSupport=none

Default value: 0

◆ EnableDeepOutput

bool VRay.Plugins.RenderChannelExtraTexFloat.EnableDeepOutput
getset

(description missing) [UI Guides] gpuSupport=none

Default value: 1

◆ ExcludeListAsInclusiveSet

bool VRay.Plugins.RenderChannelExtraTexFloat.ExcludeListAsInclusiveSet
getset

When true apply extra texture only to objects in exclude_list. When false apply extra texture to all objects out of exclude_list

Default value: 0

◆ Force32BitOutput

bool VRay.Plugins.RenderChannelExtraTexFloat.Force32BitOutput
getset

Forces 32-bit float output even in half-float images

Default value: 0

◆ ForceLosslessCompression

bool VRay.Plugins.RenderChannelExtraTexFloat.ForceLosslessCompression
getset

Forces lossless compression for this channel when DWAA/DWAB compression is used

Default value: 0

◆ RenderChannelExtraTexFloatName

string VRay.Plugins.RenderChannelExtraTexFloat.RenderChannelExtraTexFloatName
getset

Display name of this render channel

Default value: ExtraTexChannel

◆ Texmap

object VRay.Plugins.RenderChannelExtraTexFloat.Texmap
getset

The texture that will be rendered into this channel

Default value: 0


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