Python Bindings#
Contents:
- carb package
ColorRgbColorRgbDoubleColorRgbaColorRgbaDoubleDouble2Double3Double4Float2Float3Float4FrameworkInt2Int3Int4InterfaceDescPluginDescPluginHotReloadPluginImplDescSubscriptionUint2Uint3Uint4Versionanswer_question()breakpoint()cache()deprecated()get_framework()log()log_deprecation()log_error()log_info()log_verbose()log_warn()wait_for_native_debugger()wraps()ILoggingLogSettingBehaviorLoggerLoggerHandleacquire_logging()DirectoryItemTypeFileIFileSystemclose_file()copy()exists()flush_file()get_app_directory_path()get_current_directory_path()get_file_size()get_mod_time()is_directory()make_directory()make_temp_directory()open_file_to_append()open_file_to_read()open_file_to_write()remove_directory()set_app_directory_path()set_current_directory_path()
acquire_filesystem()- carb.datasource
- carb.dictionary
IDictionarycreate_item()destroy_item()get()get_array_length()get_as_bool()get_as_float()get_as_int()get_as_string()get_dict_copy()get_item()get_item_child_by_index()get_item_child_by_index_mutable()get_item_child_count()get_item_mutable()get_item_name()get_item_parent()get_item_parent_mutable()get_item_type()get_preferred_array_type()is_accessible_as()is_accessible_as_array_of()readLock()set()set_bool()set_bool_array()set_float()set_float_array()set_int()set_int_array()set_string()set_string_array()unlock()update()writeLock()
ISerializerItemItemTypeUpdateActionacquire_dictionary_interface()acquire_serializer_interface()get_dictionary()get_dictionary_interface()get_json_serializer()get_toml_serializer()lru_cache()
- carb.eventdispatcher
- carb.events
AdapterTypeIEventIEventStreamcreate_subscription_to_pop()create_subscription_to_pop_by_type()create_subscription_to_push()create_subscription_to_push_by_type()dispatch()event_countget_subscription_to_pop_order()get_subscription_to_push_order()get_subscriptions_to_pop()get_subscriptions_to_push()namenext_event()next_event_by_type()pop()pump()push()set_subscription_to_pop_order()set_subscription_to_push_order()try_pop()
IEventsIEventsAdapterISubscriptionMappingEntryacquire_events_adapter_interface()acquire_events_interface()get_events_adapter_interface()get_events_interface()register_event_alias()type_from_string()unregister_event_alias()
- carb.input
ActionEventActionMappingDescActionMappingSetDeviceTypeEventTypeFilterResultGamepadGamepadConnectionEventGamepadConnectionEventTypeGamepadEventGamepadInputIInputadd_action_mapping()clear_action_mappings()create_action_mapping_set()destroy_action_mapping_set()distribute_buffered_events()filter_buffered_events()get_action_button_flags()get_action_count()get_action_mapping_count()get_action_mapping_set_by_path()get_action_mappings()get_action_value()get_actions()get_device_name()get_device_type()get_gamepad_button_flags()get_gamepad_guid()get_gamepad_name()get_gamepad_value()get_global_modifier_flags()get_input_provider()get_keyboard_button_flags()get_keyboard_name()get_keyboard_value()get_modifier_flags()get_mouse_button_flags()get_mouse_coords_normalized()get_mouse_coords_pixel()get_mouse_name()get_mouse_value()remove_action_mapping()set_action_mapping()set_default_action_mapping()shutdown()startup()subscribe_to_action_events()subscribe_to_gamepad_connection_events()subscribe_to_gamepad_events()subscribe_to_input_events()subscribe_to_keyboard_events()subscribe_to_mouse_events()unsubscribe_to_action_events()unsubscribe_to_gamepad_connection_events()unsubscribe_to_gamepad_events()unsubscribe_to_input_events()unsubscribe_to_keyboard_events()unsubscribe_to_mouse_events()
InputDeviceInputEventInputProviderKeyboardKeyboardEventKeyboardEventTypeKeyboardInputAAPOSTROPHEBBACKSLASHBACKSPACECCAPS_LOCKCOMMACOUNTDDELDOWNEENDENTEREQUALESCAPEFF1F10F11F12F2F3F4F5F6F7F8F9GGRAVE_ACCENTHHOMEIINSERTJKKEY_0KEY_1KEY_2KEY_3KEY_4KEY_5KEY_6KEY_7KEY_8KEY_9LLEFTLEFT_ALTLEFT_BRACKETLEFT_CONTROLLEFT_SHIFTLEFT_SUPERMMENUMINUSNNUMPAD_0NUMPAD_1NUMPAD_2NUMPAD_3NUMPAD_4NUMPAD_5NUMPAD_6NUMPAD_7NUMPAD_8NUMPAD_9NUMPAD_ADDNUMPAD_DELNUMPAD_DIVIDENUMPAD_ENTERNUMPAD_EQUALNUMPAD_MULTIPLYNUMPAD_SUBTRACTNUM_LOCKOPPAGE_DOWNPAGE_UPPAUSEPERIODPRINT_SCREENQRRIGHTRIGHT_ALTRIGHT_BRACKETRIGHT_CONTROLRIGHT_SHIFTRIGHT_SUPERSSCROLL_LOCKSEMICOLONSLASHSPACETTABUUNKNOWNUPVWXYZnamevalue
MouseMouseEventMouseEventTypeMouseInputacquire_input_interface()acquire_input_provider()get_action_mapping_desc_from_string()get_string_from_action_mapping_desc()
- carb.l10n
- carb.profiler
- carb.settings
ChangeEventTypeISettingscreate_dictionary_from_settings()destroy_item()get()get_as_bool()get_as_float()get_as_int()get_as_string()get_settings_dictionary()initialize_from_dictionary()is_accessible_as()set()set_bool()set_bool_array()set_default()set_default_bool()set_default_float()set_default_int()set_default_string()set_float()set_float_array()set_int()set_int_array()set_string()set_string_array()subscribe_to_node_change_events()subscribe_to_tree_change_events()unsubscribe_to_change_events()update()
SubscriptionIdacquire_settings_interface()get_settings()get_settings_interface()lru_cache()
- carb.simplegui
ConditionISimpleGuibegin()begin_child()begin_popup_modal()bullet()button()checkbox()close_current_popup()collapsing_header()color_edit3()color_edit4()combo()dock_builder_dock_window()dummy()end()end_child()end_popup()get_display_size()indent()input_float()input_int()input_text()menu_item_ex()open_popup()plot_lines()pop_id()pop_item_width()pop_style_color()pop_style_var()progress_bar()push_id_int()push_id_string()push_item_width()push_style_color()push_style_var_float()push_style_var_float2()same_line()same_line_ex()separator()set_display_size()set_next_window_pos()set_next_window_size()set_scroll_here_y()show_demo_window()slider_float()slider_int()small_button()spacing()text()text_unformatted()text_wrapped()tree_node_ptr()tree_pop()unindent()
acquire_simplegui_interface()get_simplegui()get_simplegui_interface()lru_cache()
- carb.tokens
- carb.variant
- carb.windowing
CursorCursorModeCursorStandardShapeGLContextIGLContextIWindowingcreate_cursor()create_cursor_standard()create_window()destroy_cursor()destroy_window()focus_window()get_clipboard()get_cursor_mode()get_cursor_position()get_input_mode()get_keyboard()get_monitor_position()get_monitor_work_area()get_monitors()get_mouse()get_native_display()get_native_window()get_window_height()get_window_opacity()get_window_position()get_window_user_pointer()get_window_width()hide_window()is_window_focused()is_window_fullscreen()is_window_maximized()is_window_minimized()maximize_window()minimize_window()poll_events()resize_window()restore_window()set_clipboard()set_cursor()set_cursor_mode()set_cursor_position()set_input_mode()set_window_content_scale()set_window_fullscreen()set_window_icon()set_window_opacity()set_window_position()set_window_should_close()set_window_title()set_window_user_pointer()should_window_close()show_window()translate_key()update_input_devices()wait_events()
ImageInputModeMonitorWindowacquire_gl_context_interface()acquire_windowing_interface()
- omni package
- omni.core
Float2IObjectITypeFactoryInt2ResultACCESS_DENIEDALREADY_EXISTSFAILINSUFFICIENT_BUFFERINTERRUPTEDINVALID_ARGUMENTINVALID_DATA_SIZEINVALID_DATA_TYPEINVALID_INDEXINVALID_OPERATIONINVALID_STATENOT_ENOUGH_DATANOT_FOUNDNOT_IMPLEMENTEDNOT_SUPPORTEDNO_INTERFACENO_MORE_ITEMSNULL_POINTEROPERATION_ABORTEDOUT_OF_MEMORYSUCCESSTIMED_OUTTOO_MUCH_DATATRY_AGAINVERSION_CHECK_FAILUREVERSION_PARSE_ERRORWOULD_BLOCKnamevalue
TypeFactoryLoadFlagsUInt2create_type()register_module()
- omni.experimental.url
- omni.ext
DownloadStateExtensionManageradd_path()add_path_protocol_provider()add_registry_provider()fetch_all_extension_packages()fetch_extension_packages()fetch_extension_summaries()fetch_extension_versions()get_change_event_stream()get_enabled_extension_id()get_enabled_extension_module_names()get_extension_dict()get_extension_id_by_module()get_extension_packages()get_extension_path()get_extension_path_by_module()get_extensions()get_folders()get_hooks()get_registry_extension_dict()get_registry_extension_packages()get_registry_extensions()get_registry_providers()is_extension_enabled()pack_extension()process_and_apply_all_changes()publish_extension()pull_extension()pull_extension_async()refresh_registry()remove_path()remove_path_protocol_provider()remove_registry_provider()set_extension_enabled()set_extension_enabled_immediate()set_extensions_excluded()solve_extensions()subscribe_to_extension_enable()sync_registry()uninstall_extension()unpublish_extension()
ExtensionPathTypeExtensionStateChangeTypeICppExtIExtIExtensionManagerHooksIExtensionsIHookHolderIRegistryProvideracquire_ext_interface()acquire_extensions_interface()create_link()destroy_link()get_all_sys_paths()get_dangling_references()get_extension_name()get_extensions_interface()get_fast_importer_sys_paths()is_link()pack_extension()release_ext_interface()unpack_extension()
- omni.kit.app
IAppdelay_app_ready()ensure_runloop()get_app_environment()get_app_filename()get_app_name()get_app_version()get_app_version_short()get_build_version()get_extension_manager()get_kernel_version()get_kit_version()get_kit_version_hash()get_kit_version_short()get_log_event_stream()get_message_bus_event_stream()get_platform_info()get_post_update_event_stream()get_pre_update_event_stream()get_python_scripting()get_shutdown_event_stream()get_startup_event_stream()get_time_since_start_ms()get_time_since_start_s()get_update_event_stream()get_update_number()is_app_external()is_app_ready()is_debug_build()is_running()next_update_async()post_quit()post_uncancellable_quit()post_update_async()pre_update_async()print_and_log()replay_log_messages()report_alive()restart()run()shutdown()shutdown_and_release_framework()startup()toggle_log_message_recording()try_cancel_shutdown()update()
IAppScriptingSettingChangeSubscriptionacquire_app_interface()crash()deprecated()get_app()get_app_interface()log_deprecation()queue_event()register_event_alias()send_telemetry_event()
- omni.log
ChannelUpdateReasonILogadd_channel_update_consumer()add_message_consumer()enabledflush()get_channel_description()get_channel_enabled()get_channel_level()get_channel_names()is_async()is_logging_at_level()levelremove_channel_update_consumer()remove_message_consumer()set_async()set_channel_description()set_channel_enabled()set_channel_level()
ILogChannelFilterILogChannelUpdateConsumerILogMessageConsumerLevelSettingBehaviorerror()fatal()get_log()info()log()verbose()warn()
- omni.platforminfo
ArchitectureCompositorInfoCpuFeatureAMD3_D_NOWAMD3_D_NOW_EXTAMD_MMX_EXTARM_ASIMDARM_ATOMICSARM_CRC32ARM_CRYPTOARM_NEONARM_SHAFEATURE_COUNTX86_AVXX86_AVX2X86_AVX512_4FMAPSX86_AVX512_4_VNNIWX86_AVX512_BWX86_AVX512_CDX86_AVX512_DQX86_AVX512_ERX86_AVX512_FX86_AVX512_IFMAX86_AVX512_PFX86_AVX512_VLX86_AVX512__BF16X86_AVX512__BITALGX86_AVX512__VBMIX86_AVX512__VBMI2X86_AVX512__VNNIX86_AVX512__VP2INTERSECTX86_AVX512__VPOPCNTDQX86_AVX_VNNIX86_F16CX86_FMAX86_MMXX86_POPCNTX86_SSEX86_SSE2X86_SSE3X86_SSE41X86_SSE42X86_SSSE3X86_TSCnamevalue
DisplayFlagsDisplayInfoICGroupCpuInfoICGroupMemoryInfoICpuInfoIDisplayInfoILimitedCpuInfoILimitedMemoryInfoIMemoryInfoIOsInfoIOsInfo2MachineIdFlagsMachineIdVersionModeFlagsModeIndexModeInfoOrientationOsOsVersion
- omni.schema
- omni.str
- omni.structuredlog
IStructuredLogControlIStructuredLogControl2IStructuredLogExtraFieldsIStructuredLogFromILogIStructuredLogFromILog2IStructuredLogSettingsIStructuredLogSettings2IdModeIdTypeInvalidEventExceptionInvalidSchemaExceptionStructuredLogEventUniqueAppcreate_launch_guard()register_schema()send_event()
- omni.core