Renderbackend: Rework Canvas 2D-Rendering

.github/workflows/cmake.yml

@@ -26,7 +26,7 @@ jobs:
       run: |
         sudo add-apt-repository -y "deb http://archive.ubuntu.com/ubuntu `lsb_release -sc` main universe restricted multiverse"
         sudo apt-get update -y -qq
-        sudo apt-get install libsdl2-dev libglm-dev libglew-dev libgtest-dev
+        sudo apt-get install libsdl2-dev libglm-dev libglew-dev libgtest-dev googletest
 
     - name: Configure CMake
       # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.

samples/02_Demo2D/Demo2D.cpp

@@ -45,7 +45,7 @@ static constexpr c8 Tag[] = "ModelLoadingApp";
 //-------------------------------------------------------------------------------------------------
 class Demo2DApp : public App::AppBase {
     TransformMatrixBlock  mTransformMatrix;
-    CanvasRenderer       *mCanvasRenderer;
+    CanvasRenderer *mCanvasRenderer;
 
 public:
     Demo2DApp(int argc, char *argv[]) :
@@ -66,7 +66,7 @@ class Demo2DApp : public App::AppBase {
 
 protected:
     bool onCreate() override {
-        Properties::Settings *baseSettings(AppBase::getSettings());
+        Properties::Settings *baseSettings  = AppBase::getSettings();
         if (baseSettings == nullptr) {
             return false;
         }
@@ -75,8 +75,9 @@ class Demo2DApp : public App::AppBase {
         if (!AppBase::onCreate()) {
             return false;
         }
-
-        mCanvasRenderer = new CanvasRenderer(2, 0, 0, 1024, 768);
+
+        mCanvasRenderer = AppBase::getCanvasRenderer();
+
         mCanvasRenderer->selectLayer(0);
         const Color4 Red(1, 0, 0, 0);
         mCanvasRenderer->setColor(Red);
@@ -109,6 +110,8 @@ class Demo2DApp : public App::AppBase {
 
         mCanvasRenderer->drawRect(100, 1000, 110, 124, true);
 
+        mCanvasRenderer->drawText(300, 100, "Test");
+
         return true;
     }
 

src/Editor/src/Gui/UIElementsWin32.cpp

@@ -40,7 +40,10 @@ bool UIElementsWin32::init() {
 
     // needed for the RichEdit control in the about/help dialog
     lib = LoadLibrary("riched20.dll");
-    osre_assert(lib != nullptr);
+    if (lib == nullptr) {
+        osre_assert(lib != nullptr);
+        return false;
+    }
 
     // load windows common controls library to get XP style
     InitCommonControls();

src/Editor/src/main.cpp

@@ -54,10 +54,11 @@ int main(int argc, char *argv[]) {
     std::cout << "Editor version 0.1\n";
 
     OsreEdApp osreApp(argc, argv);
-    if (!osreApp.initWindow(100, 100, 1024, 768, "OSRE-Ed", 
-            WindowMode::Windowed, 
-            WindowType::Child, 
+    if (!osreApp.initWindow(100, 100, 1024, 768, "OSRE-Ed",
+            WindowMode::Windowed,
+            WindowType::Child,
             RenderBackendType::OpenGLRenderBackend)) {
+        osre_error(Tag, "Cannot open the window.");
         return AppError;
     }
 

src/Engine/Animation/AnimatorBase.h

@@ -117,10 +117,11 @@ using VectorChannelArray = ::cppcore::TArray<VectorChannel>;
 template <class T>
 struct AnimatorBase {
     void operator () ( T &out, const T &a, const T &b, f32 d ) const {
-        out = a + ( b - a ) * d;
+        out = a + (b - a) * d;
     }
 };
 
+/// @brief 
 enum class TransformCommandType {
     Invalid = -1,
     RotateXCommandPositive = 0,
@@ -166,5 +167,5 @@ class OSRE_EXPORT AnimationControllerBase {
     AnimationControllerBase() = default;
 };
 
-}
-}
+} // namespace Animation
+} // namespace OSRE

src/Engine/App/AppBase.cpp

@@ -40,6 +40,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #include "RenderBackend/Pipeline.h"
 #include "RenderBackend/RenderBackendService.h"
 #include "RenderBackend/TransformMatrixBlock.h"
+#include "RenderBackend/2D/CanvasRenderer.h"
 #include "App/CameraComponent.h"
 #include "RenderBackend/MaterialBuilder.h"
 
@@ -83,6 +84,7 @@ AppBase::AppBase(i32 argc, const c8 *argv[], const String &supportedArgs, const
         mMouseEvListener(nullptr),
         mKeyboardEvListener(nullptr),
         mIds(nullptr),
+        mCanvasRenderer(nullptr) {
         mStageMode(StageMode::Stage3D),
         mShutdownRequested(false) {
     mSettings->setString(Properties::Settings::RenderAPI, "opengl");
@@ -133,7 +135,7 @@ void AppBase::update() {
     if (mAppState == State::Created) {
         mAppState = State::Running;
     }
-    
+
     onUpdate();
 }
 
@@ -240,6 +242,21 @@ void AppBase::setWindowsTitle(const String &title) {
     }
 }
 
+RenderBackend::CanvasRenderer* AppBase::getCanvasRenderer() const {
+    return (CanvasRenderer*) mCanvasRenderer;
+}
+
+static void attachMouseEventPtrs(EventPtrArray &eventArray) {
+    eventArray.add(&MouseButtonDownEvent);
+    eventArray.add(&MouseButtonUpEvent);
+    eventArray.add(&MouseMoveEvent);
+}
+
+static void attachKeyboardEventPtrs(EventPtrArray &eventArray) {
+    eventArray.add(&KeyboardButtonDownEvent);
+    eventArray.add(&KeyboardButtonUpEvent);
+}
+
 bool AppBase::onCreate() {
     if (mAppState != State::Uninited) {
         osre_debug(Tag, "AppBase::State not in expected state: Uninited.");
@@ -295,7 +312,7 @@ bool AppBase::onCreate() {
 
     // enable render-back-end
     RenderBackend::CreateRendererEventData *data = new CreateRendererEventData(mPlatformInterface->getRootWindow());
-    data->m_pipeline = mRbService->createDefault3DPipeline();
+    data->Pipeline = mRbService->createDefault3DPipeline();
     mRbService->sendEvent(&RenderBackend::OnCreateRendererEvent, data);
 
     mTimer = Platform::PlatformInterface::getInstance()->getTimer();
@@ -323,6 +340,14 @@ bool AppBase::onCreate() {
 
     App::AssetRegistry::registerAssetPathInBinFolder("assets", "assets");
 
+    Rect2ui rect;
+    mPlatformInterface->getRootWindow()->getWindowsRect(rect);
+    mCanvasRenderer = new CanvasRenderer(2, (i32)rect.getX1(), (i32)rect.getY1(), (i32)rect.getWidth(), (i32)rect.getHeight());
+    if (!mCanvasRenderer->create()) {
+        osre_error(Tag, "Error while creating the canvas renderer.");
+        return false;
+    }
+
     mAppState = State::Created;
     osre_debug(Tag, "Set application state to Created.");
 
@@ -361,6 +386,9 @@ bool AppBase::onDestroy() {
     delete mIds;
     mIds = nullptr;
 
+    delete mCanvasRenderer;
+    mCanvasRenderer = nullptr;
+
     delete mMouseEvListener;
     mMouseEvListener = nullptr;
 
@@ -412,3 +440,4 @@ void AppBase::getResolution(ui32 &width, ui32 &height) {
 
 } // Namespace App
 } // Namespace OSRE
+

src/Engine/App/AppBase.h

@@ -50,6 +50,9 @@ namespace Properties {
 
 namespace RenderBackend {
     struct TransformMatrixBlock;
+    struct IRenderPath;
+
+    class CanvasRenderer;
 }
 
 namespace App {
@@ -62,20 +65,23 @@ class AppBase;
 //-------------------------------------------------------------------------------------------------
 ///	@ingroup	Engine
 ///
-/// @brief
+/// @brief This class implements the keyboard event listener.
 //-------------------------------------------------------------------------------------------------
 class OSRE_EXPORT KeyboardEventListener : public Platform::OSEventListener {
 public:
+    /// @brief The class constructor.
     KeyboardEventListener() :
             OSEventListener("App/KeyboardEventListener"),
             mLast(Platform::KEY_UNKNOWN) {
         clearKeyMap();
     }
 
-    ~KeyboardEventListener() override {
-        // empty
-    }
+    /// @brief The class destructor.
+    ~KeyboardEventListener() override = default;
 
+    /// @brief The event handler.
+    /// @param osEvent  The os-specific event.
+    /// @param data     The event-related data.
     void onOSEvent(const Common::Event &osEvent, const Common::EventData *data) override {
         auto keyData = (Platform::KeyboardButtonEventData *)data;
         if (osEvent == Platform::KeyboardButtonDownEvent) {
@@ -87,14 +93,20 @@ class OSRE_EXPORT KeyboardEventListener : public Platform::OSEventListener {
         }
     }
 
+    /// @brief Returns true, when the key is pressed
+    /// @param key      The key to look for
+    /// @return true for is pressed.
     bool isKeyPressed(Platform::Key key) const {
         return mKeymap[key] == 1;
     }
 
+    /// @brief Will return the latest pressed key.
+    /// @return The latest pressed key.
     Platform::Key getLastKey() const {
         return mLast; 
     }
 
+    /// @brief Clearn the map.
     void clearKeyMap() {
         ::memset(mKeymap, 0, sizeof(char) * Platform::KEY_LAST);
     }
@@ -250,6 +262,9 @@ class OSRE_EXPORT AppBase {
     /// @return The keyboard listener.
     virtual KeyboardEventListener *getKeyboardEventListener() const;
 
+    /// @brief
+    virtual RenderBackend::CanvasRenderer *getCanvasRenderer() const;
+
  protected:
     /// @brief  The onCreate callback, override this for your own creation stuff.
     /// @return true if successful,  false if not.
@@ -292,6 +307,7 @@ class OSRE_EXPORT AppBase {
     Common::Ids *mIds;
     StageMode mStageMode;
     bool mShutdownRequested;
+    RenderBackend::IRenderPath *mCanvasRenderer;
 };
 
 inline Stage *AppBase::getStage() const {

src/Engine/App/AppCommon.h

@@ -53,20 +53,22 @@ template<class T> class TAbstractCtrlBase;
 
 /// @brief  Describes the requested render API for the backend.
 enum class RenderBackendType {
+    Invalid = -1,               ///< Invalid render API.
     OpenGLRenderBackend = 0,    ///< OpenGL render API.
-    VulkanRenderBackend         ///< Vulkan render API.
+    VulkanRenderBackend,        ///< Vulkan render API.
+    Count                       ///< Number of render APIs.
 };
 
 struct MouseInputState {
-    i32 mRelX, mRelY, mAbsX, mAbsY;
-    ui32 mLastX, mLastY;
-    cppcore::TBitField<ui32> mMouseButtonState;
+    i32 RelX, RelY, AbsX, AbsY;
+    ui32 LastX, LastY;
+    cppcore::TBitField<ui32> MouseButtonState;
 
     MouseInputState();
 };
 
 inline MouseInputState::MouseInputState() :
-        mRelX(0), mRelY(0), mAbsX(0), mAbsY(0), mLastX(0), mLastY(0), mMouseButtonState() {
+        RelX(0), RelY(0), AbsX(0), AbsY(0), LastX(0), LastY(0), MouseButtonState() {
     // empty
 }
 

src/Engine/App/Component.cpp

@@ -97,8 +97,9 @@ bool RenderComponent::onRender(RenderBackendService *renderBackendSrv) {
     return true;
 }
 
-LightComponent::LightComponent(Entity *owner) 
-        : Component(owner, ComponentType::LightComponentType), mLight(nullptr) {}
+LightComponent::LightComponent(Entity *owner) : Component(owner, ComponentType::LightComponentType), mLight(nullptr) {
+    // empty
+}
 
 void LightComponent::setLight(RenderBackend::Light *light) {
     mLight = light;

src/Engine/App/Component.h

@@ -49,7 +49,7 @@ enum class ComponentType {
     TransformComponentType,     ///< For all transformation types.
     LightComponentType,         ///< For light types.
     CameraComponentType,        ///< For camera components.
-    AnimationComponentType,     ///<
+    AnimationComponentType,     ///< For animation support.
     Count                       ///< The number of components.
 };
 
@@ -127,33 +127,35 @@ class OSRE_EXPORT RenderComponent : public Component {
     /// @brief The class constructor.
     /// @param owner    The owning entity.
     RenderComponent(Entity *owner);
-    
+
     /// @brief The class destructor.
     ~RenderComponent() override = default;
-    
+
     /// @brief  Returns the number of meshes
     /// @return The number of stored meshes.
     size_t getNumMeshes() const;
-    
+
     /// @brief  Returns the mesh at a given index.
     /// @param[in] idx   The requested index.
     /// @return The mesh os a nullptr if the index in invalid.
     RenderBackend::Mesh *getMeshAt(size_t idx) const;
-    
+
     /// @brief  Returns the mesh array.
-    /// @param[inout] array 
+    /// @param[inout] array The mesh array managed by the component.
     void getMeshArray(RenderBackend::MeshArray &array);
-    
-    /// @brief 
-    /// @param geo 
-    void addStaticMesh(RenderBackend::Mesh *geo);
-    
-    /// @brief 
-    /// @param array 
+
+    /// @brief Will add a new mesh.
+    /// @param mesh     Thew mesh to add.
+    void addStaticMesh(RenderBackend::Mesh *mesh);
+
+    /// @brief Will add an array of new meshes.
+    /// @param array    The array with enw meshes.
     void addStaticMeshArray(const RenderBackend::MeshArray &array);
 
 protected:
+    /// The update callback.
     bool onUpdate(Time dt) override;
+    /// The render callback.
     bool onRender(RenderBackend::RenderBackendService *rbSrv) override;
 
 private:
@@ -163,19 +165,19 @@ class OSRE_EXPORT RenderComponent : public Component {
 //-------------------------------------------------------------------------------------------------
 ///	@ingroup	Engine
 ///
-/// @brief
+/// @brief  This component class implements a light.
 //-------------------------------------------------------------------------------------------------
 class LightComponent final : public Component {
 public:
-    /// @brief 
-    /// @param owner 
+    /// @brief The class constructor.
+    /// @param owner    The owning entity.
     LightComponent(Entity *owner);
-    
-    /// @brief 
+
+    /// @brief The class destructor.
     ~LightComponent() override = default;
-    
-    /// @brief 
-    /// @param light 
+
+    /// @brief Will set a new light instance.
+    /// @param light    Thew new light.
     void setLight(RenderBackend::Light *light);
 
 protected: