diff --git a/Docs/adv_rendering_options.md b/Docs/adv_rendering_options.md index 3232e65bd..fbf765e0a 100644 --- a/Docs/adv_rendering_options.md +++ b/Docs/adv_rendering_options.md @@ -1,16 +1,15 @@ # Rendering options - +This guide details the different rendering options available in CARLA, including quality levels, no-rendering mode and off-screen mode. It also explains how version 0.9.12 of CARLA differs from previous versions in these respects. - [__Graphics quality__](#graphics-quality) - - [Vulkan vs OpenGL](#vulkan-vs-opengl) + - [Vulkan graphics API](#vulkan-graphics-api) - [Quality levels](#quality-levels) - [__No-rendering mode__](#no-rendering-mode) - [__Off-screen mode__](#off-screen-mode) - - [Off-screen Vs no-rendering](#off-screen-vs-no-rendering) -- [__Running off-screen using a preferred GPU__](#running-off-screen-using-a-preferred-gpu) - - [Docker - recommended approach](#docker-recommended-approach) - - [Deprecated - emulate the virtual display](#deprecated-emulate-the-virtual-display) + - [Off-screen Vs no-rendering](#off-screen-vs-no-rendering) + - [Setting off-screen mode (Version 0.9.12+)](#setting-off-screen-mode-version-0912) + - [Setting off-screen mode (Versions prior to 0.9.12)](#setting-off-screen-mode-versions-prior-to-0912) !!! Important @@ -84,7 +83,7 @@ cd PythonAPI/examples && python3 no_rendering_mode.py --- ## Off-screen mode -Starting from version 0.9.12, CARLA runs on Unreal Engine 4.26 which introduced support for off-screen rendering. In previous versions of CARLA, off-screen rendering depended upon the graphics API you were using. If you are using a previous version of CARLA, please select the corresponding documentation version in the lower right corner of the screen for more information. +Starting from version 0.9.12, CARLA runs on Unreal Engine 4.26 which introduced support for off-screen rendering. In previous versions of CARLA, off-screen rendering depended upon the graphics API you were using. ### Off-screen vs no-rendering @@ -93,7 +92,7 @@ It is important to understand the distinction between __no-rendering mode__ and - __No-rendering mode:__ Unreal Engine does not render anything. Graphics are not computed. GPU based sensors return empty data. - __Off-screen mode:__ Unreal Engine is working as usual, rendering is computed but there is no display available. GPU based sensors return data. -### Setting off-screen mode +### Setting off-screen mode (Version 0.9.12+) To start CARLA in off-screen mode, run the following command: @@ -101,6 +100,8 @@ To start CARLA in off-screen mode, run the following command: ./CarlaUE4.sh -RenderOffScreen ``` +### Setting off-screen mode (Versions prior to 0.9.12) + Using off-screen mode differs if you are using either OpenGL or Vulkan. __Using OpenGL__, you can run in off-screen mode in Linux by running the following command: diff --git a/Docs/build_docker.md b/Docs/build_docker.md index dd456bfb3..c70f2a4be 100644 --- a/Docs/build_docker.md +++ b/Docs/build_docker.md @@ -40,7 +40,27 @@ docker pull carlasim/carla:0.9.11 __2. Run the CARLA container.__ -Starting from version 0.9.9, CARLA supports the Vulkan graphics API as well as OpenGL and from 0.9.11, CARLA runs with Vulkan by default. This means if you want to run 0.9.11 with the OpenGL API, you will need to specify certain flags when you run the container. +Different versions of CARLA support different graphics APIs which can affect the conditions in which the Docker image can run: + +- 0.9.12 supports only Vulkan +- 0.9.7+ supports both Vulkan and OpenGL. + + +__CARLA 0.9.12__ + +To run CARLA with a display: + +``` +sudo docker run --privileged --gpus all --net=host -e DISPLAY=$DISPLAY carlasim/carla:0.9.12 /bin/bash ./CarlaUE4.sh +``` + +To run CARLA in off-screen mode: + +``` +sudo docker run --privileged --gpus all --net=host -v /tmp/.X11-unix:/tmp/.X11-unix:rw carlasim/carla:0.9.12 /bin/bash ./CarlaUE4.sh -RenderOffScreen +``` + +__CARLA 0.9.7 to 0.9.11__ To run CARLA using Vulkan: @@ -68,7 +88,7 @@ The above commands use some Docker flags that can be configured according to you ## Off-screen mode -OpenGL requires no configuration if you are running CARLA on a machine without a display, however you will need to perform some extra steps to do the same using Vulkan. See the [rendering documentation](adv_rendering_options.md#off-screen-mode) for information. +OpenGL requires no configuration if you are running CARLA on a machine without a display, however you will need to perform some extra steps to do the same using Vulkan prior to CARLA 0.9.12. See the [rendering documentation](adv_rendering_options.md#off-screen-mode) for information. ---