Usage ¶
initialize(session: hapi.Session, cook_options: hapi.CookOptions, use_cooking_thread: bool, cooking_thread_stack_size: int, houdini_environment_files: str, otl_search_path: str, dso_search_path: str, image_dso_search_path: str, audio_dso_search_path: str) → bool
Create the asset manager, set up environment variables, and initialize the main Houdini scene. No license check is done during this step. Only when you try to load an asset library (OTL) do we actually check for licenses.
session
The session of Houdini you are interacting with. See hapi.Session for more on sessions. Pass None to just use the default in-process session.
cook_options
Global cook options used by subsequent default cooks. This can be overwritten by individual cooks but if you choose to instantiate assets with cook_on_load set to True then these cook options will be used.
use_cooking_thread
Use a separate thread for cooking of assets. This allows for asynchronous cooking and larger stack size.
cooking_thread_stack_size
Set the stack size of the cooking thread. Use -1 to set the stack size to the Houdini default. This value is in bytes.
houdini_environment_files
A list of paths, separated by a “;” on Windows and a “:” on Linux and Mac, to .env files that follow the same syntax as the houdini.env file in Houdini’s user prefs folder. These will be applied after the default houdini.env file and will overwrite the process' environment variable values. You an use this to enforce a stricter environment when running engine. For more info, see: http://www.sidefx.com/docs/houdini/basics/config_env
otl_search_path
The directory where OTLs are searched for. You can pass None here which will only use the default Houdini OTL search paths. You can also pass in multiple paths separated by a “;” on Windows and a “:” on Linux and Mac. If something other than None is passed the default Houdini search paths will be appended to the end of the path string.
dso_search_path
The directory where generic DSOs (custom plugins) are searched for. You can pass None here which will only use the default Houdini DSO search paths. You can also pass in multiple paths separated by a “;” on Windows and a “:” on Linux and Mac. If something other than None is passed the default Houdini search paths will be appended to the end of the path string.
image_dso_search_path
The directory where image DSOs (custom plugins) are searched for. You can pass None here which will only use the default Houdini DSO search paths. You can also pass in multiple paths separated by a “;” on Windows and a “:” on Linux and Mac. If something other than None is passed the default Houdini search paths will be appended to the end of the path string.
audio_dso_search_path
The directory where audio DSOs (custom plugins) are searched for. You can pass None here which will only use the default Houdini DSO search paths. You can also pass in multiple paths separated by a “;” on Windows and a “:” on Linux and Mac. If something other than None is passed the default Houdini search paths will be appended to the end of the path string.