These instructions are for installing only Ignition Rendering. If you're interested in using all the Ignition libraries, check out this Ignition installation.
We recommend following the Binary Install instructions to get up and running as quickly and painlessly as possible.
The Source Install instructions should be used if you need the very latest software improvements, you need to modify the code, or you plan to make a contribution.
Setup your computer to accept software from packages.osrfoundation.org:
Be sure to replace
<#> with a number value, such as
2, depending on which version you need.
Ubuntu Bionic 18.04 or above:
Supported Rendering Engines
Ignition Rendering will look for rendering libraries installed in the system and build the relevant plugins if dependencies are found.
OGRE 2.x (supported in Versions >= ign-rendering1)
Add OSRF packages if you have not done so already:
Install OGRE 2.1 debs
Download and install by following instructions on NVIDIA website
LD_LIBRARY_PATH and add an
OPTIX_INSTALL_DIR environment variables so that ign-rendering can find Optix, e.g. if you installed version 4.0.2 in HOME/optix:
Note: If you encounter errors about different exception specifiers in optix math when building Ign Rendering OptiX plugin, edit
[optix_install_dir]/include/optixu/optixu_math_namespace.h and comment out the section that defines
fminf, fmaxf, and
copysignf (for optix sdk 4.0.2, comment out lines 167-206).
Build from Source
- Clone the repository # Optionally, append `-b ign-rendering#` (replace # with a number) to check out a specific versiongit clone http://github.com/ignitionrobotics/ign-rendering
- Configure and build Replacecd ign-renderingmkdir buildcd buildcmake .. -DCMAKE_INSTALL_PREFIX=/path/to/install/dirmake
/path/to/install/dirto whatever directory you want to install this package to
- Optionally, install make install
On Windows, only OGRE 1 is currently supported.
First, follow the ign-cmake tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.
condabin if necessary to use the
conda command (i.e., if Conda is not in your
PATH environment variable. You can find the location of
condabin in Anaconda Prompt,
Create if necessary, and activate a Conda environment:
libignition-rendering<#> Conda feedstock is not yet available, pending conda-forge/staged-recipes#13551.
This assumes you have created and activated a Conda environment while installing the Prerequisites.
- Install dependencies: conda install ogre --channel conda-forge
Install Ignition dependencies:
You can view available versions and their dependencies:conda search libignition-rendering* --channel conda-forge --info
Install dependencies, replacing
<#>with the desired versions:conda install libignition-cmake<#> libignition-common<#> libignition-math<#> libignition-plugin<#> --channel conda-forge
- Navigate to where you would like to build the library, and clone the repository. # Optionally, append `-b ign-rendering#` (replace # with a number) to check out a specific versiongit clone https://github.com/ignitionrobotics/ign-rendering.git
- Configure and build cd ign-renderingmkdir buildcd buildcmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\installcmake --build . --config Release
- Optionally, install cmake --install . --config Release
API documentation can be generated using Doxygen
Tests can be run by building the
To run tests specific to a render engine, set the
RENDER_ENGINE_VALUES environment variable, e.g.