Skip to content

Commit 7d341d6

Browse files
authored
Update references of main to gz-rendering10 (#1160)
Signed-off-by: Ian Chen <[email protected]>
1 parent aae5297 commit 7d341d6

File tree

4 files changed

+17
-16
lines changed

4 files changed

+17
-16
lines changed

.github/workflows/bazel.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
name: Bazel CI
22
on:
3-
push:
4-
branches: [gz-rendering9, main]
53
pull_request:
6-
branches: [gz-rendering9, main]
4+
push:
5+
branches:
6+
- 'gz-rendering[1-9]?[0-9]'
7+
- 'main'
78

89
concurrency:
910
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99

1010
Build | Status
1111
-- | --
12-
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-rendering/tree/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-rendering/tree/main)
13-
Ubuntu Noble | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-ci-main-noble-amd64)](https://build.osrfoundation.org/job/gz_rendering-ci-main-noble-amd64)
14-
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/gz_rendering-ci-main-homebrew-amd64)
15-
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-main-clowin)](https://build.osrfoundation.org/job/gz_rendering-main-clowin)
12+
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-rendering/tree/gz-rendering10/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-rendering/tree/gz-rendering10)
13+
Ubuntu Noble | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-ci-gz-rendering10-noble-amd64)](https://build.osrfoundation.org/job/gz_rendering-ci-gz-rendering10-noble-amd64)
14+
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-ci-gz-rendering10-homebrew-amd64)](https://build.osrfoundation.org/job/gz_rendering-ci-gz-rendering10-homebrew-amd64)
15+
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_rendering-10-cnlwin)](https://build.osrfoundation.org/job/gz_rendering-10-cnlwin)
1616

1717
Gazebo Rendering is a C++ library designed to provide an abstraction
1818
for different rendering engines. It offers unified APIs for creating
@@ -47,12 +47,12 @@ of libraries designed to rapidly develop robot applications.
4747

4848
# Install
4949

50-
See the [installation tutorial](https://gazebosim.org/api/rendering/9/installation.html).
50+
See the [installation tutorial](https://gazebosim.org/api/rendering/10/installation.html).
5151

5252
# Usage
5353

5454
The Gazebo Rendering API can be found in the documentation. See the
55-
[installation tutorial](https://gazebosim.org/api/rendering/9/installation.html)
55+
[installation tutorial](https://gazebosim.org/api/rendering/10/installation.html)
5656
on how to build the documentation files using Doxygen.
5757

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

tutorials/03_rendering_plugins.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ It is also possible to integrate your own selected rendering engine by writing a
1111

1212
### How to Write Your Own Rendering Engine Plugin
1313

14-
A mocked example of a custom rendering engine plugin can be found [here](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin). In order
14+
A mocked example of a custom rendering engine plugin can be found [here](https://github.com/gazebosim/gz-rendering/tree/gz-rendering10/examples/hello_world_plugin). In order
1515
to make your own custom rendering engine, this example is a good starting point. There are a few key things which will need to be done in order for a custom rendering engine to function:
1616

17-
* A singleton Render Engine class which implements the pure virtual functions in [`gz::rendering::BaseRenderEngine`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/base/BaseRenderEngine.hh).
18-
* A plugin class which implements the pure virtual functions in [`gz::rendering::RenderEnginePlugin`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/RenderEnginePlugin.hh)
19-
* Registering the plugin, this line can be seen at the bottom of the [`HelloWorldPlugin`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin/HelloWorldPlugin.cc) example
17+
* A singleton Render Engine class which implements the pure virtual functions in [`gz::rendering::BaseRenderEngine`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/include/gz/rendering/base/BaseRenderEngine.hh).
18+
* A plugin class which implements the pure virtual functions in [`gz::rendering::RenderEnginePlugin`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/include/gz/rendering/RenderEnginePlugin.hh)
19+
* Registering the plugin, this line can be seen at the bottom of the [`HelloWorldPlugin`](https://github.com/gazebosim/gz-rendering/tree/gz-rendering10/examples/hello_world_plugin/HelloWorldPlugin.cc) example
2020

21-
Finally, for your custom rendering engine to actually have any functionality and at minimum, display something in a window, you will need to implement your own `Scene` and `Camera` classes, which inherit from and implement the pure virtual functions of [`gz::rendering::Scene`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Scene.hh) and [`gz::rendering::Camera`](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/Camera.hh), respectively. The mocked example simply returns `nullptr` for its `CreateSceneImpl(...)` function, so it may be useful to look at the current `Scene` implementations for the other rendering engines within `gz::rendering` such as [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreScene.cc) or [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Scene.cc). Likewise, it may be helpful to look at the `Camera` implementations from [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/main/ogre/src/OgreCamera.cc) and [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/main/ogre2/src/Ogre2Camera.cc)
21+
Finally, for your custom rendering engine to actually have any functionality and at minimum, display something in a window, you will need to implement your own `Scene` and `Camera` classes, which inherit from and implement the pure virtual functions of [`gz::rendering::Scene`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/include/gz/rendering/Scene.hh) and [`gz::rendering::Camera`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/include/gz/rendering/Camera.hh), respectively. The mocked example simply returns `nullptr` for its `CreateSceneImpl(...)` function, so it may be useful to look at the current `Scene` implementations for the other rendering engines within `gz::rendering` such as [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/ogre/src/OgreScene.cc) or [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/ogre2/src/Ogre2Scene.cc). Likewise, it may be helpful to look at the `Camera` implementations from [`OGRE`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/ogre/src/OgreCamera.cc) and [`OGRE2`](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/ogre2/src/Ogre2Camera.cc)
2222

2323
### Building and Running Your Rendering Engine Plugin with Gazebo
2424

25-
Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/main/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built.
25+
Once you have your own rendering plugin written, you can build it similarly to how the example is built. It may be helpful to look at the [`CMakeLists.txt`](https://github.com/gazebosim/gz-rendering/tree/gz-rendering10/examples/hello_world_plugin) from the example as it contains the boilerplate code needed to get a custom rendering engine plugin built.
2626

2727
After you have your plugin built, you will need to set the `GZ_SIM_RENDER_ENGINE_PATH` environment variable to the path in which your built shared library resides. Note that you will need to do this for every command line instance unless you add the line to your startup shell script (`.bashrc`, `.zshrc`, etc.).
2828

tutorials/23_depth_camera_tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ depth camera to a memory reserved in a globally scoped `Image`.
8282

8383
\snippet examples/depth_camera/GlutWindow.cc convert depth to image
8484

85-
The other option is the [ConnectNewRgbPointCloud](https://github.com/gazebosim/gz-rendering/blob/main/include/gz/rendering/DepthCamera.hh#L58) call that receives colored point cloud data on callback.
85+
The other option is the [ConnectNewRgbPointCloud](https://github.com/gazebosim/gz-rendering/blob/gz-rendering10/include/gz/rendering/DepthCamera.hh#L58) call that receives colored point cloud data on callback.
8686

8787
The reason for setting the camera image format to `PixelFormat::PF_FLOAT32_RGBA`
8888
is to ensure that when the `Image` is created it reserves a buffer of the

0 commit comments

Comments
 (0)