Commit a62181b2 authored by matthewtrepte's avatar matthewtrepte Committed by Kelly Guo

Updates Rendering Mode guide in documentation (#361)

# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link:
https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html
-->

Added in a detail for selecting the Rendering Mode from the CLI
argument.

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Bug fix (non-breaking change which fixes an issue)

## Screenshots

Please attach before and after screenshots of the change if applicable.

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [ ] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
parent 01dcde53
Configuring Rendering Settings
==============================
Isaac Lab offers 4 preset rendering modes: performance, balanced, quality, and xr.
Isaac Lab offers 3 preset rendering modes: performance, balanced, and quality.
You can select a mode via a command line argument or from within a script, and customize settings as needed.
Adjust and fine-tune rendering to achieve the ideal balance for your workflow.
......@@ -10,13 +10,7 @@ Selecting a Rendering Mode
Rendering modes can be selected in 2 ways.
1. using the ``--rendering_mode`` command line argument
.. code-block:: bash
./isaaclab.sh -p scripts/tutorials/00_sim/set_rendering_mode.py --rendering_mode {performance/balanced/quality}
2. using the ``rendering_mode`` input class argument in :class:`~sim.RenderCfg`.
1. using the ``rendering_mode`` input class argument in :class:`~sim.RenderCfg`
.. code-block:: python
......@@ -24,10 +18,22 @@ Rendering modes can be selected in 2 ways.
# scripts/tutorials/00_sim/set_rendering_mode.py
render_cfg = sim_utils.RenderCfg(rendering_mode="performance")
2. using the ``--rendering_mode`` CLI argument and not passing ``rendering_mode`` to :class:`~sim.RenderCfg`, since :class:`~sim.RenderCfg` takes precedence.
.. code-block:: bash
./isaaclab.sh -p scripts/tutorials/00_sim/set_rendering_mode.py --rendering_mode {performance/balanced/quality}
.. code-block:: bash
# in the tutorial script example, remove the rendering_mode passed to RenderCfg
render_cfg = sim_utils.RenderCfg()
Note, the ``rendering_mode`` defaults to ``balanced``.
However, in the case where the launcher argument ``--enable_cameras`` is not set, then
the default ``rendering_mode`` is not applied and, instead, the default kit rendering settings are used.
Example renders from the ``set_rendering_mode.py`` script.
To help assess rendering, the example scene includes some reflections, translucency, direct and ambient lighting, and several material types.
......@@ -120,10 +126,11 @@ There are 2 ways to provide settings that overwrite presets.
2. For more control, :class:`~sim.RenderCfg` allows you to overwrite any RTX setting by using the ``carb_settings`` argument.
Examples of RTX settings can be found from within the repo, in the render mode preset files located in ``apps/rendering_modes``.
An example usage of ``carb_settings.``
In addition, the RTX documentation can be found here - https://docs.omniverse.nvidia.com/materials-and-rendering/latest/rtx-renderer.html.
An example usage of ``carb_settings``.
.. code-block:: python
render_cfg = sim_utils.RenderCfg(
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment