MDL SDK API nvidia_logo_transpbg.gif Up
imdl_backend.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_IMDL_BACKEND_H
8#define MI_NEURAYLIB_IMDL_BACKEND_H
9
12#include <mi/neuraylib/ivalue.h>
16
17namespace mi {
18
19namespace neuraylib {
20
21class IBuffer;
22class ICompiled_material;
23class IFunction_definition;
24class IFunction_call;
25class ILink_unit;
26class IMdl_execution_context;
27class ITarget_code;
28class ITarget_argument_block;
29class ITransaction;
30
31struct Target_function_description;
32
38class IMdl_backend : public
39 mi::base::Interface_declare<0x9ecdd747,0x20b8,0x4a8a,0xb1,0xe2,0x62,0xb2,0x62,0x30,0xd3,0x67>
40{
41public:
80#if !defined(MDL_SOURCE_RELEASE) && defined(MDL_ENABLE_INTERPRETER)
86#endif
341 virtual Sint32 set_option( const char* name, const char* value) = 0;
342
358 const char* name,
359 const char* data,
360 Size size) = 0;
361
366 virtual const Uint8* get_device_library( Size &size) const = 0;
367
407 ITransaction* transaction,
408 const IFunction_call* call,
409 const char* fname,
410 IMdl_execution_context* context) = 0;
411
450 ITransaction* transaction,
451 const ICompiled_material* material,
452 const char* path,
453 const char* fname,
454 IMdl_execution_context* context) = 0;
455
489 ITransaction* transaction,
490 const ICompiled_material* material,
491 const char* path,
492 const char* base_fname,
493 IMdl_execution_context* context) = 0;
494
522 ITransaction* transaction,
523 const ICompiled_material* material,
524 Target_function_description* function_descriptions,
525 Size description_count,
526 IMdl_execution_context* context) = 0;
527
547 ITransaction* transaction,
548 IMdl_execution_context* context) = 0;
549
565 const ILink_unit* lu, IMdl_execution_context* context) = 0;
566
587 ITransaction* transaction,
588 const IBuffer* buffer,
589 IMdl_execution_context* context) const = 0;
590
612 ITransaction* transaction,
613 const Uint8* buffer_data,
614 Size buffer_size,
615 IMdl_execution_context* context) const = 0;
616};
617
622 mi::base::Interface_declare<0xe7559a88,0x9a9a,0x41d8,0xa1,0x9c,0x4a,0x52,0x4e,0x4b,0x7b,0x66>
623{
624public:
641#ifndef MDL_SOURCE_RELEASE
644#endif // MDL_SOURCE_RELEASE
649 virtual Uint32 get_resource_index(IValue_resource const *resource) = 0;
650
656 virtual Uint32 get_string_index(IValue_string const *s) = 0;
657};
658
666 mi::base::Interface_declare<0xf2a5db20,0x85ab,0x4c41,0x8c,0x5f,0x49,0xc8,0x29,0x4a,0x73,0x65>
667{
668public:
670 virtual const char* get_data() const = 0;
671
673 virtual char* get_data() = 0;
674
676 virtual Size get_size() const = 0;
677
679 virtual ITarget_argument_block *clone() const = 0;
680};
681
684 Target_value_layout_state(mi::Uint32 state_offs = 0, mi::Uint32 data_offs = 0)
685 : m_state_offs(state_offs)
686 , m_data_offs(data_offs)
687 {}
688
691
694};
695
706 mi::base::Interface_declare<0x1003351f,0x0c31,0x4a9d,0xb9,0x99,0x90,0xb5,0xe4,0xb4,0x71,0xe3>
707{
708public:
710 virtual Size get_size() const = 0;
711
718
730 IValue::Kind &kind,
731 Size &arg_size,
733
744 Size i,
746
764 char *block,
765 IValue const *value,
766 ITarget_resource_callback *resource_callback,
768};
769
771class ITarget_code : public
772 mi::base::Interface_declare<0xefca46ae,0xd530,0x4b97,0x9d,0xab,0x3a,0xdb,0x0c,0x58,0xc3,0xac>
773{
774public:
777 SU_POSITION = 0x0001u,
778 SU_NORMAL = 0x0002u,
780 SU_MOTION = 0x0008u,
785 SU_DIRECTION = 0x0100u,
788
790
791 SU_TRANSFORMS = 0x0800u,
792 SU_OBJECT_ID = 0x1000u,
793
795
796 SU_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
797 }; // can be or'ed
798
799 typedef Uint32 State_usage;
800
809 Texture_shape_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
810 };
811
814 SL_CUDA,
815 SL_PTX,
816 SL_HLSL,
817 SL_GLSL,
818 SL_NUM_LANGUAGES,
819 SL_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
820 };
821
824 {
825 DK_NONE,
826 DK_BSDF,
827 DK_HAIR_BSDF,
828 DK_EDF,
829 DK_INVALID,
830 DK_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
831 };
832
835 FK_INVALID,
836 FK_LAMBDA,
837 FK_SWITCH_LAMBDA,
838 FK_ENVIRONMENT,
839 FK_CONST,
840 FK_DF_INIT,
841 FK_DF_SAMPLE,
842 FK_DF_EVALUATE,
843 FK_DF_PDF,
844 FK_DF_AUXILIARY,
845 FK_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
846 };
847
850 GM_GAMMA_DEFAULT,
851 GM_GAMMA_LINEAR,
852 GM_GAMMA_SRGB,
853 GM_GAMMA_UNKNOWN,
854 GM_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
855 };
856
859
861 virtual const char* get_code() const = 0;
862
864 virtual Size get_code_size() const = 0;
865
868
878 virtual const char* get_callable_function( Size index) const = 0;
879
881
882
884 virtual Size get_texture_count() const = 0;
885
892 virtual const char* get_texture( Size index) const = 0;
893
901 virtual const char* get_texture_url( Size index) const = 0;
902
909 virtual const char* get_texture_owner_module( Size index) const = 0;
910
917 virtual bool get_texture_is_body_resource( Size index) const = 0;
918
924 virtual Gamma_mode get_texture_gamma( Size index) const = 0;
925
932 virtual const char* get_texture_selector( Size index) const = 0;
933
939 virtual Texture_shape get_texture_shape( Size index) const = 0;
940
947 virtual Df_data_kind get_texture_df_data_kind( Size index) const = 0;
948
961 Size index,
962 Size &rx,
963 Size &ry,
964 Size &rz) const = 0;
965
967
969
971 virtual Size get_light_profile_count() const = 0;
972
978 virtual const char* get_light_profile( Size index) const = 0;
979
987 virtual const char* get_light_profile_url( Size index) const = 0;
988
995 virtual const char* get_light_profile_owner_module( Size index) const = 0;
996
1003 virtual bool get_light_profile_is_body_resource( Size index) const = 0;
1004
1006
1008
1011
1017 virtual const char* get_bsdf_measurement(Size index) const = 0;
1018
1026 virtual const char* get_bsdf_measurement_url( Size index) const = 0;
1027
1034 virtual const char* get_bsdf_measurement_owner_module( Size index) const = 0;
1035
1043 virtual bool get_bsdf_measurement_is_body_resource( Size index) const = 0;
1044
1046
1048 virtual Size get_ro_data_segment_count() const = 0;
1049
1055 virtual const char* get_ro_data_segment_name( Size index) const = 0;
1056
1061 virtual Size get_ro_data_segment_size( Size index) const = 0;
1062
1068 virtual const char* get_ro_data_segment_data( Size index) const = 0;
1069
1071 virtual Size get_code_segment_count() const = 0;
1072
1077 virtual const char* get_code_segment( Size index) const = 0;
1078
1083 virtual Size get_code_segment_size( Size index) const = 0;
1084
1089 virtual const char* get_code_segment_description( Size index) const = 0;
1090
1095 virtual State_usage get_render_state_usage() const = 0;
1096
1098 virtual Size get_argument_block_count() const = 0;
1099
1106 virtual const ITarget_argument_block *get_argument_block(Size index) const = 0;
1107
1119 Size index,
1120 const ICompiled_material *material,
1121 ITarget_resource_callback *resource_callback) const = 0;
1122
1124 virtual Size get_argument_layout_count() const = 0;
1125
1131 virtual const ITarget_value_layout *get_argument_block_layout(Size index) const = 0;
1132
1134 virtual Size get_string_constant_count() const = 0;
1135
1141 virtual const char* get_string_constant(Size index) const = 0;
1142
1149 ITransaction* transaction,
1150 IValue_resource const *resource) const = 0;
1151
1160 const = 0;
1161
1169
1176
1184
1202 Size index,
1203 const Shading_state_environment& state,
1204 Texture_handler_base* tex_handler,
1205 Spectrum_struct* result) const = 0;
1206
1228 Size index,
1229 const Shading_state_material& state,
1230 Texture_handler_base* tex_handler,
1231 const ITarget_argument_block *cap_args,
1232 void* result) const = 0;
1233
1255 Size index,
1257 Texture_handler_base* tex_handler,
1258 const ITarget_argument_block *cap_args) const = 0;
1259
1278 Size index,
1279 Bsdf_sample_data *data,
1280 const Shading_state_material& state,
1281 Texture_handler_base* tex_handler,
1282 const ITarget_argument_block *cap_args) const = 0;
1283
1303 Size index,
1305 const Shading_state_material& state,
1306 Texture_handler_base* tex_handler,
1307 const ITarget_argument_block *cap_args) const = 0;
1308
1328 Size index,
1329 Bsdf_pdf_data *data,
1330 const Shading_state_material& state,
1331 Texture_handler_base* tex_handler,
1332 const ITarget_argument_block *cap_args) const = 0;
1333
1334
1354 Size index,
1356 const Shading_state_material& state,
1357 Texture_handler_base* tex_handler,
1358 const ITarget_argument_block *cap_args) const = 0;
1359
1360
1382 Size index,
1384 Texture_handler_base* tex_handler,
1385 const ITarget_argument_block *cap_args) const = 0;
1386
1405 Size index,
1406 Edf_sample_data *data,
1407 const Shading_state_material& state,
1408 Texture_handler_base* tex_handler,
1409 const ITarget_argument_block *cap_args) const = 0;
1410
1430 Size index,
1432 const Shading_state_material& state,
1433 Texture_handler_base* tex_handler,
1434 const ITarget_argument_block *cap_args) const = 0;
1435
1455 Size index,
1456 Edf_pdf_data *data,
1457 const Shading_state_material& state,
1458 Texture_handler_base* tex_handler,
1459 const ITarget_argument_block *cap_args) const = 0;
1460
1461
1481 Size index,
1483 const Shading_state_material& state,
1484 Texture_handler_base* tex_handler,
1485 const ITarget_argument_block *cap_args) const = 0;
1486
1493 virtual Size get_callable_function_df_handle_count( Size func_index) const = 0;
1494
1502 virtual const char* get_callable_function_df_handle( Size func_index, Size handle_index)
1503 const = 0;
1504
1507 virtual bool supports_serialization() const = 0;
1508
1526 virtual const IBuffer* serialize( IMdl_execution_context* context) const = 0;
1527
1535 virtual State_usage get_callable_function_render_state_usage( Size index) const = 0;
1536
1559 Size index,
1561 Texture_handler_base* tex_handler,
1562 const ITarget_argument_block *cap_args) const = 0;
1563
1564 virtual Size MI_NEURAYLIB_DEPRECATED_METHOD_14_0(get_body_texture_count)() const = 0;
1565
1566 virtual Size MI_NEURAYLIB_DEPRECATED_METHOD_14_0(get_body_light_profile_count)() const = 0;
1567
1568 virtual Size MI_NEURAYLIB_DEPRECATED_METHOD_14_0(get_body_bsdf_measurement_count)() const = 0;
1569};
1570
1572class ILink_unit : public
1573 mi::base::Interface_declare<0x1df9bbb0,0x5d96,0x475f,0x9a,0xf4,0x07,0xed,0x8c,0x2d,0xfd,0xdb>
1574{
1575public:
1602 const ICompiled_material* inst,
1603 const char* path,
1604 const char* fname,
1605 IMdl_execution_context* context) = 0;
1606
1643 const ICompiled_material* material,
1644 const char* path,
1645 const char* base_fname,
1646 IMdl_execution_context* context) = 0;
1647
1683 const ICompiled_material* material,
1684 Target_function_description* function_descriptions,
1685 Size description_count,
1686 IMdl_execution_context* context) = 0;
1687
1693 FEC_FORCE_32_BIT = 0xFFFFFFFFu // Undocumented, for alignment only
1694 };
1695
1716 const IFunction_call *call,
1718 const char *fname,
1719 IMdl_execution_context *context = 0) = 0;
1720
1741 const IFunction_definition *function,
1743 const char *fname,
1744 IMdl_execution_context *context) = 0;
1745
1746 virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_14_0(add_environment)(
1747 const IFunction_call *call,
1748 const char *fname,
1749 IMdl_execution_context *context = 0) = 0;
1750};
1751
1754{
1756 const char* expression_path = 0,
1757 const char* base_function_name = 0)
1758 : path(expression_path)
1759 , base_fname(base_function_name)
1761 , function_index(~Size(0))
1762 , distribution_kind(ITarget_code::DK_INVALID)
1763 , return_code(~Sint32(0)) // not processed
1764 {
1765 }
1766
1769 const char* path;
1770
1775 const char* base_fname;
1776
1782
1792
1796
1829};
1830
1838
1839} // namespace neuraylib
1840
1841} // namespace mi
1842
1843#endif // MI_NEURAYLIB_IMDL_BACKEND_H
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
Abstract interface for a simple buffer with binary data.
Definition: ibuffer.h:25
This interface represents a compiled material.
Definition: icompiled_material.h:97
This interface represents a function call.
Definition: ifunction_call.h:52
This interface represents a function definition.
Definition: ifunction_definition.h:44
Mdl_backend_kind
Currently available MDL backends.
Definition: imdl_backend_api.h:60
MDL backends allow to transform compiled material instances or function calls into target code.
Definition: imdl_backend.h:40
The execution context can be used to query status information like error and warning messages concern...
Definition: imdl_execution_context.h:131
Represents an argument block of a class-compiled material compiled for a specific target.
Definition: imdl_backend.h:667
Represents target code of an MDL backend.
Definition: imdl_backend.h:773
A callback interface to allow the user to handle resources when creating new mi::neuraylib::ITarget_a...
Definition: imdl_backend.h:623
Represents the layout of an mi::neuraylib::ITarget_argument_block with support for nested elements.
Definition: imdl_backend.h:707
A transaction provides a consistent view on the database.
Definition: itransaction.h:84
Base class for resource values.
Definition: ivalue.h:490
A value of type string.
Definition: ivalue.h:221
The interface to MDL values.
Definition: ivalue.h:33
Kind
The possible kinds of values.
Definition: ivalue.h:36
#define mi_static_assert(expr)
Compile time assertion that raises a compilation error if the constant expression expr evaluates to f...
Definition: assert.h:58
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
unsigned char Uint8
8-bit unsigned integer.
Definition: types.h:47
Uint64 Size
Unsigned integral type that is large enough to hold the size of all types.
Definition: types.h:112
float Float32
32-bit float.
Definition: types.h:51
signed int Sint32
32-bit signed integer.
Definition: types.h:46
virtual Size get_size() const =0
Returns the size of the target argument block data.
virtual const char * get_texture_owner_module(Size index) const =0
Returns the owner module name of a relative texture file path.
Function_execution_context
Execution context for functions.
Definition: imdl_backend.h:1689
virtual Sint32 execute(Size index, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args, void *result) const =0
Run this code on the native CPU with the given captured arguments block.
ITarget_code::Distribution_kind distribution_kind
Return the distribution kind of this function (or NONE in case expressions).
Definition: imdl_backend.h:1795
virtual Sint32 execute_bsdf_pdf(Size index, Bsdf_pdf_data *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the BSDF PDF calculation function for this code on the native CPU.
virtual const char * get_code() const =0
Returns the represented target code in ASCII representation.
virtual const ITarget_code * translate_link_unit(const ILink_unit *lu, IMdl_execution_context *context)=0
Transforms a link unit to target code.
virtual const Float32 * get_texture_df_data(Size index, Size &rx, Size &ry, Size &rz) const =0
Returns the distribution function data this texture refers to.
virtual Sint32 set_option(const char *name, const char *value)=0
Sets a backend option.
virtual const char * get_texture(Size index) const =0
Returns the name of a texture resource used by the target code.
const char * path
The path from the material root to the expression that should be translated, e.g.,...
Definition: imdl_backend.h:1769
State_usage_property
The potential state usage properties.
Definition: imdl_backend.h:776
virtual Size get_bsdf_measurement_count() const =0
Returns the number of bsdf measurement resources used by the target code.
virtual Size get_num_elements(Target_value_layout_state state=Target_value_layout_state()) const =0
Get the number of arguments / elements at the given layout state.
virtual Texture_shape get_texture_shape(Size index) const =0
Returns the texture shape of a given texture resource used by the target code.
virtual Sint32 set_value(char *block, IValue const *value, ITarget_resource_callback *resource_callback, Target_value_layout_state state=Target_value_layout_state()) const =0
Set the value inside the given block at the given layout state.
virtual Size get_ro_data_segment_count() const =0
Returns the number of constant data initializers.
virtual bool get_light_profile_is_body_resource(Size index) const =0
Check whether the light profile resource is coming from the body of expressions (not solely from mate...
virtual const Uint8 * get_device_library(Size &size) const =0
Returns the representation of a device library for this backend if one exists.
virtual Size get_argument_layout_count() const =0
Returns the number of target argument block layouts.
Distribution_kind
Possible kinds of distribution functions.
Definition: imdl_backend.h:824
virtual Sint32 add_material(const ICompiled_material *material, Target_function_description *function_descriptions, Size description_count, IMdl_execution_context *context)=0
Add (multiple) MDL distribution functions and expressions of a material to this link unit.
virtual Target_value_layout_state get_nested_state(Size i, Target_value_layout_state state=Target_value_layout_state()) const =0
Get the layout state for the i'th argument / element inside the argument value block at the given lay...
virtual const char * get_texture_selector(Size index) const =0
Returns the selector mode of a texture resource used by the target code.
virtual Sint32 execute_edf_auxiliary(Size index, Edf_auxiliary_data_base *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the EDF auxiliary calculation function for this code on the native CPU.
virtual const char * get_callable_function_prototype(Size index, Prototype_language lang) const =0
Returns the prototype of a callable function in the target code.
virtual Size get_ro_data_segment_size(Size index) const =0
Returns the size of the constant data segment at the given index.
virtual Function_kind get_callable_function_kind(Size index) const =0
Returns the function kind of a callable function in the target code.
virtual Sint32 add_function(const IFunction_definition *function, Function_execution_context fexc, const char *fname, IMdl_execution_context *context)=0
Add an MDL function definition as a function to this link unit.
virtual Size get_callable_function_argument_block_index(Size index) const =0
Get the index of the target argument block to use with a callable function.
virtual Df_data_kind get_texture_df_data_kind(Size index) const =0
Returns the distribution function data kind of a given texture resource used by the target code.
virtual Sint32 execute_edf_init(Size index, Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the EDF init function for this code on the native CPU.
virtual IMdl_backend_api::Mdl_backend_kind get_backend_kind() const =0
Returns the kind of backend this information belongs to.
mi::Uint32 m_state_offs
The offset inside the layout state structure.
Definition: imdl_backend.h:690
virtual const char * get_ro_data_segment_data(Size index) const =0
Returns the data of the constant data segment at the given index.
virtual Uint32 get_string_index(IValue_string const *s)=0
Returns a string identifier for the given string value usable by the target code.
virtual Gamma_mode get_texture_gamma(Size index) const =0
Returns the gamma mode of a texture resource used by the target code.
virtual Sint32 execute_bsdf_init(Size index, Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the BSDF init function for this code on the native CPU.
virtual Sint32 add_material_expression(const ICompiled_material *inst, const char *path, const char *fname, IMdl_execution_context *context)=0
Add an expression that is part of an MDL material instance as a function to this link unit.
virtual const ITarget_code * deserialize_target_code(ITransaction *transaction, const Uint8 *buffer_data, Size buffer_size, IMdl_execution_context *context) const =0
Restores an instance of ITarget_code from a buffer.
virtual Size get_callable_function_count() const =0
Returns the number of callable functions in the target code.
virtual bool get_texture_is_body_resource(Size index) const =0
Check whether the texture resource is coming from the body of expressions (not solely from material a...
virtual Sint32 execute_environment(Size index, const Shading_state_environment &state, Texture_handler_base *tex_handler, Spectrum_struct *result) const =0
Run this code on the native CPU.
virtual Size get_texture_count() const =0
Returns the number of texture resources used by the target code.
virtual Size get_layout(IValue::Kind &kind, Size &arg_size, Target_value_layout_state state=Target_value_layout_state()) const =0
Get the offset, the size and the kind of the argument / element inside the argument block at the give...
virtual const char * get_data() const =0
Returns the target argument block data.
virtual Sint32 add_function(const IFunction_call *call, Function_execution_context fexc, const char *fname, IMdl_execution_context *context=0)=0
Add an MDL function call as a function to this link unit.
virtual const char * get_light_profile_url(Size index) const =0
Returns the MDL file path of a light profile resource used by the target code if no database element ...
virtual ILink_unit * create_link_unit(ITransaction *transaction, IMdl_execution_context *context)=0
Creates a new link unit.
virtual bool supports_serialization() const =0
Indicates whether the target code can be serialized.
virtual const char * get_texture_url(Size index) const =0
Returns the MDL file path of a texture resource used by the target code if no database element is ass...
virtual Size get_argument_block_count() const =0
Returns the number of target argument blocks.
virtual Size get_code_segment_count() const =0
Returns the number of code segments of the target code.
virtual Sint32 execute_init(Size index, Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the init function for this code on the native CPU (single-init mode).
virtual const ITarget_code * translate_environment(ITransaction *transaction, const IFunction_call *call, const char *fname, IMdl_execution_context *context)=0
Transforms an MDL environment function call into target code.
virtual const ITarget_code * translate_material_expression(ITransaction *transaction, const ICompiled_material *material, const char *path, const char *fname, IMdl_execution_context *context)=0
Transforms an expression that is part of an MDL material instance to target code.
virtual const ITarget_code * translate_material_df(ITransaction *transaction, const ICompiled_material *material, const char *path, const char *base_fname, IMdl_execution_context *context)=0
Transforms an MDL distribution function to target code.
virtual Sint32 execute_edf_pdf(Size index, Edf_pdf_data *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the EDF PDF calculation function for this code on the native CPU.
virtual const char * get_bsdf_measurement_owner_module(Size index) const =0
Returns the owner module name of a relative BSDF measurement file path.
virtual const char * get_callable_function_df_handle(Size func_index, Size handle_index) const =0
Get the name of a distribution function handle referenced by a callable function.
Size function_index
The index of the generated function for accessing the callable function information of the link unit ...
Definition: imdl_backend.h:1791
virtual const char * get_callable_function(Size index) const =0
Returns the name of a callable function in the target code.
virtual Size get_string_constant_count() const =0
Returns the number of string constants used by the target code.
virtual Sint32 execute_edf_evaluate(Size index, Edf_evaluate_data_base *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the EDF evaluation function for this code on the native CPU.
virtual Distribution_kind get_callable_function_distribution_kind(Size index) const =0
Returns the distribution kind of a callable function in the target code.
virtual ITarget_argument_block * clone() const =0
Clones the argument block (to make it writable).
virtual ITarget_argument_block * create_argument_block(Size index, const ICompiled_material *material, ITarget_resource_callback *resource_callback) const =0
Create a new target argument block of the class-compiled material for this target code.
virtual Sint32 execute_bsdf_sample(Size index, Bsdf_sample_data *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the BSDF sample function for this code on the native CPU.
Texture_shape
Definition: imdl_backend.h:801
Gamma_mode
Possible texture gamma modes.
Definition: imdl_backend.h:849
virtual const char * get_string_constant(Size index) const =0
Returns the string constant used by the target code.
virtual const ITarget_code * translate_material(ITransaction *transaction, const ICompiled_material *material, Target_function_description *function_descriptions, Size description_count, IMdl_execution_context *context)=0
Transforms (multiple) distribution functions and expressions of a material to target code.
virtual const ITarget_argument_block * get_argument_block(Size index) const =0
Get a target argument block if available.
virtual const char * get_light_profile_owner_module(Size index) const =0
Returns the owner module name of a relative light profile file path.
Prototype_language
Language to use for the callable function prototype.
Definition: imdl_backend.h:813
virtual Uint32 get_known_resource_index(ITransaction *transaction, IValue_resource const *resource) const =0
Returns the resource index for use in an ITarget_argument_block of resources already known when this ...
Function_kind
Possible kinds of callable functions.
Definition: imdl_backend.h:834
virtual const char * get_code_segment_description(Size index) const =0
Returns the description of the target code segment.
virtual Sint32 add_material_df(const ICompiled_material *material, const char *path, const char *base_fname, IMdl_execution_context *context)=0
Add an MDL distribution function to this link unit.
const char * base_fname
The base name of the generated functions.
Definition: imdl_backend.h:1775
virtual const char * get_code_segment(Size index) const =0
Returns the represented target code segment in ASCII representation.
virtual const IBuffer * serialize(IMdl_execution_context *context) const =0
Stores the data of this object in a buffer that can written to an external cache.
virtual State_usage get_render_state_usage() const =0
Returns the potential render state usage of the target code.
virtual State_usage get_callable_function_render_state_usage(Size index) const =0
Returns the potential render state usage of callable function in the target code.
virtual const ITarget_value_layout * get_argument_block_layout(Size index) const =0
Get a captured arguments block layout if available.
virtual Sint32 execute_edf_sample(Size index, Edf_sample_data *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the EDF sample function for this code on the native CPU.
Sint32 return_code
A return code.
Definition: imdl_backend.h:1828
virtual Sint32 set_option_binary(const char *name, const char *data, Size size)=0
Sets a binary backend option.
virtual const char * get_ro_data_segment_name(Size index) const =0
Returns the name of the constant data segment at the given index.
virtual Size get_code_segment_size(Size index) const =0
Returns the length of the represented target code segment.
virtual char * get_data()=0
Returns the target argument block data.
virtual Size get_code_size() const =0
Returns the length of the represented target code.
virtual Size get_size() const =0
Returns the size of the target argument block.
virtual Sint32 execute_bsdf_auxiliary(Size index, Bsdf_auxiliary_data_base *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the BSDF auxiliary calculation function for this code on the native CPU.
virtual const char * get_light_profile(Size index) const =0
Returns the name of a light profile resource used by the target code.
Size argument_block_index
The index of argument block that belongs to the compiled material the function is generated from or ~...
Definition: imdl_backend.h:1781
virtual const char * get_bsdf_measurement(Size index) const =0
Returns the name of a bsdf measurement resource used by the target code.
virtual const ITarget_code * deserialize_target_code(ITransaction *transaction, const IBuffer *buffer, IMdl_execution_context *context) const =0
Restores an instance of ITarget_code from a buffer.
virtual Sint32 execute_bsdf_evaluate(Size index, Bsdf_evaluate_data_base *data, const Shading_state_material &state, Texture_handler_base *tex_handler, const ITarget_argument_block *cap_args) const =0
Run the BSDF evaluation function for this code on the native CPU.
virtual Size get_light_profile_count() const =0
Returns the number of light profile resources used by the target code.
virtual Size get_callable_function_df_handle_count(Size func_index) const =0
Get the number of distribution function handles referenced by a callable function.
mi::Uint32 m_data_offs
The offset which needs to be added to the element data offset.
Definition: imdl_backend.h:693
virtual const char * get_bsdf_measurement_url(Size index) const =0
Returns the MDL file path of a BSDF measurement resource used by the target code if no database eleme...
virtual bool get_bsdf_measurement_is_body_resource(Size index) const =0
Check whether the BSDF measurement resource is coming from the body of expressions (not solely from m...
@ FEC_ENVIRONMENT
This function will be executed inside the environment.
Definition: imdl_backend.h:1690
@ FEC_CORE
This function will be executed in the renderer core.
Definition: imdl_backend.h:1691
@ FEC_DISPLACEMENT
This function will be executed inside displacement.
Definition: imdl_backend.h:1692
@ SU_TANGENT_SPACE
uses state::tangent_space()
Definition: imdl_backend.h:783
@ SU_GEOMETRY_NORMAL
uses state::geometry_normal()
Definition: imdl_backend.h:779
@ SU_DIRECTION
uses state::direction()
Definition: imdl_backend.h:785
@ SU_ANIMATION_TIME
uses state::animation_time()
Definition: imdl_backend.h:786
@ SU_TEXTURE_TANGENTS
uses state::texture_tangent_*()
Definition: imdl_backend.h:782
@ SU_TEXTURE_COORDINATE
uses state::texture_coordinate()
Definition: imdl_backend.h:781
@ SU_ALL_UNIFORM_MASK
set of uniform states
Definition: imdl_backend.h:794
@ SU_TRANSFORMS
uses uniform state::transform*()
Definition: imdl_backend.h:791
@ SU_NORMAL
uses state::normal()
Definition: imdl_backend.h:778
@ SU_MOTION
uses state::motion()
Definition: imdl_backend.h:780
@ SU_POSITION
uses state::position()
Definition: imdl_backend.h:777
@ SU_ALL_VARYING_MASK
set of varying states
Definition: imdl_backend.h:789
@ SU_ROUNDED_CORNER_NORMAL
uses state::rounded_corner_normal()
Definition: imdl_backend.h:787
@ SU_GEOMETRY_TANGENTS
uses state::geometry_tangent_*()
Definition: imdl_backend.h:784
@ SU_OBJECT_ID
uses uniform state::object_id()
Definition: imdl_backend.h:792
@ Texture_shape_invalid
Invalid texture.
Definition: imdl_backend.h:802
@ Texture_shape_ptex
PTEX texture.
Definition: imdl_backend.h:806
@ Texture_shape_bsdf_data
Three-dimensional texture representing a BSDF data table.
Definition: imdl_backend.h:807
@ Texture_shape_cube
Cube map texture.
Definition: imdl_backend.h:805
@ Texture_shape_3d
Three-dimensional texture.
Definition: imdl_backend.h:804
@ Texture_shape_2d
Two-dimensional texture.
Definition: imdl_backend.h:803
Df_data_kind
Possible kinds of distribution function data.
Definition: imdl_backend_api.h:37
API component for MDL backend related operations.
Mixin class template for deriving new interface declarations.
Values of the MDL type system.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: example_derivatives.dox:5
Major and minor version number and an optional qualifier.
Generic storage class template for a Spectrum representation storing three floating point elements.
Definition: color.h:47
Input and output structure for BSDF auxiliary calculation data.
Definition: target_code_types.h:873
Input and output structure for BSDF evaluation data.
Definition: target_code_types.h:801
Input and output structure for BSDF PDF calculation data.
Definition: target_code_types.h:860
Input and output structure for BSDF sampling data.
Definition: target_code_types.h:773
Input and output structure for EDF auxiliary calculation data.
Definition: target_code_types.h:1235
Input and output structure for EDF evaluation data.
Definition: target_code_types.h:1191
Input and output structure for EDF PDF calculation data.
Definition: target_code_types.h:1229
Input and output structure for EDF sampling data.
Definition: target_code_types.h:1181
The MDL environment state structure inside the MDL SDK is a representation of the renderer state in t...
Definition: target_code_types.h:160
The MDL material state structure inside the MDL SDK is a representation of the renderer state as defi...
Definition: target_code_types.h:210
Description of target function.
Definition: imdl_backend.h:1754
Structure representing the state during traversal of the nested layout.
Definition: imdl_backend.h:683
The texture handler structure that is passed to the texturing functions.
Definition: target_code_types.h:712
Types required for execution of generated native and CUDA code.
Typedefs for types from the math API.