crola1702 / gz-rendering-backport Goto Github PK

View Code? Open in Web Editor NEW

C++ library designed to provide an abstraction for different rendering engines. It offers unified APIs for creating 3D graphics applications.

License: Other

C++ 89.33% Python 0.01% C 0.27% Cuda 0.61% CMake 0.66% GLSL 5.98% Metal 2.35% HLSL 0.75% NASL 0.05%

gz-rendering-backport's Introduction

Gazebo Rendering: Rendering library for robot applications

Maintainer: ichen [AT] openrobotics [DOT] org

Build	Status
Test coverage
Ubuntu Focal
Homebrew
Windows

Gazebo Rendering is a C++ library designed to provide an abstraction for different rendering engines. It offers unified APIs for creating 3D graphics applications.

Gazebo Rendering is a component in the Gazebo framework, a set of libraries designed to rapidly develop robot applications.

Features

Support for rendering engines including OGRE and OptiX (experimental)
Plugin-based architecture. Multiple rendering engine plugins can be loaded at run time.
Object-oriented scene management.

Install

See the installation tutorial.

Usage

The Gazebo Rendering API can be found in the documentation. See the installation tutorial on how to build the documentation files using Doxygen.

You can also take a look at the sample applications in the examples folder.

Folder Structure

include/ignition/rendering: Contains all the public header files which will be installed
src: Contains all the C++ source code which are not installed.
test: All integration, performance and regression tests go here, under their specific folders.
examples: Sample programs to demonstrate different features of ign-rendering
doc: Files used by Doxygen when generating documentation.

Rendering engine plugin implementation code is stored in their own folders

ogre : OGRE 1.x rendering engine plugin
ogre2 : OGRE 2.x rendering engine plugin (available in versions >= ign-rendering1)
optix : OptiX rendering engine plugin

Contributing

Please see CONTRIBUTING.md.

Code of Conduct

Please see CODE_OF_CONDUCT.md.

Versioning

This library uses Semantic Versioning. Additionally, this library is part of the Gazebo project which periodically releases a versioned set of compatible and complimentary libraries. See the Gazebo website for version and release information.