From Ogre 2.1 to Ogre 2.2

.github/ci/packages.apt

@@ -6,7 +6,7 @@ libignition-common4-dev
 libignition-math6-dev
 libignition-plugin-dev
 libogre-1.9-dev
-libogre-2.1-dev
+libogre-2.2-dev
 libxi-dev
 libxmu-dev
 uuid-dev

CMakeLists.txt

@@ -80,7 +80,7 @@ endif()
 
 #--------------------------------------
 # Find OGRE2
-ign_find_package(IgnOGRE2 VERSION 2.1.0
+ign_find_package(IgnOGRE2 VERSION 2.2.0
     COMPONENTS HlmsPbs HlmsUnlit Overlay
     REQUIRED_BY ogre2
     PRIVATE_FOR ogre2)

include/ignition/rendering/Camera.hh

@@ -333,6 +333,10 @@ namespace ignition
       /// \return Render pass at the specified index
       public: virtual RenderPassPtr RenderPassByIndex(unsigned int _index)
           const = 0;
+
+      /// \internal
+      /// \brief Notify that shadows are dirty and need to be regenerated
+      public: virtual void SetShadowsDirty() = 0;
     };
     }
   }

include/ignition/rendering/RenderEngine.hh

@@ -163,6 +163,15 @@ namespace ignition
       public: virtual ScenePtr CreateScene(unsigned int _id,
                   const std::string &_name) = 0;
 
+      /// \brief Set headless mode
+      /// Only available in OGRE 2.2, which makes use of EGL
+      /// \param[in] _headless Set to true to enable headless mode.
+      public: virtual void SetHeadless(bool _headless) = 0;
+
+      /// \brief Get headless mode
+      /// \return True if headless mode is enable, false otherwise.
+      public: virtual bool Headless() const = 0;
+
       /// \brief Add path to media resource location
       /// \param[in] _paths Absolute path to resource location
       public: virtual void AddResourcePath(const std::string &_path) = 0;

include/ignition/rendering/base/BaseCamera.hh

@@ -193,6 +193,9 @@ namespace ignition
       public: virtual RenderPassPtr RenderPassByIndex(unsigned int _index)
           const override;
 
+      // Documentation inherited.
+      public: virtual void SetShadowsDirty() override;
+
       protected: virtual void *CreateImageBuffer() const;
 
       protected: virtual void Load() override;
@@ -828,6 +831,13 @@ namespace ignition
     {
       return this->RenderTarget()->RenderPassByIndex(_index);
     }
+
+    //////////////////////////////////////////////////
+    template <class T>
+    void BaseCamera<T>::SetShadowsDirty()
+    {
+      // no op
+    }
     }
   }
 }

include/ignition/rendering/base/BaseRenderEngine.hh

@@ -88,6 +88,12 @@ namespace ignition
       // Documentation Inherited
       public: virtual void AddResourcePath(const std::string &_path) override;
 
+      // Documentation Inherited
+      public: virtual void SetHeadless(bool _headless) override;
+
+      // Documentation Inherited
+      public: virtual bool Headless() const override;
+
       // Documentation Inherited
       public: virtual RenderPassSystemPtr RenderPassSystem() const override;
 
@@ -111,6 +117,8 @@ namespace ignition
 
       protected: bool initialized = false;
 
+      protected: bool isHeadless = false;
+
       protected: unsigned int nextSceneId;
 
       IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING

ogre2/include/ignition/rendering/ogre2/Ogre2Camera.hh

@@ -21,6 +21,7 @@
 
 #include "ignition/rendering/base/BaseCamera.hh"
 #include "ignition/rendering/ogre2/Ogre2RenderTypes.hh"
+#include "ignition/rendering/ogre2/Ogre2Includes.hh"
 #include "ignition/rendering/ogre2/Ogre2Sensor.hh"
 
 namespace Ogre
@@ -114,11 +115,7 @@ namespace ignition
       public: virtual unsigned int RenderTextureGLId() const override;
 
       // Documentation inherited.
-      // TODO(anyone): this function should be virtual, declared in 'Camera'
-      // and 'BaseCamera'. We didn't do it to preserve ABI.
-      // Looks in commit history for '#SetShadowsNodeDefDirtyABI' to
-      // see changes made and revert
-      public: void SetShadowsNodeDefDirty();
+      public: void SetShadowsDirty() override;
 
       // Documentation inherited.
       public: virtual void Destroy() override;
@@ -144,6 +141,13 @@ namespace ignition
       /// \brief Create internal camera object
       private: void CreateCamera();
 
+      /// \brief Notifies us that the shadow node definition is about to be
+      /// updated. This means our compositor workspace must be destroyed
+      /// because the shadow node definition it's using will become a
+      /// dangling pointer otherwise
+      /// \sa SetShadowsDirty
+      private: void SetShadowsNodeDefDirty();
+
       /// \brief Pointer to ogre camera object
       protected: Ogre::Camera *ogreCamera = nullptr;
 

ogre2/include/ignition/rendering/ogre2/Ogre2Conversions.hh

@@ -32,7 +32,7 @@
 
 #include <OgreColourValue.h>
 #include <OgreVector3.h>
-#include <OgrePixelFormat.h>
+#include <OgrePixelFormatGpu.h>
 
 #ifdef _MSC_VER
   #pragma warning(pop)
@@ -107,10 +107,10 @@ namespace ignition
       /// \brief Ign-rendering PixelFormat to Ogre PixelFormat
       /// \param[in] _v Ign-rendering PixelFormat
       /// return Ogre PixelFormat
-      public: static Ogre::PixelFormat Convert(PixelFormat _format);
+      public: static Ogre::PixelFormatGpu Convert(PixelFormat _format);
 
       /// \brief A list of ogre pixel formats
-      private: static const Ogre::PixelFormat ogrePixelFormats[PF_COUNT];
+      private: static const Ogre::PixelFormatGpu ogrePixelFormats[PF_COUNT];
     };
     /// \}
     }

ogre2/include/ignition/rendering/ogre2/Ogre2DepthCamera.hh

@@ -123,26 +123,7 @@ namespace ignition
       public: double FarClipPlane() const override;
 
       // Documentation inherited.
-      // TODO(anyone): this function should be virtual, declared in 'Camera'
-      // and 'BaseCamera'. We didn't do it to preserve ABI.
-      // Looks in commit history for '#SetShadowsNodeDefDirtyABI' to
-      // see changes made and revert
-      public: void SetShadowsNodeDefDirty();
-
-      // TODO(anyone): This fixes the pass quad material leaving dangling
-      // pointers when we remove the workspace, so we have to cleanup the
-      // material first.
-      // This bug was fixed in Ogre 2.2 thus the workaround should not be
-      // necessary there
-      //
-      // See https://github.com/ignitionrobotics/ign-rendering/
-      // pull/303#pullrequestreview-635228897
-      // Repro:
-      //  1.run the sensors_demo.sdf world: ign gazebo -v 4 -r sensors_demo.sdf
-      //  2.open Lights plugin, top right menu (3 dots) and select Lights
-      //  3.insert a spot light into the scene (needs to be spot light)
-      //  4.ign gazebo crashes
-      private: void RemoveWorkspaceCrashWorkaround();
+      public: void SetShadowsDirty() override;
 
       // Documentation inherited.
       public: void AddRenderPass(const RenderPassPtr &_pass) override;
@@ -160,6 +141,13 @@ namespace ignition
       /// \brief Create the camera.
       protected: void CreateCamera();
 
+      /// \brief Notifies us that the shadow node definition is about to be
+      /// updated. This means our compositor workspace must be destroyed
+      /// because the shadow node definition it's using will become a
+      /// dangling pointer otherwise
+      /// \sa SetShadowsDirty
+      private: void SetShadowsNodeDefDirty();
+
       /// \brief Pointer to the ogre camera
       protected: Ogre::Camera *ogreCamera;
 

ogre2/include/ignition/rendering/ogre2/Ogre2Includes.hh

@@ -27,54 +27,62 @@
 // This prevents some deprecation #warning messages on OSX 10.9
 #pragma clang diagnostic ignored "-W#warnings"
 
+#include <memory>
+
 #include <Ogre.h>
 #include <OgreBillboard.h>
-#include <OgreImageCodec.h>
-#include <OgreMovableObject.h>
-#include <OgreRenderable.h>
-#include <OgreRenderWindow.h>
-#include <OgrePlugin.h>
+#include <OgreCamera.h>
+#include <OgreColourValue.h>
 #include <OgreDataStream.h>
-#include <OgreLogManager.h>
-#include <OgreWindowEventUtilities.h>
-#include <OgreSceneQuery.h>
-#include <OgreRoot.h>
+#include <OgreDepthBuffer.h>
+#include <OgreFrameListener.h>
+#include <OgreGpuProgramManager.h>
+#include <OgreHardwareBufferManager.h>
+#include <OgreHighLevelGpuProgramManager.h>
 #include <OgreItem.h>
-#include <OgreSceneManager.h>
-#include <OgreSceneNode.h>
-#include <OgreVector3.h>
+#include <OgreImage2.h>
+#include <OgreLogManager.h>
 #include <OgreManualObject.h>
 #include <OgreMaterialManager.h>
 #include <OgreMatrix4.h>
-#include <OgreColourValue.h>
-#include <OgreQuaternion.h>
 #include <OgreMesh2.h>
-#include <OgreSubMesh2.h>
 #include <OgreMeshManager2.h>
-#include <OgreHardwareBufferManager.h>
-#include <OgreCamera.h>
+#include <OgreMovableObject.h>
 #include <OgreNode.h>
-#include <OgreSimpleRenderable.h>
-#include <OgreFrameListener.h>
-#include <OgreTexture.h>
+#include <OgreOldSkeletonManager.h>
+#include <OgreParticleEmitter.h>
+#include <OgreParticleSystem.h>
+#include <OgrePass.h>
+#include <OgrePixelFormatGpuUtils.h>
+#include <OgrePlugin.h>
+#include <OgreQuaternion.h>
 #include <OgreRectangle2D.h>
 #include <OgreRenderObjectListener.h>
+#include <OgreRenderable.h>
+#include <OgreRoot.h>
+#include <OgreSceneManager.h>
+#include <OgreSceneNode.h>
+#include <OgreSceneQuery.h>
+#include <OgreShadowCameraSetupPSSM.h>
+#include <OgreSimpleRenderable.h>
+#include <OgreStagingTexture.h>
+#include <OgreSubMesh2.h>
 #include <OgreTechnique.h>
-#include <OgrePass.h>
-#include <OgreOldSkeletonManager.h>
+#include <OgreTextureGpu.h>
+#include <OgreTextureGpuManager.h>
 #include <OgreTextureUnitState.h>
 #include <OgreGpuProgramManager.h>
 #include <OgreHighLevelGpuProgramManager.h>
-#include <OgreHardwarePixelBuffer.h>
 #include <OgreShadowCameraSetupPSSM.h>
 #include <OgreDepthBuffer.h>
 #include <OgreParticleAffector.h>
 #include <OgreParticleAffectorFactory.h>
 #include <OgreParticleEmitter.h>
 #include <OgreParticleSystem.h>
+#include <OgreVector3.h>
+#include <OgreWindow.h>
+#include <OgreWindowEventUtilities.h>
 
-#include <OgreHlmsManager.h>
-#include <OgreHlmsTextureManager.h>
 #include <Hlms/Unlit/OgreHlmsUnlit.h>
 #include <Hlms/Pbs/OgreHlmsPbs.h>
 
@@ -84,7 +92,6 @@
 #include <Compositor/OgreCompositorShadowNode.h>
 #include <Compositor/OgreCompositorWorkspace.h>
 #include <Compositor/OgreCompositorWorkspaceListener.h>
-#include <Compositor/Pass/PassClear/OgreCompositorPassClearDef.h>
 #include <Compositor/Pass/PassQuad/OgreCompositorPassQuadDef.h>
 #include <Compositor/Pass/PassScene/OgreCompositorPassScene.h>
 #include <Compositor/Pass/PassScene/OgreCompositorPassSceneDef.h>

ogre2/include/ignition/rendering/ogre2/Ogre2Material.hh

@@ -246,7 +246,7 @@ namespace ignition
 
       /// \brief Get a pointer to the ogre texture by name
       /// \return Ogre texture
-      protected: virtual Ogre::TexturePtr Texture(const std::string &_name);
+      protected: virtual Ogre::TextureGpu *Texture(const std::string &_name);
 
       /// \brief Updates the material transparency in the engine,
       /// based on transparency and diffuse alpha values

ogre2/include/ignition/rendering/ogre2/Ogre2MaterialSwitcher.hh

@@ -29,8 +29,8 @@
 #ifdef _MSC_VER
   #pragma warning(push, 0)
 #endif
+#include <OgreCamera.h>
 #include <OgreMaterial.h>
-#include <OgreRenderTargetListener.h>
 #ifdef _MSC_VER
   #pragma warning(pop)
 #endif
@@ -46,7 +46,7 @@ namespace ignition
 
     /// \brief Helper class to assign unique colors to renderables
     class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2MaterialSwitcher :
-      public Ogre::RenderTargetListener
+      public Ogre::Camera::Listener
     {
       /// \brief Constructor
       public: explicit Ogre2MaterialSwitcher(Ogre2ScenePtr _scene);
@@ -65,14 +65,14 @@ namespace ignition
       /// \brief Ogre's pre render update callback
       /// \param[in] _evt Ogre render target event containing information about
       /// the source render target.
-      public: virtual void preRenderTargetUpdate(
-                  const Ogre::RenderTargetEvent &_evt);
+      public: virtual void cameraPreRenderScene(
+                  Ogre::Camera *_cam) override;
 
       /// \brief Ogre's post render update callback
       /// \param[in] _evt Ogre render target event containing information about
       /// the source render target.
-      public: virtual void postRenderTargetUpdate(
-                  const Ogre::RenderTargetEvent &_evt);
+      public: virtual void cameraPostRenderScene (
+                  Ogre::Camera * _cam) override;
 
       /// \brief Current unique color value
       private: ignition::math::Color currentColor;

ogre2/include/ignition/rendering/ogre2/Ogre2RenderEngine.hh

@@ -34,6 +34,7 @@ namespace Ogre
 {
   class LogManager;
   class Root;
+  class Window;
   namespace v1
   {
     class OverlaySystem;
@@ -94,6 +95,9 @@ namespace ignition
       /// \param[in] _uri Resource path in the form of an uri
       public: void AddResourcePath(const std::string &_uri) override;
 
+      /// \brief return the ogre window
+      public: Ogre::Window * OgreWindow() const;
+
       /// \brief Get the ogre2 root object
       /// \return ogre2 root object
       public: virtual Ogre::Root *OgreRoot() const;
@@ -138,6 +142,9 @@ namespace ignition
       /// \brief Create GL context
       private: void CreateContext();
 
+      /// \brief Register Hlms
+      private: void RegisterHlms();
+
       /// \brief Create ogre root
       private: void CreateRoot();
 
@@ -192,6 +199,9 @@ namespace ignition
       /// \brief Dummy window Id needed for linux platform
       private: uint64_t dummyWindowId = 0u;
 
+      /// \brief Ogre Window
+      private: Ogre::Window *window = nullptr;
+
       /// \brief True to use the current opengl context
       private: bool useCurrentGLContext = false;