1 files changed, 133 insertions, 0 deletions
diff --git a/canvas/inc/rendering/irendermodule.hxx b/canvas/inc/rendering/irendermodule.hxx
new file mode 100644
index 000000000..527eedc9f
--- /dev/null
+++ b/canvas/inc/rendering/irendermodule.hxx
@@ -0,0 +1,133 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#pragma once
+
+#include <memory>
+
+namespace basegfx
+{
+    class B2IVector;
+}
+
+namespace canvas
+{
+    struct ISurface;
+
+    struct Vertex
+    {
+        float r,g,b,a;
+        float u,v;
+        float x,y,z;
+    };
+
+    /** Output module interface for backend render implementations.
+
+        Implement this interface for each operating system- or
+        library-specific rendering backend, which needs coupling with
+        the canvas rendering framework (which can be shared between
+        all backend implementations).
+     */
+    struct IRenderModule
+    {
+        /** Type of primitive passed to the render module via
+            pushVertex()
+         */
+        enum class PrimitiveType
+        {
+            Unknown,
+            Triangle,
+            Quad
+        };
+
+        virtual ~IRenderModule() {}
+
+        /// Lock rendermodule against concurrent access
+        virtual void lock() const = 0;
+
+        /// Unlock rendermodule for concurrent access
+        virtual void unlock() const = 0;
+
+        /** Maximal size of VRAM pages available
+
+            This is typically the maximum texture size of the
+            hardware, or some arbitrary limit if the backend is
+            software.
+         */
+        virtual ::basegfx::B2IVector getPageSize() = 0;
+
+        /** Create a (possibly hardware-accelerated) surface
+
+            @return a pointer to a surface, which is an abstraction of
+            a piece of (possibly hardware-accelerated) texture memory.
+         */
+        virtual std::shared_ptr<ISurface> createSurface( const ::basegfx::B2IVector& surfaceSize ) = 0;
+
+        /** Begin rendering the given primitive.
+
+            Each beginPrimitive() call must be matched with an
+            endPrimitive() call.
+         */
+        virtual void      beginPrimitive( PrimitiveType eType ) = 0;
+
+        /** Finish rendering a primitive.
+
+            Each beginPrimitive() call must be matched with an
+            endPrimitive() call.
+         */
+        virtual void      endPrimitive() = 0;
+
+        /** Add given vertex to current primitive
+
+            After issuing a beginPrimitive(), each pushVertex() adds a
+            vertex to the active primitive.
+         */
+        virtual void      pushVertex( const Vertex& vertex ) = 0;
+
+        /** Query error status
+
+            @returns true, if an error occurred during primitive
+            construction.
+         */
+        virtual bool      isError() = 0;
+    };
+
+    /// Little RAII wrapper for guarding access to IRenderModule interface
+    class RenderModuleGuard
+    {
+    public:
+        explicit RenderModuleGuard( const std::shared_ptr<IRenderModule>& rRenderModule ) :
+            mpRenderModule( rRenderModule )
+        {
+            mpRenderModule->lock();
+        }
+
+        ~RenderModuleGuard()
+        {
+            mpRenderModule->unlock();
+        }
+
+        RenderModuleGuard(const RenderModuleGuard&) = delete;
+        RenderModuleGuard& operator=( const RenderModuleGuard& ) = delete;
+    private:
+        const std::shared_ptr<IRenderModule> mpRenderModule;
+    };
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */