HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_EnvControl.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: UT_EnvControl.h ( UT Library, C++)
7  *
8  * COMMENTS: In Houdini applications, there are many environment variables
9  * which control the behaviour of certain features/capabilities.
10  * This class provides a centralized place to efficiently query
11  * these variables. The reason for the centralization is so that
12  * we can easily get a list of these control variables. As well,
13  * this mechanism provides ways of changing the control settings
14  * from environment variables to disk file to registry entry.
15  * Currently only environment variable control is supported.
16  *
17  *
18  * When adding a new environment variable, please document the variable in
19  * $SHD/ref/env.txt
20  */
21 
22 #ifndef __UT_EnvControl__
23 #define __UT_EnvControl__
24 
25 #include "UT_API.h"
26 #include "UT_StringHolder.h"
27 #include <SYS/SYS_StaticAssert.h>
28 #include <SYS/SYS_Types.h>
29 
30 class UT_StringArray;
31 class UT_Variant;
32 
33 namespace UT_Package
34 {
35  class Loader;
36  class Package;
37 }
38 
39 // This define declares a fixed size of array for holding our cached
40 // environment variable values. It should be larger than any of our actual
41 // requirements so that we can add new enum values to the end of these
42 // tables without breaking ABI compatibility (as long as we don't actually
43 // exceed this value and need to increase it).
44 #define MAX_CONTROLS_WITH_BUFFER 512
45 
47 {
48  // UT library: Public interface
66 
67  // UT: Internal controls
79 
80  // Houdini Environment File Control
83 
84  // FS: Public interface
92 
93  // GA: Public interface
95 
96  // IMG3D: Public interface
98 
99  // IMG: Public interface
128  // IMG: Private interface
137 
138  // MV: Public interface
140 
141  // VEX: Public interface
152 
153  // VEX: Private interface
155 
156  // RE: Public interface
166 
167  // CMD
170 
171  // OP
175 
176  // GEO
180 
181  // GU
183 
184  // RAY
195 
199 
221 
224 
225  // COP2
228 
229  // IFD
233 
234  // MAT
236 
237  // UI
259 
260  // OPUI
266 
267  // DM
270 
271  // MATUI
273 
274  // Custom
279 
280  // LM
291 
292  // CHOP
294 
295  // SHOP
298 
299  // VOP
301 
302  // SHLF
305 
306  // Other
312 
313  // Backwards Compatability
322 
335 
337  // Have houdini check process fallback to the old deprecated API
341 
343 
344  // hscript
348 
350 
351  // This is for "internal use" only. It turns on features that are not
352  // ready for prime-time.
354 
355  // Maximum number of files to keep in the backup directory
357 
359 
361 
363 
366 
369 
371 
372  // Controls the number of complete FBX scenes to
373  // keep cached in memory after import. Defaults to 1.
375 
376  // Controls whether to transform the results of evaluating a MotionClip
377  // by the intrinsic matrix of the packed primitive.
379 
384 
387 
388  // OpenGL
392 
393  // OpenCL
397  ENV_HOUDINI_OCL_OGL_INTEROP, // Use CE_Context::shouldUseOCLOGLInterop instead of raw access to this that does additional compatability checks
400  // Can be used to force disable the use of images for advection by the Gas
401  // Advect CL 2.0 DOP.
403  // Can be used to force use of SwiftShader by the Rasterize Geometry COP.
405  // The rasterizer COP can use interop to copy from vulkan memory to OpenCL
406  // memory without leaving the GPU. However, this causes a memory leak on
407  // some NVIDIA drivers. This environment variable controls that
408  // functionality (0 means no interop, 1 means do it if we can).
411 
415 
417 
418  // Maximum megabytes in write buffer.
420 
422 
426 
429 
431 
433 
435 
437 
439 
442 
444 
446 
447  // Used to force regular LM checks on Steam builds
449 
450  // OptiX
452 
454 
455  // Package
458 
459  // Viewer state
461 
463 
465 
467 
468  // TOP
481 
482  // HAPI
484 
485  // LOP
489 
491 
493 
494  // HDA plugin for USD geometry cache size
496 
498 
500 
502 
503  // Send python panel erros to the console
505 
507 
509 
511 
512  // Specify whether or not Houdini GL should use Mtlx materials
514 
515  // New op viewer, defaults to on.
517 
519 
521 
523 
525 
526  ENV_KARMA_DICING_LEGACY, // Karma legacy dicing behaviour
527  ENV_KARMA_VARYING_ARRAY_PRIMVARS, // Varying length array primvars
530 
531  // Save HDA internal sections alphabetically (where it makes sens)
533 
535 
536  // MV
538 
540 
542 
543  // microfacet conductor fresnel to fix glowing issue with rough metals
545 
546  // texturing issues relating to bad derivatives
548 
550 
552 
554 
556 
559 
560  // Suppress creation of the non-critical files when expanding an HDA
562 
563  // Tells Houdini to prefer "last cooked" context options over "global"
564  // options when a node is asked to cook with its last cooked options.
566 
568 
570 
572 
574 
579 
581 
583 
584  // Change to behavior of primitive sub-patterns. New behavior is
585  // definitely more correct, but might change things in unexpected ways.
587 
588  ENV_MAX_INT_CONTROLS // <- Must be last
589 };
590 
592 {
593  // UT: Public interface
597 
598  // UT: Internal variables
600 
601  // IMG: Public interface
604 
605  // RE
607 
608  // UI
611 
612  // GR
614 
615  // Custom
617 
618  // ROP: Internal variables
620 
621  // OpenCL: Memory pool size, as percentage of GPU memory.
623 
624  // OpenCL: amount of VRAM that IMX layers are allowed to use.
626 
627  // CH
629 
630  // LOP interactive selection redraw time
632 
633  // Percent grey that shows as a zero exposure value when displaying
634  // pixel luminance in log terms. Values outside (0, 1) cause us to
635  // not calculate or display luminance in log terms.
637 
638  ENV_MAX_FLT_CONTROLS // <- Must be last
639 };
640 
642 {
643  // UT: Public interface
663 
664  // UT: Internal variables
668 
669  // external tools
671 
672  // IMG: Public interface
675 
676  // VEX(VMAT)
685 
686  // HOM
688 
689  // OP
690  ENV_HOUDINI_HIP_DEFAULT_NAME, // "untitled.hip"
693 
694  // VOP
696 
697  // GEO
699 
700  // COP
707 
708  // CHOP
710 
711  // TOP
713 
714  // LOP
716 
717  // IFD
723 
724  // UI
735 
736  // FUI
739 
740  // CHUI
742 
743  // OPUI
747 
748  // VEX(VCC)
750 
751  // Custom
759  ENV_HOUDINI_VIEW_METACAM, //OTLs that lock to view in a special way
760 
761  // Path variables
764 
795 
799 
801 
804 
806 
812 
814 
816 
821 
828 
831 
833 
835 
836  // These are here so we can have them show up in hconfig and provide
837  // help. They should only be used implicitly.
838  ENV_HSITE, // Between HFS and HOME.
839  ENV_JOB, // We should not use JOB!
840 
842 
845 
847 
848  // OPENGL
855 
856  // OPENCL
863 
864  // Orbolt
866 
867  // Anonymous Usage Statistics
869 
871 
873 
875 
876  // Optix
878 
880 
881  // BGEO plugin for USD default load arguments
883 
884  // LM
902 
903  // Python
905 
906  // Logging
910 
911  // Default asset/material catalog databases
915 
916  // Networking
919 
920  // HQueue
926 
927  // Render delegate to use by default on new Houdini clones
932 
933  // Render Product Types that should not show their AOVs in the list
934  // that shows up in the viewport menu.
936 
939 
941 
942  // When a loaded HDA changes on disk, perform this action by default
943  // instead of showing the interactive message.
945 
946  ENV_MAX_STR_CONTROLS // <- Must be last
947 };
948 
949 // If these constraints are ever violated in a HEAD branch, it's time to
950 // increase MAX_CONTROLS_WITH_BUFFER. If these constraints are violated in
951 // a released build, get rid of the "+50" part, and if they are exceeded
952 // again then we must increate MAX_CONTROLS_WITH_BUFFER in a daily build and
953 // break ABI compatiblity. But hopefully that won't happen...
957 
959 {
960 public:
961  UT_EnvControl();
962  ~UT_EnvControl();
963 
964  UT_EnvControl(const UT_EnvControl &) = delete;
965  UT_EnvControl &operator=(const UT_EnvControl &) = delete;
966 
967  void init();
968 
969  static int getInt(UT_IntControl i)
970  { return getControl().myIValues[i]; }
972  { return getControl().myFValues[i]; }
973  static const char *getString(UT_StrControl i)
974  { return getControl().mySValues[i]; }
975 
976  // Look up the appropriate variable name for the token
977  static const char *getIntVar(UT_IntControl i);
978  static const char *getFloatVar(UT_FltControl i);
979  static const char *getStringVar(UT_StrControl i);
980 
981  static void setStringVar(UT_StrControl i, const char *value);
982 
983  // Look up the appropriate old style variable name for the token. This can
984  // be used to check for old environment variables.
985  static const char *getOldIntVar(UT_IntControl i);
986  static const char *getOldFloatVar(UT_FltControl i);
987  static const char *getOldStringVar(UT_StrControl i);
988 
989  /// Indicate that the given variable changed and update our cached values.
990  /// If varname is NULL, then all variables are updated.
991  static void varChanged(const char *varname)
992  { varChanged(varname, nullptr); }
993 
994  /// Update the cached varname value with the given value so that we can
995  /// avoid an extraneous HoudiniGetenv() for the equivalent code snippet:
996  /// @code
997  /// HoudiniSetenv(name, value);
998  /// UT_EnvControl::varChanged(name);
999  /// @endcode
1000  /// @return true if name was found and value is non-null, in which case the
1001  /// HoudiniSetenv() was called, else false is returned.
1002  static bool varChanged(const char *varname, const char *value);
1003 
1004  static void changeExistLookupDefault(UT_IntControl i, int new_def);
1005 
1006  /// Queries the cached variable value. Unrecognized variables are
1007  /// returned as UT_Variant::Type::Unknown. String values are returned
1008  /// as UT_Variant::Type::Pointer to allow distinguishing between null
1009  /// pointers and empty strings. If you intend to hold onto the string
1010  /// value beyond immediately using it, you must make your own copy!
1011  static UT_Variant getVarValue(const char *varname);
1012 
1013  /// Set all additional .env files to be parsed for env variable values.
1014  /// It is best to call getAdditionalEnvironmentFiles() first and then
1015  /// append to the list because this function will overwrite all the
1016  /// additional paths that were previously set.
1017  /// You can still use the HOUDINI_NO_ENV_FILE_OVERRIDES to disallow
1018  /// overwrites, knowing that these files get applied AFTER the default
1019  /// houdini.env file in the user's home directory.
1020  /// That said, HOUDINI_NO_ENV_FILE will have no effect on this function.
1021  /// If additional files are set, they will be used, regardless of the
1022  /// value of HOUDINI_NO_ENV_FILE.
1023  static void setAdditionalEnvironmentFiles(
1024  const UT_StringArray &files);
1025 
1026  /// Return the current list of additional environment files.
1027  static const UT_StringArray&
1028  getAdditionalEnvironmentFiles();
1029 
1030  // Print messages collected during init phase to console
1031  static void logMessages()
1032  {
1033  getControl().logMessagesToConsole();
1034  }
1035 
1036  // Package loader management
1037  // Load the pakages located in the folders specified by pkg_paths.
1038  // Use this method for loading package dynamically
1039  static void loadPackages(UT_StringArray const &pkg_paths, UT_Package::Loader& pkg_loader);
1040  static UT_Package::Package & loadPackage(char const * pkg_filepath, UT_Package::Loader& pkg_loader);
1041 
1042  // Returns the main package loader, this loader contains all
1043  // packages loaded at runtime.
1044  static UT_Package::Loader& packageLoader();
1045 
1046 private:
1047  void doInit(bool init_defaults);
1048  void setDefaults();
1049  bool loadEnvironmentFile(const char *path,
1050  bool allow_overrides);
1051  void loadDefaultEnvironmentFile();
1052  void loadEnvironmentFiles();
1053  void loadEnvironment(bool init_defaults);
1054 
1055  void updateExistLookup(int i, const char *value = nullptr);
1056  void updateIntLookup(int i, const char *value = nullptr);
1057  void updateFltLookup(int i, const char *value = nullptr);
1058  void updateStrLookup(int i, bool fix_path,
1059  const char *value = nullptr);
1060 
1061  void updateVarTables(UT_Package::Loader const& pkg_loader);
1062 
1063  void loadPackageConfig();
1064  void logMessagesToConsole() const;
1065 
1066  int myIValues[MAX_CONTROLS_WITH_BUFFER];
1067  float myFValues[MAX_CONTROLS_WITH_BUFFER];
1068  char *mySValues[MAX_CONTROLS_WITH_BUFFER];
1069 
1070  static UT_EnvControl &getControl()
1071  {
1072  if (!theControl)
1073  {
1074  theControl = new UT_EnvControl();
1075  theControl->init();
1076 
1077  }
1078  return *theControl;
1079  }
1080  static UT_EnvControl *theControl;
1081 
1082  UT_StringHolder myLogMessages;
1083 };
1084 
1085 #endif
static void varChanged(const char *varname)
static const char * getString(UT_StrControl i)
GLsizei const GLfloat * value
Definition: glcorearb.h:824
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define UT_API
Definition: UT_API.h:14
static void logMessages()
UT_StrControl
static int getInt(UT_IntControl i)
static fpreal getFloat(UT_FltControl i)
fpreal64 fpreal
Definition: SYS_Types.h:278
LeafData & operator=(const LeafData &)=delete
SYS_STATIC_ASSERT(ENV_MAX_INT_CONTROLS+50< MAX_CONTROLS_WITH_BUFFER)
UT_FltControl
#define MAX_CONTROLS_WITH_BUFFER
Definition: UT_EnvControl.h:44
UT_IntControl
Definition: UT_EnvControl.h:46