..
    This file was auto-generated by the 'repo_extension_docs' tool.
    Run 'repo extension_docs --help' for more details.

..
    [begin reference autogenerated]

.. _ext_omni_kit_loop-isaac:

..
    [end reference autogenerated]

..
    [begin title autogenerated]

[omni.kit.loop-isaac] Isaac Loop Runner
#######################################

..
    [end title autogenerated]

..
    [begin deprecation autogenerated]
..
    [end deprecation autogenerated]

..
    [begin version autogenerated]

**Version**: :guilabel:`1.3.7`

..
    [end version autogenerated]

..
    [begin description autogenerated]

Custom Loop Runner for Isaac Sim

..
    [end description autogenerated]

..
    [begin preview autogenerated]
..
    [end preview autogenerated]

..
    [begin enable-extension autogenerated]


Enable Extension
================

The extension can be enabled (if not already) in one of the following ways:

.. tab-set::
    .. tab-item:: Command-line interface
        :sync: tab_cli

        Define the next entry as an application argument from a terminal.

        .. code-block:: bash

            APP_SCRIPT.(sh|bat) --enable omni.kit.loop-isaac

    .. tab-item:: Experience/extension configuration
        :sync: tab_toml

        Define the next entry under ``[dependencies]`` in an experience (``.kit``) file or an extension configuration (``extension.toml``) file.

        .. code-block:: ini

            [dependencies]
            "omni.kit.loop-isaac" = {}

    .. tab-item:: Extension Manager UI
        :sync: tab_gui

        Open the *Window > Extensions* menu in a running application instance and search for ``omni.kit.loop-isaac``.
        Then, toggle the enable control button if it is not already active.


..
    [end enable-extension autogenerated]

..
    [begin usage autogenerated]
..
    [end usage autogenerated]

..
    [begin api autogenerated]

.. include:: api.rst

..
    [end api autogenerated]

..
    [begin actions autogenerated]
..
    [end actions autogenerated]

..
    [begin ogn autogenerated]
..
    [end ogn autogenerated]

..
    [begin settings autogenerated]

Settings
========

Other Settings
--------------

The extension changes some settings of the application or other extensions, which are listed in the table below.

.. list-table::
    :header-rows: 1

    * - Application/extension setting
      - Description
      - Value
    * - ``app.runLoopsGlobal.syncToPresent``
      - Don't sync threads to the present thread

      - ``False``
    * - ``app.runLoops.main.rateLimitEnabled``
      - Set to true to enable rate limiting for the main run loop

      - ``True``
    * - ``app.runLoops.main.rateLimitFrequency``
      - Rate limit frequency in Hz for the main run loop

      - ``120``
    * - ``app.runLoops.main.rateLimitUseBusyLoop``
      - Set to true to use a busy loop for the main run loop

      - ``False``
    * - ``app.runLoops.present.rateLimitEnabled``
      - Set to true to enable rate limiting for the present run loop

      - ``True``
    * - ``app.runLoops.present.rateLimitFrequency``
      - Rate limit frequency in Hz for the present run loop

      - ``60``
    * - ``app.runLoops.present.rateLimitUseBusyLoop``
      - Set to true to use a busy loop for the present run loop

      - ``False``
    * - ``app.runLoops.rendering_0.rateLimitEnabled``
      - Set to true to enable rate limiting for the rendering run loop

      - ``True``
    * - ``app.runLoops.rendering_0.rateLimitFrequency``
      - Rate limit frequency in Hz for the rendering run loop

      - ``120``
    * - ``app.runLoops.rendering_0.rateLimitUseBusyLoop``
      - Set to true to use a busy loop for the rendering run loop

      - ``False``

..
    [end settings autogenerated]
