NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
irendering_configuration.h
Go to the documentation of this file.
1 //*****************************************************************************
2 // Copyright 1986, 2014 NVIDIA Corporation. All rights reserved.
3 //*****************************************************************************
6 //*****************************************************************************
7 
8 #ifndef MI_NEURAYLIB_IRENDERING_CONFIGURATION_H
9 #define MI_NEURAYLIB_IRENDERING_CONFIGURATION_H
10 
12 #include <mi/neuraylib/version.h>
13 
14 namespace mi {
15 
16 class IArray;
17 class IString;
18 
19 namespace neuraylib {
20 
21 class IGpu_description;
22 
27 class ILpe_check_result : public
30  mi::base::Interface_declare<0xec3bc890,0x4ea8,0x4465,0x9e,0x83,0xd8,0x41,0xa8,0xb4,0x77,0x94>
31 {
32 public:
34  virtual Size get_messages_length() const = 0;
35 
38  virtual Size get_index( Size i) const = 0;
39 
42  virtual Size get_position( Size i) const = 0;
43 
46  virtual const char* get_message( Size i) const = 0;
47 };
48 
50 class IRendering_configuration : public
51  mi::base::Interface_declare<0x8e148c6e,0x3515,0x4368,0xba,0xb7,0x97,0xfd,0x26,0x35,0xbb,0x91>
52 {
53 public:
55 
56 
63  virtual Sint32 add_mdl_path( const char* path) = 0;
64 
71  virtual Sint32 remove_mdl_path( const char* path) = 0;
72 
76  virtual void clear_mdl_paths() = 0;
77 
83  virtual Size get_mdl_paths_length() const = 0;
84 
90  virtual const IString* get_mdl_path( Size index) const = 0;
91 
92 #ifdef MI_NEURAYLIB_DEPRECATED_5_0
93  Sint32 add_shader_path( const char* path) { return add_mdl_path( path); }
94 
95  Sint32 remove_shader_path( const char* path) { return remove_mdl_path( path); }
96 
97  void clear_shader_paths() { return clear_mdl_paths(); }
98 
99  Size get_shader_paths_length() const { return get_mdl_paths_length(); }
100 
101  const IString* get_shader_path( Size index) const { return get_mdl_path( index); }
102 #endif // MI_NEURAYLIB_DEPRECATED_5_0
103 
105 
107 
116  virtual Sint32 add_resource_path( const char* path) = 0;
117 
126  virtual Sint32 remove_resource_path( const char* path) = 0;
127 
133  virtual void clear_resource_paths() = 0;
134 
142  virtual Size get_resource_paths_length() const = 0;
143 
151  virtual const IString* get_resource_path( Size index) const = 0;
152 
153 #ifdef MI_NEURAYLIB_DEPRECATED_5_0
154  Sint32 add_image_path( const char* path) { return add_resource_path( path); }
155 
156  Sint32 remove_image_path( const char* path) { return remove_resource_path( path); }
157 
158  void clear_image_paths() { clear_resource_paths(); }
159 
160  Size get_image_paths_length() const { return get_resource_paths_length(); }
161 
162  const IString* get_image_path( Size index) const { return get_resource_path( index); }
163 #endif // MI_NEURAYLIB_DEPRECATED_5_0
164 
166 
168 
175  virtual Sint32 add_include_path( const char* path) = 0;
176 
183  virtual Sint32 remove_include_path( const char* path) = 0;
184 
188  virtual void clear_include_paths() = 0;
189 
195  virtual Size get_include_paths_length() const = 0;
196 
202  virtual const IString* get_include_path( Size index) const = 0;
203 
205 
207 
212  virtual Uint32 get_renderers_length() const = 0;
213 
219  virtual const char* get_renderer( Uint32 index) const = 0;
220 
243  virtual Sint32 set_renderer_option( const char* name, const char* value) = 0;
244 
252  virtual const IString* get_renderer_option( const char* name) const = 0;
253 
255 
262  static const Uint32 CPU = 0xffffffff;
263 
267  static const Uint32 ALL_GPUS = 0xfffffffe;
268 
272  static const Uint32 ALL_HOSTS = 0xfffffffd;
273 
277  static const Uint32 LOCAL_HOST = 0;
278 
280 
281 
291  virtual Sint32 set_gpu_enabled( bool value) = 0;
292 
296  virtual bool get_gpu_enabled() const = 0;
297 
306  virtual Sint32 set_driver_version_check_enabled( bool value) = 0;
307 
311  virtual bool get_driver_version_check_enabled() const = 0;
312 
327  virtual const IGpu_description* get_gpu_description( Uint32 gpu_id, Uint32 host_id = 0) = 0;
328 
337  virtual Uint32 get_highest_gpu_id( Uint32 host_id = 0) = 0;
338 
367  Uint32 resource_id, Uint32 host_id, const char* render_mode, bool enable) = 0;
368 
393  Uint32 resource_id, Uint32 host_id, const char* render_mode, bool& enable) = 0;
394 
396 
398 
418  const IArray* expressions) const = 0;
419 
421 
423 
435  virtual Sint32 set_metasl_compiler_option( const char* name, const char* value) = 0;
436 
442  virtual const IString* get_metasl_compiler_option( const char* name) const = 0;
443 
445 
446  virtual Sint32 MI_NEURAYLIB_DEPRECATED_METHOD_5_0(set_metasl_path)( const char* path) = 0;
447 
448  virtual const IString* MI_NEURAYLIB_DEPRECATED_METHOD_5_0(get_metasl_path)() const = 0;
449 
450 };
451  // end group mi_neuray_configuration
453 
454 } // namespace neuraylib
455 
456 } // namespace mi
457 
458 #endif // MI_NEURAYLIB_IRENDERING_CONFIGURATION_H