Add defaultGraphicsAPI utility function

Signed-off-by: Ian Chen <ichen@openrobotics.org>
gazebosim · Oct 31, 2023 · 522e36c · 522e36c
1 parent 5e23aaf
commit 522e36c
Show file tree

Hide file tree

Showing 24 changed files with 41 additions and 111 deletions.
diff --git a/examples/actor_animation/Main.cc b/examples/actor_animation/Main.cc
@@ -188,11 +188,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/boundingbox_camera/Main.cc b/examples/boundingbox_camera/Main.cc
@@ -272,11 +272,7 @@ int main(int _argc, char** _argv)
     }
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/camera_tracking/Main.cc b/examples/camera_tracking/Main.cc
@@ -127,11 +127,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/custom_scene_viewer/ManualSceneDemo.cc b/examples/custom_scene_viewer/ManualSceneDemo.cc
@@ -192,11 +192,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/custom_shaders_uniforms/Main.cc b/examples/custom_shaders_uniforms/Main.cc
@@ -167,11 +167,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/depth_camera/Main.cc b/examples/depth_camera/Main.cc
@@ -154,11 +154,7 @@ int main(int _argc, char** _argv)
     engineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/heightmap/Main.cc b/examples/heightmap/Main.cc
@@ -324,11 +324,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2 && buildDemScene != 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/lidar_visual/Main.cc b/examples/lidar_visual/Main.cc
@@ -272,11 +272,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/mesh_viewer/Main.cc b/examples/mesh_viewer/Main.cc
@@ -142,11 +142,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/mouse_picking/Main.cc b/examples/mouse_picking/Main.cc
@@ -135,11 +135,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/ogre2_demo/Main.cc b/examples/ogre2_demo/Main.cc
@@ -317,11 +317,7 @@ int main(int _argc, char** _argv)
   std::vector<std::string> engineNames;
   std::vector<CameraPtr> cameras;
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/particles_demo/Main.cc b/examples/particles_demo/Main.cc
@@ -168,11 +168,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/projector/Main.cc b/examples/projector/Main.cc
@@ -180,11 +180,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/render_pass/Main.cc b/examples/render_pass/Main.cc
@@ -198,11 +198,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/segmentation_camera/Main.cc b/examples/segmentation_camera/Main.cc
@@ -150,11 +150,7 @@ int main(int _argc, char** _argv)
     engineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/simple_demo/Main.cc b/examples/simple_demo/Main.cc
@@ -218,11 +218,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/thermal_camera/Main.cc b/examples/thermal_camera/Main.cc
@@ -138,11 +138,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/transform_control/Main.cc b/examples/transform_control/Main.cc
@@ -121,11 +121,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/view_control/Main.cc b/examples/view_control/Main.cc
@@ -167,11 +167,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/visualization_demo/Main.cc b/examples/visualization_demo/Main.cc
@@ -248,11 +248,7 @@ int main(int _argc, char** _argv)
     engine = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/waves/Main.cc b/examples/waves/Main.cc
@@ -164,11 +164,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/examples/wide_angle_camera/Main.cc b/examples/wide_angle_camera/Main.cc
@@ -169,11 +169,7 @@ int main(int _argc, char** _argv)
     ogreEngineName = _argv[1];
   }
 
-#ifdef __APPLE__
-  GraphicsAPI graphicsApi = GraphicsAPI::METAL;
-#else
-  GraphicsAPI graphicsApi = GraphicsAPI::OPENGL;
-#endif
+  GraphicsAPI graphicsApi = defaultGraphicsAPI();
   if (_argc > 2)
   {
     graphicsApi = GraphicsAPIUtils::Set(std::string(_argv[2]));

diff --git a/include/gz/rendering/Utils.hh b/include/gz/rendering/Utils.hh
@@ -29,6 +29,7 @@
 #include "gz/rendering/Camera.hh"
 #include "gz/rendering/config.hh"
 #include "gz/rendering/Export.hh"
+#include "gz/rendering/GraphicsAPI.hh"
 #include "gz/rendering/RayQuery.hh"
 #include "gz/rendering/Image.hh"
 
@@ -120,6 +121,12 @@ namespace gz
     /// \return Image in bayer format
     GZ_RENDERING_VISIBLE
     Image convertRGBToBayer(const Image &_image, PixelFormat _bayerFormat);
+
+    /// \brief Convenience function to get the default graphics API based on
+    /// current platform
+    /// \return Graphics API, i.e. METAL, OPENGL, VULKAN
+    GZ_RENDERING_VISIBLE
+    GraphicsAPI defaultGraphicsAPI();
     }
   }
 }

diff --git a/src/Utils.cc b/src/Utils.cc
@@ -25,8 +25,9 @@
 #include "gz/math/Vector3.hh"
 
 #include "gz/rendering/Camera.hh"
-#include "gz/rendering/RayQuery.hh"
+#include "gz/rendering/GraphicsAPI.hh"
 #include "gz/rendering/PixelFormat.hh"
+#include "gz/rendering/RayQuery.hh"
 #include "gz/rendering/Utils.hh"
 
 
@@ -393,6 +394,16 @@ Image convertRGBToBayer(const Image &_image, PixelFormat _bayerFormat)
   return destImage;
 }
 
+/////////////////////////////////////////////////
+GraphicsAPI defaultGraphicsAPI()
+{
+#ifdef __APPLE__
+  return GraphicsAPI::METAL;
+#else
+  return GraphicsAPI::OPENGL;
+#endif
+}
+
 }
 }
 }