MDL SDK API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ifunction_definition.h
Go to the documentation of this file.
1 /***************************************************************************************************
2  * Copyright 2022 NVIDIA Corporation. All rights reserved.
3  **************************************************************************************************/
6 
7 #ifndef MI_NEURAYLIB_IFUNCTION_DEFINITION_H
8 #define MI_NEURAYLIB_IFUNCTION_DEFINITION_H
9 
10 #include <cstring>
11 
12 #include <mi/neuraylib/iexpression.h>
13 #include <mi/neuraylib/iscene_element.h>
14 
15 namespace mi {
16 
17 namespace neuraylib {
18 
23 class IFunction_call;
24 class IMdl_execution_context;
25 
42 class IFunction_definition : public
43  mi::base::Interface_declare<0x3504744d,0xd45b,0x4a99,0xb6,0x21,0x10,0x9e,0xd5,0xcb,0x36,0xc1,
44  neuraylib::IScene_element>
45 {
46 public:
47 
54  enum Semantics
55  {
56  DS_UNKNOWN = 0,
57 
58  DS_CONV_CONSTRUCTOR,
59  DS_ELEM_CONSTRUCTOR,
60  DS_COLOR_SPECTRUM_CONSTRUCTOR,
61  DS_MATRIX_ELEM_CONSTRUCTOR,
62  DS_MATRIX_DIAG_CONSTRUCTOR,
63  DS_INVALID_REF_CONSTRUCTOR,
64  DS_DEFAULT_STRUCT_CONSTRUCTOR,
65  DS_TEXTURE_CONSTRUCTOR,
66  DS_CONV_OPERATOR,
67  DS_COPY_CONSTRUCTOR,
68 
69  // Unary operators
70 
71  DS_BITWISE_COMPLEMENT = 0x0200,
72  DS_UNARY_FIRST = DS_BITWISE_COMPLEMENT,
73  DS_OPERATOR_FIRST = DS_UNARY_FIRST,
74  DS_LOGICAL_NOT,
75  DS_POSITIVE,
76  DS_NEGATIVE,
77  DS_PRE_INCREMENT,
78  DS_PRE_DECREMENT,
79  DS_POST_INCREMENT,
80  DS_POST_DECREMENT,
81  DS_CAST,
83  DS_UNARY_LAST = DS_CAST,
84 
85  // Binary operators
86 
87  DS_SELECT,
88  DS_BINARY_FIRST = DS_SELECT,
90  DS_ARRAY_INDEX,
91  DS_MULTIPLY,
92  DS_DIVIDE,
93  DS_MODULO,
94  DS_PLUS,
95  DS_MINUS,
96  DS_SHIFT_LEFT,
97  DS_SHIFT_RIGHT,
98  DS_UNSIGNED_SHIFT_RIGHT,
99  DS_LESS,
100  DS_LESS_OR_EQUAL,
101  DS_GREATER_OR_EQUAL,
102  DS_GREATER,
103  DS_EQUAL,
104  DS_NOT_EQUAL,
105  DS_BITWISE_AND,
106  DS_BITWISE_XOR,
107  DS_BITWISE_OR,
108  DS_LOGICAL_AND,
109  DS_LOGICAL_OR,
110  DS_ASSIGN,
111  DS_MULTIPLY_ASSIGN,
112  DS_DIVIDE_ASSIGN,
113  DS_MODULO_ASSIGN,
114  DS_PLUS_ASSIGN,
115  DS_MINUS_ASSIGN,
116  DS_SHIFT_LEFT_ASSIGN,
117  DS_SHIFT_RIGHT_ASSIGN,
118  DS_UNSIGNED_SHIFT_RIGHT_ASSIGN,
119  DS_BITWISE_OR_ASSIGN,
120  DS_BITWISE_XOR_ASSIGN,
121  DS_BITWISE_AND_ASSIGN,
122  DS_SEQUENCE,
123  DS_BINARY_LAST = DS_SEQUENCE,
124 
125  // Ternary operator
126 
128  DS_TERNARY,
129  DS_OPERATOR_LAST = DS_TERNARY,
130 
131  // ::math module intrinsics
132 
133  DS_INTRINSIC_MATH_FIRST = 0x0300,
134  DS_INTRINSIC_MATH_ABS = DS_INTRINSIC_MATH_FIRST,
135  DS_INTRINSIC_MATH_ACOS,
136  DS_INTRINSIC_MATH_ALL,
137  DS_INTRINSIC_MATH_ANY,
138  DS_INTRINSIC_MATH_ASIN,
139  DS_INTRINSIC_MATH_ATAN,
140  DS_INTRINSIC_MATH_ATAN2,
141  DS_INTRINSIC_MATH_AVERAGE,
142  DS_INTRINSIC_MATH_CEIL,
143  DS_INTRINSIC_MATH_CLAMP,
144  DS_INTRINSIC_MATH_COS,
145  DS_INTRINSIC_MATH_CROSS,
146  DS_INTRINSIC_MATH_DEGREES,
147  DS_INTRINSIC_MATH_DISTANCE,
148  DS_INTRINSIC_MATH_DOT,
149  DS_INTRINSIC_MATH_EVAL_AT_WAVELENGTH,
150  DS_INTRINSIC_MATH_EXP,
152  DS_INTRINSIC_MATH_EXP2,
153  DS_INTRINSIC_MATH_FLOOR,
154  DS_INTRINSIC_MATH_FMOD,
155  DS_INTRINSIC_MATH_FRAC,
156  DS_INTRINSIC_MATH_ISNAN,
157  DS_INTRINSIC_MATH_ISFINITE,
158  DS_INTRINSIC_MATH_LENGTH,
159  DS_INTRINSIC_MATH_LERP,
160  DS_INTRINSIC_MATH_LOG,
161  DS_INTRINSIC_MATH_LOG2,
162  DS_INTRINSIC_MATH_LOG10,
163  DS_INTRINSIC_MATH_LUMINANCE,
164  DS_INTRINSIC_MATH_MAX,
165  DS_INTRINSIC_MATH_MAX_VALUE,
166  DS_INTRINSIC_MATH_MAX_VALUE_WAVELENGTH,
167  DS_INTRINSIC_MATH_MIN,
169  DS_INTRINSIC_MATH_MIN_VALUE,
170  DS_INTRINSIC_MATH_MIN_VALUE_WAVELENGTH,
171  DS_INTRINSIC_MATH_MODF,
173  DS_INTRINSIC_MATH_NORMALIZE,
174  DS_INTRINSIC_MATH_POW,
175  DS_INTRINSIC_MATH_RADIANS,
176  DS_INTRINSIC_MATH_ROUND,
177  DS_INTRINSIC_MATH_RSQRT,
178  DS_INTRINSIC_MATH_SATURATE,
179  DS_INTRINSIC_MATH_SIGN,
180  DS_INTRINSIC_MATH_SIN,
181  DS_INTRINSIC_MATH_SINCOS,
182  DS_INTRINSIC_MATH_SMOOTHSTEP,
183  DS_INTRINSIC_MATH_SQRT,
184  DS_INTRINSIC_MATH_STEP,
185  DS_INTRINSIC_MATH_TAN,
186  DS_INTRINSIC_MATH_TRANSPOSE,
187  DS_INTRINSIC_MATH_BLACKBODY,
188  DS_INTRINSIC_MATH_EMISSION_COLOR,
189  DS_INTRINSIC_MATH_COSH,
191  DS_INTRINSIC_MATH_SINH,
192  DS_INTRINSIC_MATH_TANH,
193  DS_INTRINSIC_MATH_INT_BITS_TO_FLOAT,
194  DS_INTRINSIC_MATH_FLOAT_BITS_TO_INT,
196  DS_INTRINSIC_MATH_DX,
198  DS_INTRINSIC_MATH_DY,
199  DS_INTRINSIC_MATH_LAST = DS_INTRINSIC_MATH_DY,
200 
201  // ::state module intrinsics
202 
203  DS_INTRINSIC_STATE_POSITION = 0x0400,
204  DS_INTRINSIC_STATE_FIRST = DS_INTRINSIC_STATE_POSITION,
205  DS_INTRINSIC_STATE_NORMAL,
206  DS_INTRINSIC_STATE_GEOMETRY_NORMAL,
207  DS_INTRINSIC_STATE_MOTION,
208  DS_INTRINSIC_STATE_TEXTURE_SPACE_MAX,
209  DS_INTRINSIC_STATE_TEXTURE_COORDINATE,
210  DS_INTRINSIC_STATE_TEXTURE_TANGENT_U,
211  DS_INTRINSIC_STATE_TEXTURE_TANGENT_V,
212  DS_INTRINSIC_STATE_TANGENT_SPACE,
213  DS_INTRINSIC_STATE_GEOMETRY_TANGENT_U,
214  DS_INTRINSIC_STATE_GEOMETRY_TANGENT_V,
215  DS_INTRINSIC_STATE_DIRECTION,
216  DS_INTRINSIC_STATE_ANIMATION_TIME,
217  DS_INTRINSIC_STATE_WAVELENGTH_BASE,
218  DS_INTRINSIC_STATE_TRANSFORM,
219  DS_INTRINSIC_STATE_TRANSFORM_POINT,
220  DS_INTRINSIC_STATE_TRANSFORM_VECTOR,
221  DS_INTRINSIC_STATE_TRANSFORM_NORMAL,
222  DS_INTRINSIC_STATE_TRANSFORM_SCALE,
223  DS_INTRINSIC_STATE_ROUNDED_CORNER_NORMAL,
224  DS_INTRINSIC_STATE_METERS_PER_SCENE_UNIT,
225  DS_INTRINSIC_STATE_SCENE_UNITS_PER_METER,
226  DS_INTRINSIC_STATE_OBJECT_ID,
227  DS_INTRINSIC_STATE_WAVELENGTH_MIN,
228  DS_INTRINSIC_STATE_WAVELENGTH_MAX,
229  DS_INTRINSIC_STATE_LAST = DS_INTRINSIC_STATE_WAVELENGTH_MAX,
230 
231  // ::tex module intrinsics
232 
233  DS_INTRINSIC_TEX_WIDTH = 0x0500,
234  DS_INTRINSIC_TEX_FIRST = DS_INTRINSIC_TEX_WIDTH,
235  DS_INTRINSIC_TEX_HEIGHT,
236  DS_INTRINSIC_TEX_DEPTH,
237  DS_INTRINSIC_TEX_LOOKUP_FLOAT,
238  DS_INTRINSIC_TEX_LOOKUP_FLOAT2,
239  DS_INTRINSIC_TEX_LOOKUP_FLOAT3,
240  DS_INTRINSIC_TEX_LOOKUP_FLOAT4,
241  DS_INTRINSIC_TEX_LOOKUP_COLOR,
242  DS_INTRINSIC_TEX_TEXEL_FLOAT,
243  DS_INTRINSIC_TEX_TEXEL_FLOAT2,
244  DS_INTRINSIC_TEX_TEXEL_FLOAT3,
245  DS_INTRINSIC_TEX_TEXEL_FLOAT4,
246  DS_INTRINSIC_TEX_TEXEL_COLOR,
247  DS_INTRINSIC_TEX_TEXTURE_ISVALID,
248  DS_INTRINSIC_TEX_WIDTH_OFFSET,
249  DS_INTRINSIC_TEX_HEIGHT_OFFSET,
250  DS_INTRINSIC_TEX_DEPTH_OFFSET,
251  DS_INTRINSIC_TEX_FIRST_FRAME,
252  DS_INTRINSIC_TEX_LAST_FRAME,
253  DS_INTRINSIC_TEX_GRID_TO_OBJECT_SPACE,
254  DS_INTRINSIC_TEX_LAST = DS_INTRINSIC_TEX_GRID_TO_OBJECT_SPACE,
255 
256  // ::df module intrinsics
257 
259  DS_INTRINSIC_DF_DIFFUSE_REFLECTION_BSDF = 0x0600,
260  DS_INTRINSIC_DF_FIRST = DS_INTRINSIC_DF_DIFFUSE_REFLECTION_BSDF,
261  DS_INTRINSIC_DF_DIFFUSE_TRANSMISSION_BSDF,
262  DS_INTRINSIC_DF_SPECULAR_BSDF,
263  DS_INTRINSIC_DF_SIMPLE_GLOSSY_BSDF,
264  DS_INTRINSIC_DF_BACKSCATTERING_GLOSSY_REFLECTION_BSDF,
266  DS_INTRINSIC_DF_MEASURED_BSDF,
267  DS_INTRINSIC_DF_DIFFUSE_EDF,
268  DS_INTRINSIC_DF_MEASURED_EDF,
269  DS_INTRINSIC_DF_SPOT_EDF,
270  DS_INTRINSIC_DF_ANISOTROPIC_VDF,
271  DS_INTRINSIC_DF_NORMALIZED_MIX,
272  DS_INTRINSIC_DF_CLAMPED_MIX,
273  DS_INTRINSIC_DF_WEIGHTED_LAYER,
274  DS_INTRINSIC_DF_FRESNEL_LAYER,
275  DS_INTRINSIC_DF_CUSTOM_CURVE_LAYER,
276  DS_INTRINSIC_DF_MEASURED_CURVE_LAYER,
277  DS_INTRINSIC_DF_THIN_FILM,
278  DS_INTRINSIC_DF_TINT,
279  DS_INTRINSIC_DF_DIRECTIONAL_FACTOR,
280  DS_INTRINSIC_DF_MEASURED_CURVE_FACTOR,
281  DS_INTRINSIC_DF_LIGHT_PROFILE_POWER,
282  DS_INTRINSIC_DF_LIGHT_PROFILE_MAXIMUM,
283  DS_INTRINSIC_DF_LIGHT_PROFILE_ISVALID,
284  DS_INTRINSIC_DF_BSDF_MEASUREMENT_ISVALID,
285  DS_INTRINSIC_DF_MICROFACET_BECKMANN_SMITH_BSDF,
288  DS_INTRINSIC_DF_MICROFACET_GGX_SMITH_BSDF,
290  DS_INTRINSIC_DF_MICROFACET_BECKMANN_VCAVITIES_BSDF,
292  DS_INTRINSIC_DF_MICROFACET_GGX_VCAVITIES_BSDF,
294  DS_INTRINSIC_DF_WARD_GEISLER_MORODER_BSDF,
295  DS_INTRINSIC_DF_COLOR_NORMALIZED_MIX,
296  DS_INTRINSIC_DF_COLOR_CLAMPED_MIX,
297  DS_INTRINSIC_DF_COLOR_WEIGHTED_LAYER,
298  DS_INTRINSIC_DF_COLOR_FRESNEL_LAYER,
299  DS_INTRINSIC_DF_COLOR_CUSTOM_CURVE_LAYER,
300  DS_INTRINSIC_DF_COLOR_MEASURED_CURVE_LAYER,
302  DS_INTRINSIC_DF_FRESNEL_FACTOR,
303  DS_INTRINSIC_DF_MEASURED_FACTOR,
304  DS_INTRINSIC_DF_CHIANG_HAIR_BSDF,
305  DS_INTRINSIC_DF_SHEEN_BSDF,
306  DS_INTRINSIC_DF_UNBOUNDED_MIX,
307  DS_INTRINSIC_DF_COLOR_UNBOUNDED_MIX,
308  DS_INTRINSIC_DF_LAST = DS_INTRINSIC_DF_COLOR_UNBOUNDED_MIX,
309 
310 #ifndef MDL_SOURCE_RELEASE
311  // ::nvidia::df module intrinsics
312 
314  DS_INTRINSIC_NVIDIA_DF_ASHIKHMIN_SHIRLEY_GLOSSY_BSDF = 0x0700,
315  DS_INTRINSIC_NVIDIA_DF_FIRST = DS_INTRINSIC_NVIDIA_DF_ASHIKHMIN_SHIRLEY_GLOSSY_BSDF,
317  DS_INTRINSIC_NVIDIA_DF_WARD_GM_GLOSSY_BSDF,
319  DS_INTRINSIC_NVIDIA_DF_MICROFACET_BECKMANN_SMITH_BSDF,
321  DS_INTRINSIC_NVIDIA_DF_MICROFACET_GGX_SMITH_BSDF,
323  DS_INTRINSIC_NVIDIA_DF_MICROFACET_BECKMANN_VC_BSDF,
325  DS_INTRINSIC_NVIDIA_DF_MICROFACET_GGX_VC_BSDF,
327  DS_INTRINSIC_NVIDIA_DF_MICROFACET_PHONG_VC_BSDF,
329  DS_INTRINSIC_NVIDIA_DF_SIMPLE_GLOSSY_BSDF,
331  DS_INTRINSIC_NVIDIA_DF_SIMPLE_GLOSSY_BSDF_LEGACY,
333  DS_INTRINSIC_NVIDIA_DF_LEGACY_MCP_GLOSSY_BSDF,
335  DS_INTRINSIC_NVIDIA_DF_MICROFACET_SIN_K_VC_BSDF,
337  DS_INTRINSIC_NVIDIA_DF_MICROFACET_MS_TEST_BSDF,
339  DS_INTRINSIC_NVIDIA_DF_THIN_FILM,
341  DS_INTRINSIC_NVIDIA_DF_THIN_FILM_LAYER,
342  DS_INTRINSIC_NVIDIA_DF_LAST = DS_INTRINSIC_NVIDIA_DF_THIN_FILM_LAYER,
343 #endif
344 
345  // ::scene module intrinsics
346 
348  DS_INTRINSIC_SCENE_DATA_ISVALID = 0x0800,
349  DS_INTRINSIC_SCENE_FIRST = DS_INTRINSIC_SCENE_DATA_ISVALID,
351  DS_INTRINSIC_SCENE_DATA_LOOKUP_INT,
353  DS_INTRINSIC_SCENE_DATA_LOOKUP_INT2,
355  DS_INTRINSIC_SCENE_DATA_LOOKUP_INT3,
357  DS_INTRINSIC_SCENE_DATA_LOOKUP_INT4,
359  DS_INTRINSIC_SCENE_DATA_LOOKUP_FLOAT,
361  DS_INTRINSIC_SCENE_DATA_LOOKUP_FLOAT2,
363  DS_INTRINSIC_SCENE_DATA_LOOKUP_FLOAT3,
365  DS_INTRINSIC_SCENE_DATA_LOOKUP_FLOAT4,
367  DS_INTRINSIC_SCENE_DATA_LOOKUP_COLOR,
369  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_INT,
371  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_INT2,
373  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_INT3,
375  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_INT4,
377  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_FLOAT,
379  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_FLOAT2,
381  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_FLOAT3,
383  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_FLOAT4,
385  DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_COLOR,
386  DS_INTRINSIC_SCENE_LAST = DS_INTRINSIC_SCENE_DATA_LOOKUP_UNIFORM_COLOR,
387 
388  // ::debug module intrinsics
389 
390  DS_INTRINSIC_DEBUG_BREAKPOINT = 0x0900,
391  DS_INTRINSIC_DEBUG_FIRST = DS_INTRINSIC_DEBUG_BREAKPOINT,
392  DS_INTRINSIC_DEBUG_ASSERT,
393  DS_INTRINSIC_DEBUG_PRINT,
394  DS_INTRINSIC_DEBUG_LAST = DS_INTRINSIC_DEBUG_PRINT,
395 
396  // DAG backend intrinsics
397 
399  DS_INTRINSIC_DAG_FIELD_ACCESS = 0x0A00,
400  DS_INTRINSIC_DAG_FIRST = DS_INTRINSIC_DAG_FIELD_ACCESS,
402  DS_INTRINSIC_DAG_ARRAY_CONSTRUCTOR,
404  DS_INTRINSIC_DAG_ARRAY_LENGTH,
405  DS_INTRINSIC_DAG_LAST = DS_INTRINSIC_DAG_ARRAY_LENGTH,
406 
407  DS_FORCE_32_BIT = 0xffffffffU // Undocumented, for alignment only.
408  };
409 
413  virtual const char* get_module() const = 0;
414 
421  virtual const char* get_mdl_name() const = 0;
422 
424  virtual const char* get_mdl_module_name() const = 0;
425 
432  virtual const char* get_mdl_simple_name() const = 0;
433 
446  virtual const char* get_mdl_parameter_type_name( Size index) const = 0;
447 
450  virtual const char* get_prototype() const = 0;
451 
460  virtual void get_mdl_version( Mdl_version& since, Mdl_version& removed) const = 0;
461 
463  virtual Semantics get_semantic() const = 0;
464 
468  inline bool is_array_constructor() const { return strcmp( get_mdl_name(), "T[](...)") == 0; }
469 
471  virtual bool is_exported() const = 0;
472 
478  virtual bool is_uniform() const = 0;
479 
484  virtual bool is_material() const = 0;
485 
489  virtual const IType* get_return_type() const = 0;
490 
501  template<class T>
502  const T* get_return_type() const
503  {
504  const IType* ptr_itype = get_return_type();
505  if ( !ptr_itype)
506  return 0;
507  const T* ptr_T = static_cast<const T*>( ptr_itype->get_interface( typename T::IID()));
508  ptr_itype->release();
509  return ptr_T;
510  }
511 
513  virtual Size get_parameter_count() const = 0;
514 
519  virtual const char* get_parameter_name( Size index) const = 0;
520 
525  virtual Size get_parameter_index( const char* name) const = 0;
526 
528  virtual const IType_list* get_parameter_types() const = 0;
529 
535  virtual const IExpression_list* get_defaults() const = 0;
536 
543  virtual const IExpression_list* get_enable_if_conditions() const = 0;
544 
551  virtual Size get_enable_if_users( Size index) const = 0;
552 
560  virtual Size get_enable_if_user( Size index, Size u_index) const = 0;
561 
564  virtual const IAnnotation_block* get_annotations() const = 0;
565 
568  virtual const IAnnotation_block* get_return_annotations() const = 0;
569 
576  virtual const IAnnotation_list* get_parameter_annotations() const = 0;
577 
585  virtual const char* get_thumbnail() const = 0;
586 
598  virtual bool is_valid( IMdl_execution_context* context) const = 0;
599 
610  virtual const IExpression* get_body() const = 0;
611 
613  virtual Size get_temporary_count() const = 0;
614 
620  virtual const IExpression* get_temporary( Size index) const = 0;
621 
632  virtual const char* get_temporary_name( Size index) const = 0;
633 
646  template<class T>
647  const T* get_temporary( Size index) const
648  {
649  const IExpression* ptr_iexpression = get_temporary( index);
650  if ( !ptr_iexpression)
651  return 0;
652  const T* ptr_T = static_cast<const T*>( ptr_iexpression->get_interface( typename T::IID()));
653  ptr_iexpression->release();
654  return ptr_T;
655  }
656 
689  virtual IFunction_call* create_function_call(
690  const IExpression_list* arguments, Sint32* errors = 0) const = 0;
691 };
692 
693 mi_static_assert(sizeof(IFunction_definition::Semantics) == sizeof(Uint32));
694  // end group mi_neuray_mdl_elements
696 
697 } // namespace neuraylib
698 
699 } // namespace mi
700 
701 #endif // MI_NEURAYLIB_IFUNCTION_DEFINITION_H