Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disables default viewport when headless but cameras are enabled #851

Merged
merged 4 commits into from
Aug 23, 2024

Conversation

kellyguo11
Copy link
Contributor

@kellyguo11 kellyguo11 commented Aug 22, 2024

Description

When cameras are enabled, a default render product always gets created for the viewport, which brings additional overhead for rendering the viewport at each step. However, when running in headless mode, we may not need to render the viewport if we are not recording or livestreaming.

This change disables viewport rendering in the headless cases where recording and livestreaming are not required.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have run the pre-commit checks 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

@Mayankm96 Mayankm96 changed the title Disables default viewport in some scenarios for better performance Disables default viewport when headless but cameras are enabled Aug 22, 2024
@Mayankm96
Copy link
Contributor

Mayankm96 commented Aug 22, 2024

Renamed the title to make it clear which scenarios are being referred to.

Also adding @hhansen-bdai as a reviewer to check as well.

@Mayankm96 Mayankm96 added the enhancement New feature or request label Aug 23, 2024
@kellyguo11 kellyguo11 merged commit 3e1f679 into isaac-sim:main Aug 23, 2024
1 of 2 checks passed
iamdrfly pushed a commit to iamdrfly/IsaacLab that referenced this pull request Nov 21, 2024
…c-sim#851)

# Description

When cameras are enabled, a default render product always gets created
for the viewport, which brings additional overhead for rendering the
viewport at each step. However, when running in headless mode, we may
not need to render the viewport if we are not recording or
livestreaming.

This change disables viewport rendering in the headless cases where
recording and livestreaming are not required.

## Type of change

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)


## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] 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
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants