Member Functions

virtual bool mi::​neuraylib::​ICompiled_material::depends_on_global_distribution() const [pure virtual]

Indicates whether the compiled material depends on global distribution (edf).

virtual bool mi::​neuraylib::​ICompiled_material::depends_on_state_object_id() const [pure virtual]

Indicates whether the compiled material depends on state::object_id().

virtual bool mi::​neuraylib::​ICompiled_material::depends_on_state_transform() const [pure virtual]

Indicates whether the compiled material depends on coordinate space transformations like statetransform() and related functions.

virtual bool mi::​neuraylib::​ICompiled_material::depends_on_uniform_scene_data() const [pure virtual]

Indicates whether the compiled material depends on uniform scene data.

virtual const IValue* mi::​neuraylib::​ICompiled_material::get_argument( Size index) const [pure virtual]

Returns the value of an argument.

Parameters

index

The index of the argument.

Returns

The value of the argument, or NULL if index is out of range.

template< class T>

const T* mi::​neuraylib::​ICompiled_material::get_argument( Size index) const [inline]

Returns the value of an argument. This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a pointer to the type T specified as template argument.

Parameters

index

The index of the argument.

Returns

The value of the argument, or NULL if index is out of range.

virtual const IExpression_direct_call* mi::​neuraylib::​ICompiled_material::get_body() const [pure virtual]

Returns the body (or material root) of the compiled material.

virtual const IString* mi::​neuraylib::​ICompiled_material::get_connected_function_db_name( const char* material_instance_name, Size parameter_index, Sint32* errors = 0) const [pure virtual]

Looks up the DB name of a function call connected to the argument of a compiled material.

Parameters

material_instance_name

The name of the material instance this compiled material was compiled from.

parameter_index

The index of the parameter for which the DB name of the connected function call is to be looked up. For example, if the compiled material has a parameter named "tint.s.texture" the function returns DB name of the function connected to the tint parameter.

errors

An optional pointer to an mi::Sint32 to which an error code will be written. The error codes have the following meaning:

• 0: Success.
• -1: material_instance_name is NULL, or there is no material instance of that name.
• -2: parameter_index is out of bounds.
• -3: The corresponding function call could not be found in the database. This might be due to the fact that the given parameter is not connected to a function or the material instance has been changed after the creation of this compiled material.

Returns

The DB name of the connected function call, or NULL in case of errors.

virtual bool mi::​neuraylib::​ICompiled_material::get_cutout_opacity( Float32* cutout_opacity) const [pure virtual]

Returns the cutout opacity (provided it is a constant).

See also:

get_opacity() and get_surface_opacity()

Parameters

cutout_opacity

The cutout opacity value in case of success.

Returns

true in case of success, false if the value is not a constant, but depends on parameters or complex user expressions.

virtual base::​Uuid mi::​neuraylib::​ICompiled_material::get_hash() const [pure virtual]

Returns a hash of the body and all temporaries. The hash allows to quickly identify compiled materials that have the same body, temporaries, and parameter names. Note that the arguments themselves are not included in the hash value.

Note:

For performance reasons, the hash for resources does not include the actual resource data, but certain properties to identify resources: If the absolute MDL file path is available, it is used (including the gamma value and selector for textures). If the absolute MDL file path is not available, some internal IDs that identify the resource in the database are used instead.

For the latter case, the following applies: If two otherwise identical compiled materials share a resource (in the sense of there is one and only one DB element for that resource), then their hash is also identical. But if the compiled materials use distinct (but otherwise identical) copies of the same DB element, then their IDs are different, resulting in different hashes. IDs are also different if a module is removed from the database, and later loaded again. IDs might be different if the module is loaded in different processes.

See also:

get_slot_hash() for hashes of predefined material slots, and get_sub_expression_hash() for hashes of arbitrary subexpressions

virtual Float32 mi::​neuraylib::​ICompiled_material::get_mdl_meters_per_scene_unit() const [pure virtual]

Returns the conversion ration between meters and scene units.

virtual Float32 mi::​neuraylib::​ICompiled_material::get_mdl_wavelength_max() const [pure virtual]

Returns the largest supported wavelength.

virtual Float32 mi::​neuraylib::​ICompiled_material::get_mdl_wavelength_min() const [pure virtual]

Returns the smallest supported wavelength.

virtual Material_opacity mi::​neuraylib::​ICompiled_material::get_opacity() const [pure virtual]

Returns the opacity of the compiled material. The method returns OPACITY_TRANSPARENT if the cutout opacity is a constant and less than 1.0. Otherwise it checks whether a transmissive BSDF is present in the surface.scattering slot.

See get_surface_opacity() for a variant ignoring the cutout opacity, and get_cutout_opacity() to retrieve the cutout opacity itself.

virtual Size mi::​neuraylib::​ICompiled_material::get_parameter_count() const [pure virtual]

Returns the number of parameters used by this compiled material. Parameters and arguments only exist in class compilation mode. This method always returns 0 in instance compilation mode.

virtual const char* mi::​neuraylib::​ICompiled_material::get_parameter_name( Size index) const [pure virtual]

Returns the name of a parameter. In class compilation mode, the parameters are named according to the path to the corresponding node in the open material graph that served as basis for the compiled material. For example, the path "a.b.x" refers to a parameter named "x" on a node connected to a parameter named "b" on a node connected to the parameter "a" of the material instance that has been compiled.

Note that these paths here correspond to the open material graph that served as basis for the compiled material, and not to the structure of the resulting compiled material, as it is the case for lookup_sub_expression() or get_sub_expression_hash().

Parameters

index

The index of the parameter.

Returns

The name of the parameter, or NULL if index is out of range.

virtual Size mi::​neuraylib::​ICompiled_material::get_referenced_scene_data_count() const [pure virtual]

Returns the number of scene data attributes referenced by this compiled material.

virtual const char* mi::​neuraylib::​ICompiled_material::get_referenced_scene_data_name( Size index) const [pure virtual]

Return the name of a scene data attribute referenced by this compiled material.

Parameters

index

The index of the scene data attribute.

virtual base::​Uuid mi::​neuraylib::​ICompiled_material::get_slot_hash( Material_slot slot) const [pure virtual]

Returns the hash of a particular material slot. The hash allows to quickly identify compiled materials where a particular material slot is identical (corresponding parts of the body and temporaries, and all parameter names). Note that the arguments themselves are not included in the hash value. See get_hash() for details about resources.

See also:

get_hash() for a hash covering all slots in one hash value, and get_sub_expression_hash() for hashes of arbitrary subexpressions

virtual base::​Uuid mi::​neuraylib::​ICompiled_material::get_sub_expression_hash( const char* path) const [pure virtual]

Returns the hash of a sub-expression of the compiled material. The hash allows to quickly identify compiled materials where a particular sub-expression is identical (corresponding parts of the body and temporaries, and all parameter names). Note that the arguments themselves are not included in the hash value. See get_hash() for details about resources.

Note:

This hash value is computed on-demand, unless the path corresponds to one of the predefined material slots, for which the method simply returns the precomputed hash value.

See also:

get_hash() for a hash covering all slots in one hash value, and get_slot_hash() for hashes of predefined material slots

Parameters

path

The path from the material root to the expression that should be hashed, e.g., "surface.scattering.tint". An empty path can be used to identify the entire compiled material.

Returns

A hash for the sub-expression identified by path , or default-constructed in case invalid paths.

virtual Material_opacity mi::​neuraylib::​ICompiled_material::get_surface_opacity() const [pure virtual]

Returns the surface opacity of the compiled material. The methods checks whether a transmissive BSDF is present in the surface.scattering slot.

See get_opacity() for a variant taking the cutout opacity into account, and get_cutout_opacity() to retrieve the cutout opacity itself.

virtual const IExpression* mi::​neuraylib::​ICompiled_material::get_temporary( Size index) const [pure virtual]

Returns a temporary.

Parameters

index

The index of the temporary.

Returns

The expression of the temporary, or NULL if index is out of range.

template< class T>

const T* mi::​neuraylib::​ICompiled_material::get_temporary( Size index) const [inline]

Returns the expression of a temporary. This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface( const Uuid &) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Parameters

index

The index of the temporary.

Returns

The expression of the temporary, or NULL if index is out of range.

virtual Size mi::​neuraylib::​ICompiled_material::get_temporary_count() const [pure virtual]

Returns the number of temporaries.

virtual bool mi::​neuraylib::​ICompiled_material::is_valid( IMdl_execution_context* context) const [pure virtual]

Indicates whether the compiled material is valid. A compiled material becomes invalid, if any of the modules it uses definitions from has has been reloaded.

Parameters

context

In case of failure, the execution context can be checked for error messages. Can be NULL.

virtual const IExpression* mi::​neuraylib::​ICompiled_material::lookup_sub_expression( const char* path) const [pure virtual]

Looks up a sub-expression of the compiled material.

Parameters

path

The path from the material root to the expression that should be returned, e.g., "surface.scattering.tint".

Returns

A sub-expression for expr according to path , or NULL in case of errors.