imaterial_instance.h

Go to the documentation of this file.

/***************************************************************************************************
 * Copyright 2022 NVIDIA Corporation. All rights reserved.
 **************************************************************************************************/

#ifndef MI_NEURAYLIB_IMATERIAL_INSTANCE_H
#define MI_NEURAYLIB_IMATERIAL_INSTANCE_H

#include <mi/neuraylib/iexpression.h>
#include <mi/neuraylib/ifunction_call.h>
#include <mi/neuraylib/iscene_element.h>
#include <mi/neuraylib/imdl_factory.h>

namespace mi {

namespace neuraylib {

class ICompiled_material;
class IMdl_execution_context;

class IMaterial_instance : public
    mi::base::Interface_declare<0x037ec156,0x281d,0x466a,0xa1,0x56,0x3e,0xd6,0x83,0xe9,0x5a,0x00,
                                neuraylib::IScene_element>
{
public:
    enum Compilation_options {
        DEFAULT_OPTIONS   = 0, 
        CLASS_COMPILATION = 1, 
        COMPILATION_OPTIONS_FORCE_32_BIT = 0xffffffffU // Undocumented, for alignment only
    };

    mi_static_assert( sizeof( Compilation_options) == sizeof( mi::Uint32));

    virtual ICompiled_material* create_compiled_material(
        Uint32 flags,
        IMdl_execution_context* context = 0) const = 0;

    virtual const char* get_material_definition() const = 0;

    virtual const char* get_mdl_material_definition() const = 0;

    virtual const IType* get_return_type() const = 0;

    virtual Size get_parameter_count() const = 0;

    virtual const char* get_parameter_name( Size index) const = 0;

    virtual Size get_parameter_index( const char* name) const = 0;

    virtual const IType_list* get_parameter_types() const = 0;

    virtual const IExpression_list* get_arguments() const = 0;

    virtual Sint32 set_arguments( const IExpression_list* arguments) = 0;

    virtual Sint32 set_argument( Size index, const IExpression* argument) = 0;

    virtual Sint32 set_argument( const char* name, const IExpression* argument) = 0;

    virtual Sint32 reset_argument( Size index) = 0;

    virtual Sint32 reset_argument( const char* name) = 0;

    virtual bool is_default() const = 0;

    virtual bool is_valid( IMdl_execution_context* context) const = 0;

    virtual Sint32 repair(
        Uint32 flags,
        IMdl_execution_context* context) = 0;
};
 // end group mi_neuray_mdl_elements

} // namespace neuraylib

} // namespace mi

#endif // MI_NEURAYLIB_IMATERIAL_INSTANCE_H