MDL SDK API nvidia_logo_transpbg.gif Up
itype.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_ITYPE_H
8#define MI_NEURAYLIB_ITYPE_H
9
11
12namespace mi {
13
14class IString;
15
16namespace neuraylib {
17
44class IAnnotation_block;
45
49class IType : public
50 mi::base::Interface_declare<0x242af675,0xeaa2,0x48b7,0x81,0x63,0xba,0x06,0xa5,0xfb,0x68,0xf0>
51{
52public:
54 enum Kind {
93 // Undocumented, for alignment only.
94 TK_FORCE_32_BIT = 0xffffffffU
95 };
96
98 enum Modifier {
99 MK_NONE = 0,
102 MK_FORCE_32_BIT // Undocumented, for alignment only.
103 };
104
106 virtual Kind get_kind() const = 0;
107
115 virtual Uint32 get_all_type_modifiers() const = 0;
116
122 virtual const IType* skip_all_type_aliases() const = 0;
123};
124
125mi_static_assert( sizeof( IType::Kind) == sizeof( Uint32));
126mi_static_assert( sizeof( IType::Modifier) == sizeof( Uint32));
127
132class IType_alias : public
133 mi::base::Interface_declare<0x69d8c70a,0xdfda,0x4e8e,0xaa,0x09,0x12,0x1f,0xa9,0x78,0xc6,0x6a,
134 neuraylib::IType>
135{
136public:
138 static const Kind s_kind = TK_ALIAS;
139
141 virtual const IType* get_aliased_type() const = 0;
142
144 virtual Uint32 get_type_modifiers() const = 0;
145
147 virtual const char* get_symbol() const = 0;
148};
149
151class IType_atomic : public
152 mi::base::Interface_declare<0x9d5f9116,0x3896,0x45c8,0xb4,0x5a,0x8b,0x03,0x84,0x49,0x0a,0x77,
153 neuraylib::IType>
154{
155};
156
158class IType_bool : public
159 mi::base::Interface_declare<0x831d8a38,0x26d3,0x4fd2,0xa7,0xf7,0x15,0xc2,0xa5,0x20,0x76,0x6c,
160 neuraylib::IType_atomic>
161{
162public:
164 static const Kind s_kind = TK_BOOL;
165};
166
168class IType_int : public
169 mi::base::Interface_declare<0xbbad021c,0xbfe5,0x45de,0xaf,0x66,0xfd,0xe8,0x45,0xbe,0x48,0x49,
170 neuraylib::IType_atomic>
171{
172public:
174 static const Kind s_kind = TK_INT;
175};
176
178class IType_enum : public
179 mi::base::Interface_declare<0x0e5b167c,0x9c3e,0x48bf,0xb5,0xfd,0x37,0x96,0xaa,0x47,0xaf,0xd1,
180 neuraylib::IType_atomic>
181{
182public:
185 EID_USER = -1,
188 EID_FORCE_32_BIT = 0x7fffffff // Undocumented, for alignment only.
189 };
190
192 static const Kind s_kind = TK_ENUM;
193
195 virtual const char* get_symbol() const = 0;
196
198 virtual Size get_size() const = 0;
199
204 virtual const char* get_value_name( Size index) const = 0;
205
213 virtual Sint32 get_value_code( Size index, Sint32* errors = 0) const = 0;
214
219 virtual Size find_value( const char* name) const = 0;
220
225 virtual Size find_value( Sint32 code) const = 0;
226
228 virtual Predefined_id get_predefined_id() const = 0;
229
234 virtual const IAnnotation_block* get_annotations() const = 0;
235
241 virtual const IAnnotation_block* get_value_annotations( Size index) const = 0;
242};
243
245
247class IType_float : public
248 mi::base::Interface_declare<0x613711b3,0x41f2,0x44a9,0xbb,0x78,0x43,0xe2,0x41,0x64,0xb3,0xda,
249 neuraylib::IType_atomic>
250{
251public:
253 static const Kind s_kind = TK_FLOAT;
254};
255
257class IType_double : public
258 mi::base::Interface_declare<0xc381508b,0x7945,0x4c70,0x8a,0x20,0x57,0xd5,0x2b,0x36,0x35,0x40,
259 neuraylib::IType_atomic>
260{
261public:
263 static const Kind s_kind = TK_DOUBLE;
264};
265
267class IType_string : public
268 mi::base::Interface_declare<0x4b4629bc,0xa2ce,0x4008,0xba,0x76,0xf6,0x4d,0x60,0x76,0x0a,0x85,
269 neuraylib::IType_atomic>
270{
271public:
273 static const Kind s_kind = TK_STRING;
274};
275
277class IType_compound : public
278 mi::base::Interface_declare<0xc9ca497f,0xc38b,0x411f,0xa8,0x16,0xa7,0xd8,0x23,0x28,0xa5,0x40,
279 neuraylib::IType>
280{
281public:
283 virtual const IType* get_component_type( Size index) const = 0;
284
286 virtual Size get_size() const = 0;
287};
288
293class IType_vector : public
294 mi::base::Interface_declare<0x412a8a91,0x9062,0x46fd,0xaa,0xcf,0x46,0xbd,0xb3,0xde,0x5b,0x9c,
295 neuraylib::IType_compound>
296{
297public:
299 static const Kind s_kind = TK_VECTOR;
300
307 virtual const IType_atomic* get_element_type() const = 0;
308};
309
321class IType_matrix : public
322 mi::base::Interface_declare<0x6b76570e,0x51b2,0x4e9b,0x9f,0xe7,0xda,0x03,0x1c,0x37,0xbc,0x75,
323 neuraylib::IType_compound>
324{
325public:
327 static const Kind s_kind = TK_MATRIX;
328
330 virtual const IType_vector* get_element_type() const = 0;
331};
332
336class IType_color : public
337 mi::base::Interface_declare<0xedb16770,0xdf70,0x4def,0x83,0xa5,0xc4,0x4f,0xcd,0x09,0x47,0x0f,
338 neuraylib::IType_compound>
339{
340public:
342 static const Kind s_kind = TK_COLOR;
343};
344
346class IType_array : public
347 mi::base::Interface_declare<0x21ab6abe,0x0e26,0x40da,0xa1,0x98,0x42,0xc0,0x89,0x71,0x5d,0x2a,
348 neuraylib::IType_compound>
349{
350public:
352 static const Kind s_kind = TK_ARRAY;
353
355 virtual const IType* get_element_type() const = 0;
356
358 virtual bool is_immediate_sized() const = 0;
359
361 virtual Size get_size() const = 0;
362
365 virtual const char* get_deferred_size() const = 0;
366};
367
369class IType_struct : public
370 mi::base::Interface_declare<0x19566cb2,0x0b5d,0x41ca,0xa0,0x31,0x96,0xe2,0x9a,0xd4,0xc3,0x1a,
371 neuraylib::IType_compound>
372{
373public:
376 SID_USER = -1,
382 SID_FORCE_32_BIT = 0x7fffffff // Undocumented, for alignment only.
383 };
384
386 static const Kind s_kind = TK_STRUCT;
387
389 virtual const char* get_symbol() const = 0;
390
395 virtual const IType* get_field_type( Size index) const = 0;
396
401 virtual const char* get_field_name( Size index) const = 0;
402
407 virtual Size find_field( const char* name) const = 0;
408
410 virtual Predefined_id get_predefined_id() const = 0;
411
416 virtual const IAnnotation_block* get_annotations() const = 0;
417
423 virtual const IAnnotation_block* get_field_annotations( Size index) const = 0;
424};
425
427
429class IType_reference : public
430 mi::base::Interface_declare<0x3e12cdec,0xdaba,0x460c,0x9e,0x8a,0x21,0x4c,0x43,0x9a,0x1a,0x90,
431 neuraylib::IType>
432{
433};
434
436class IType_resource : public
437 mi::base::Interface_declare<0x142f5bea,0x139e,0x42e4,0xb1,0x1c,0xb3,0x4d,0xd8,0xe3,0xd9,0x8d,
438 neuraylib::IType_reference>
439{
440};
441
443class IType_texture : public
444 mi::base::Interface_declare<0x2f11253f,0xb8ac,0x4b7d,0x8d,0xd6,0x43,0x66,0xf5,0x97,0xd0,0x93,
445 neuraylib::IType_resource>
446{
447public:
449 static const Kind s_kind = TK_TEXTURE;
450
452 enum Shape {
453 TS_2D = 0,
454 TS_3D = 1,
457 TS_BSDF_DATA = 4,
459 TS_FORCE_32_BIT = 0xffffffffU // Undocumented, for alignment only.
460 };
461
463 virtual Shape get_shape() const = 0;
464};
465
466mi_static_assert( sizeof( IType_texture::Shape) == sizeof( Uint32));
467
470 mi::base::Interface_declare<0x11b80cd8,0x14aa,0x4dfa,0x8b,0xf6,0x0e,0x56,0x0f,0x10,0x9c,0x37,
471 neuraylib::IType_resource>
472{
473public:
476};
477
480 mi::base::Interface_declare<0xf061d204,0xc649,0x4a6b,0xb6,0x2d,0x67,0xe6,0x47,0x53,0xa9,0xda,
481 neuraylib::IType_resource>
482{
483public:
486};
487
489class IType_df : public
490 mi::base::Interface_declare<0xf4bcba08,0x7777,0x4662,0x8e,0x29,0x67,0xe1,0x52,0xac,0x05,0x3e,
491 neuraylib::IType_reference>
492{
493};
494
496class IType_bsdf : public
497 mi::base::Interface_declare<0x6542a02c,0xe1d2,0x485d,0x9a,0x51,0x7b,0xed,0xff,0x7f,0x24,0x7b,
498 neuraylib::IType_df>
499{
500public:
502 static const Kind s_kind = TK_BSDF;
503};
504
506class IType_hair_bsdf : public
507 mi::base::Interface_declare<0x8eac6c90,0x2b8f,0x4650,0x8b,0x93,0x88,0xe0,0x42,0xff,0x19,0x9c,
508 neuraylib::IType_df>
509{
510public:
512 static const Kind s_kind = TK_HAIR_BSDF;
513};
514
516class IType_edf : public
517 mi::base::Interface_declare<0x3e3ce697,0xa2a7,0x43ef,0xa2,0xec,0x52,0x5a,0x4c,0x27,0x8f,0xeb,
518 neuraylib::IType_df>
519{
520public:
522 static const Kind s_kind = TK_EDF;
523};
524
526class IType_vdf : public
527 mi::base::Interface_declare<0x44782b21,0x9e60,0x40b2,0xba,0xae,0x41,0x74,0xc9,0x98,0xe1,0x86,
528 neuraylib::IType_df>
529{
530public:
532 static const Kind s_kind = TK_VDF;
533};
534
538class IType_list : public
539 mi::base::Interface_declare<0x68a97390,0x22ea,0x4f03,0xa5,0xb5,0x5c,0x18,0x32,0x38,0x28,0x91>
540{
541public:
543 virtual Size get_size() const = 0;
544
546 virtual Size get_index( const char* name) const = 0;
547
549 virtual const char* get_name( Size index) const = 0;
550
552 virtual const IType* get_type( Size index) const = 0;
553
555 template <class T>
556 const T* get_type( Size index) const
557 {
558 const IType* ptr_type = get_type( index);
559 if( !ptr_type)
560 return 0;
561 const T* ptr_T = static_cast<const T*>( ptr_type->get_interface( typename T::IID()));
562 ptr_type->release();
563 return ptr_T;
564 }
565
567 virtual const IType* get_type( const char* name) const = 0;
568
570 template <class T>
571 const T* get_type( const char* name) const
572 {
573 const IType* ptr_type = get_type( name);
574 if( !ptr_type)
575 return 0;
576 const T* ptr_T = static_cast<const T*>( ptr_type->get_interface( typename T::IID()));
577 ptr_type->release();
578 return ptr_T;
579 }
580
586 virtual Sint32 set_type( Size index, const IType* type) = 0;
587
593 virtual Sint32 set_type( const char* name, const IType* type) = 0;
594
600 virtual Sint32 add_type( const char* name, const IType* type) = 0;
601};
602
608class IType_factory : public
609 mi::base::Interface_declare<0x353803c0,0x74a6,0x48ac,0xab,0xa1,0xe4,0x25,0x42,0x1d,0xa1,0xbc>
610{
611public:
613
614
616 virtual const IType_alias* create_alias(
617 const IType* type, Uint32 modifiers, const char* symbol) const = 0;
618
620 virtual const IType_bool* create_bool() const = 0;
621
623 virtual const IType_int* create_int() const = 0;
624
626 virtual const IType_enum* create_enum( const char* symbol) const = 0;
627
629 virtual const IType_float* create_float() const = 0;
630
632 virtual const IType_double* create_double() const = 0;
633
635 virtual const IType_string* create_string() const = 0;
636
645 const IType_atomic* element_type, Size size) const = 0;
646
654 const IType_vector* column_type, Size columns) const = 0;
655
657 virtual const IType_color* create_color() const = 0;
658
661 const IType* element_type, Size size) const = 0;
662
672 const IType* element_type, const char* size) const = 0;
673
675 virtual const IType_struct* create_struct( const char* symbol) const = 0;
676
678 virtual const IType_texture* create_texture( IType_texture::Shape shape) const = 0;
679
681 virtual const IType_light_profile* create_light_profile() const = 0;
682
685
687 virtual const IType_bsdf* create_bsdf() const = 0;
688
690 virtual const IType_hair_bsdf* create_hair_bsdf() const = 0;
691
693 virtual const IType_edf* create_edf() const = 0;
694
696 virtual const IType_vdf* create_vdf() const = 0;
697
699 virtual IType_list* create_type_list() const = 0;
700
703
706
714 virtual const IType* create_from_mdl_type_name( const char* name) const = 0;
715
723 template <class T>
724 const T* create_from_mdl_type_name( const char* name) const
725 {
726 const IType* ptr_type = create_from_mdl_type_name( name);
727 if( !ptr_type)
728 return 0;
729 const T* ptr_T = static_cast<const T*>( ptr_type->get_interface( typename T::IID()));
730 ptr_type->release();
731 return ptr_T;
732 }
733
735
737
742 virtual IType_list* clone( const IType_list* type_list) const = 0;
743
745
747
772 virtual Sint32 compare( const IType* lhs, const IType* rhs) const = 0;
773
787 virtual Sint32 compare( const IType_list* lhs, const IType_list* rhs) const = 0;
788
812 virtual Sint32 is_compatible( const IType* src, const IType* dst) const = 0;
813
815
817
827 virtual const IString* dump( const IType* type, Size depth = 0) const = 0;
828
838 virtual const IString* dump( const IType_list* list, Size depth = 0) const = 0;
839
841
843
851 virtual const IString* get_mdl_module_name( const IType* type) const = 0;
852
867 virtual const IString* get_mdl_type_name( const IType* type) const = 0;
868
870
871};
872 // end group mi_neuray_mdl_types
874
875} // namespace neuraylib
876
877} // namespace mi
878
879#endif // MI_NEURAYLIB_ITYPE_H
A simple string class.
Definition: istring.h:22
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
An annotation block is an array of annotations.
Definition: iexpression.h:573
The type of kind alias.
Definition: itype.h:135
virtual const IType * get_aliased_type() const =0
Returns the type aliased by this type.
virtual const char * get_symbol() const =0
Returns the qualified name of the type, or NULL if no such name exists.
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:138
virtual Uint32 get_type_modifiers() const =0
Returns the modifiers of this type.
The type of kind array.
Definition: itype.h:349
virtual bool is_immediate_sized() const =0
Indicates whether the array is immediate-sized or deferred-sized.
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:352
virtual const char * get_deferred_size() const =0
Returns the abstract size of the array in case of deferred-sized arrays, and NULL otherwise.
virtual const IType * get_element_type() const =0
Returns the type of the array elements.
virtual Size get_size() const =0
Returns the size of the array in case of immediate-sized arrays, and -1 otherwise.
An atomic type.
Definition: itype.h:154
The type of kind bool.
Definition: itype.h:161
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:164
The type of kind bsdf_measurement.
Definition: itype.h:482
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:485
The type of kind bsdf.
Definition: itype.h:499
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:502
The type of kind color.
Definition: itype.h:339
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:342
A compound type.
Definition: itype.h:280
virtual Size get_size() const =0
Returns the number of components.
virtual const IType * get_component_type(Size index) const =0
Returns the component type at index.
The type of distribution functions.
Definition: itype.h:492
The type of kind double.
Definition: itype.h:260
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:263
The type of kind edf.
Definition: itype.h:519
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:522
A type of kind enum.
Definition: itype.h:181
virtual const IAnnotation_block * get_annotations() const =0
Returns the annotations of the enum type.
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:192
virtual const IAnnotation_block * get_value_annotations(Size index) const =0
Returns the annotations of a value.
virtual const char * get_symbol() const =0
Returns the qualified name of this enum type.
virtual Size find_value(Sint32 code) const =0
Returns the index of a value in linear time.
virtual Predefined_id get_predefined_id() const =0
If this enum is a predefined one, return its ID, else EID_USER.
Predefined_id
IDs to distinguish predefined enum types.
Definition: itype.h:184
@ EID_USER
A user-defined enum type.
Definition: itype.h:185
@ EID_TEX_GAMMA_MODE
The "::tex::gamma_mode" enum type.
Definition: itype.h:186
@ EID_INTENSITY_MODE
The "::intensity_mode" enum type.
Definition: itype.h:187
virtual const char * get_value_name(Size index) const =0
Returns the name of a value.
virtual Size get_size() const =0
Returns the number of values.
virtual Size find_value(const char *name) const =0
Returns the index of a value in linear time.
virtual Sint32 get_value_code(Size index, Sint32 *errors=0) const =0
Returns the code of a value.
The interface for creating types.
Definition: itype.h:610
virtual const IString * get_mdl_type_name(const IType *type) const =0
Returns the MDL type name of a type.
virtual const IType_alias * create_alias(const IType *type, Uint32 modifiers, const char *symbol) const =0
Creates a new instance of the type alias.
virtual IType_list * create_type_list() const =0
Creates a new type map.
virtual const IType_vector * create_vector(const IType_atomic *element_type, Size size) const =0
Creates a new instance of a vector type.
virtual const IType_enum * get_predefined_enum(IType_enum::Predefined_id id) const =0
Returns a registered enum type, or NULL if id is unknown.
virtual const IType_matrix * create_matrix(const IType_vector *column_type, Size columns) const =0
Creates a new instance of a matrix type.
virtual const IType_hair_bsdf * create_hair_bsdf() const =0
Creates a new instance of the type hair_bsdf.
const T * create_from_mdl_type_name(const char *name) const
Creates a type based on its MDL type name.
Definition: itype.h:724
virtual const IType_enum * create_enum(const char *symbol) const =0
Returns a registered enum type, or NULL if symbol is invalid or unknown.
virtual const IType_int * create_int() const =0
Creates a new instance of the type int.
virtual const IType_edf * create_edf() const =0
Creates a new instance of the type edf.
virtual const IType_bsdf * create_bsdf() const =0
Creates a new instance of the type bsdf.
virtual const IType_bool * create_bool() const =0
Creates a new instance of the type boolean.
virtual const IType_string * create_string() const =0
Creates a new instance of the string type.
virtual const IType_light_profile * create_light_profile() const =0
Creates a new instance of the type light_profile.
virtual const IType_float * create_float() const =0
Creates a new instance of the float type.
virtual const IType_struct * get_predefined_struct(IType_struct::Predefined_id id) const =0
Returns a registered struct type, or NULL if id is unknown.
virtual const IType_struct * create_struct(const char *symbol) const =0
Returns a registered struct type, or NULL if symbol is invalid or unknown.
virtual IType_list * clone(const IType_list *type_list) const =0
Clones the given type list.
virtual Sint32 compare(const IType *lhs, const IType *rhs) const =0
Compares two instances of mi::neuraylib::IType.
virtual const IType_texture * create_texture(IType_texture::Shape shape) const =0
Creates a new instance of the type texture.
virtual const IType_array * create_deferred_sized_array(const IType *element_type, const char *size) const =0
Creates a new instance of a deferred-sized array type.
virtual const IType_double * create_double() const =0
Creates a new instance of the double type.
virtual Sint32 is_compatible(const IType *src, const IType *dst) const =0
Checks, if two instances of mi::neuraylib::IType are compatible, meaning that src can be casted to ds...
virtual const IType * create_from_mdl_type_name(const char *name) const =0
Creates a type based on its MDL type name.
virtual const IString * dump(const IType_list *list, Size depth=0) const =0
Returns a textual representation of a type list.
virtual const IString * get_mdl_module_name(const IType *type) const =0
Returns the MDL module name of the module which defines type.
virtual const IType_color * create_color() const =0
Creates a new instance of the type color.
virtual const IString * dump(const IType *type, Size depth=0) const =0
Returns a textual representation of a type.
virtual const IType_bsdf_measurement * create_bsdf_measurement() const =0
Creates a new instance of the type bsdf_measurement.
virtual const IType_vdf * create_vdf() const =0
Creates a new instance of the type vdf.
virtual const IType_array * create_immediate_sized_array(const IType *element_type, Size size) const =0
Creates a new instance of an immediate-sized array type.
virtual Sint32 compare(const IType_list *lhs, const IType_list *rhs) const =0
Compares two instances of mi::neuraylib::IType_list.
The type of kind float.
Definition: itype.h:250
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:253
The type of kind bsdf.
Definition: itype.h:509
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:512
The type of kind int.
Definition: itype.h:171
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:174
The type of kind light_profile.
Definition: itype.h:472
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:475
An ordered collection of types identified by name or index.
Definition: itype.h:540
virtual const IType * get_type(Size index) const =0
Returns the type for index, or NULL if there is no such type.
virtual const char * get_name(Size index) const =0
Returns the name for the given index, or NULL if there is no such type.
virtual Sint32 set_type(Size index, const IType *type)=0
Sets a type at a given index.
const T * get_type(const char *name) const
Returns the type for name, or NULL if there is no such type.
Definition: itype.h:571
virtual const IType * get_type(const char *name) const =0
Returns the type for name, or NULL if there is no such type.
virtual Sint32 add_type(const char *name, const IType *type)=0
Adds a type at the end of the list.
virtual Sint32 set_type(const char *name, const IType *type)=0
Sets a type identified by name.
virtual Size get_size() const =0
Returns the number of elements.
const T * get_type(Size index) const
Returns the type for index, or NULL if there is no such type.
Definition: itype.h:556
virtual Size get_index(const char *name) const =0
Returns the index for the given name, or -1 if there is no such type.
The type of kind matrix.
Definition: itype.h:324
virtual const IType_vector * get_element_type() const =0
Returns the type of the matrix elements, i.e., the type of a column vector.
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:327
The reference types.
Definition: itype.h:432
A string valued resource type.
Definition: itype.h:439
The type of kind string.
Definition: itype.h:270
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:273
The type of kind struct.
Definition: itype.h:372
virtual const IType * get_field_type(Size index) const =0
Returns a field type.
Predefined_id
IDs to distinguish predefined struct types.
Definition: itype.h:375
@ SID_MATERIAL_SURFACE
The "::material_surface" struct type.
Definition: itype.h:378
@ SID_MATERIAL_GEOMETRY
The "::material_geometry" struct type.
Definition: itype.h:380
@ SID_MATERIAL_VOLUME
The "::material_volume" struct type.
Definition: itype.h:379
@ SID_USER
A user-defined struct type.
Definition: itype.h:376
@ SID_MATERIAL
The "::material" struct type.
Definition: itype.h:381
@ SID_MATERIAL_EMISSION
The "::material_emission" struct type.
Definition: itype.h:377
virtual const char * get_symbol() const =0
Returns the qualified name of the struct type.
virtual Size find_field(const char *name) const =0
Returns the index of a field in linear time.
virtual const IAnnotation_block * get_field_annotations(Size index) const =0
Returns the annotations of a field.
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:386
virtual const IAnnotation_block * get_annotations() const =0
Returns the annotations of the struct type.
virtual Predefined_id get_predefined_id() const =0
If this struct is a predefined one, return its ID, else SID_USER.
virtual const char * get_field_name(Size index) const =0
Returns a field name.
The type of kind texture.
Definition: itype.h:446
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:449
Shape
The possible texture shapes.
Definition: itype.h:452
@ TS_CUBE
Cube map texture.
Definition: itype.h:455
@ TS_PTEX
PTEX texture.
Definition: itype.h:456
@ TS_3D
Three-dimensional texture.
Definition: itype.h:454
@ TS_BSDF_DATA
Three-dimensional texture representing a BSDF data table.
Definition: itype.h:457
@ TS_2D
Two-dimensional texture.
Definition: itype.h:453
virtual Shape get_shape() const =0
Returns the texture type.
The type of kind vdf.
Definition: itype.h:529
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:532
The type of kind vector.
Definition: itype.h:296
static const Kind s_kind
The kind of this subclass.
Definition: itype.h:299
virtual const IType_atomic * get_element_type() const =0
Returns the type of the vector elements.
The interface to MDL types.
Definition: itype.h:51
Kind
The possible kinds of types.
Definition: itype.h:54
@ TK_TEXTURE
A texture type. See mi::neuraylib::IType_texture.
Definition: itype.h:80
@ TK_MATRIX
A matrix type. See mi::neuraylib::IType_matrix.
Definition: itype.h:72
@ TK_BOOL
The boolean type. See mi::neuraylib::IType_bool.
Definition: itype.h:58
@ TK_COLOR
The color type. See mi::neuraylib::IType_color.
Definition: itype.h:74
@ TK_HAIR_BSDF
The hair_bsdf type. See mi::neuraylib::IType_hair_bsdf.
Definition: itype.h:88
@ TK_ALIAS
An alias for another type, aka typedef. See mi::neuraylib::IType_alias.
Definition: itype.h:56
@ TK_VDF
The vdf type. See mi::neuraylib::IType_vdf.
Definition: itype.h:92
@ TK_VECTOR
A vector type. See mi::neuraylib::IType_vector.
Definition: itype.h:70
@ TK_BSDF_MEASUREMENT
The bsdf_measurement type. See mi::neuraylib::IType_bsdf_measurement.
Definition: itype.h:84
@ TK_ARRAY
An array type. See mi::neuraylib::IType_array.
Definition: itype.h:76
@ TK_STRING
The string type. See mi::neuraylib::IType_string.
Definition: itype.h:68
@ TK_STRUCT
A struct type. See mi::neuraylib::IType_struct.
Definition: itype.h:78
@ TK_INT
The integer type. See mi::neuraylib::IType_int.
Definition: itype.h:60
@ TK_LIGHT_PROFILE
The light_profile type. See mi::neuraylib::IType_light_profile.
Definition: itype.h:82
@ TK_BSDF
The bsdf type. See mi::neuraylib::IType_bsdf.
Definition: itype.h:86
@ TK_EDF
The edf type. See mi::neuraylib::IType_edf.
Definition: itype.h:90
@ TK_ENUM
An enum type. See mi::neuraylib::IType_enum.
Definition: itype.h:62
@ TK_DOUBLE
The double type. See mi::neuraylib::IType_double.
Definition: itype.h:66
@ TK_FLOAT
The float type. See mi::neuraylib::IType_float.
Definition: itype.h:64
virtual const IType * skip_all_type_aliases() const =0
Returns the base type.
virtual Uint32 get_all_type_modifiers() const =0
Returns all type modifiers of a type.
Modifier
The possible kinds of type modifiers.
Definition: itype.h:98
@ MK_UNIFORM
A uniform type.
Definition: itype.h:100
@ MK_NONE
No type modifier (mutable, auto-typed).
Definition: itype.h:99
@ MK_VARYING
A varying type.
Definition: itype.h:101
virtual Kind get_kind() const =0
Returns the kind of type.
#define mi_static_assert(expr)
Compile time assertion that raises a compilation error if the constant expression expr evaluates to f...
Definition: assert.h:65
virtual const IInterface * get_interface(const Uuid &interface_id) const =0
Acquires a const interface from another.
virtual Uint32 release() const =0
Decrements the reference count.
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
Uint64 Size
Unsigned integral type that is large enough to hold the size of all types.
Definition: types.h:112
signed int Sint32
32-bit signed integer.
Definition: types.h:46
Mixin class template for deriving new interface declarations.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: example_derivatives.dox:5