summaryrefslogtreecommitdiff
path: root/include/gal/cairo/cairo_compositor.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gal/cairo/cairo_compositor.h')
-rw-r--r--include/gal/cairo/cairo_compositor.h127
1 files changed, 127 insertions, 0 deletions
diff --git a/include/gal/cairo/cairo_compositor.h b/include/gal/cairo/cairo_compositor.h
new file mode 100644
index 0000000..6d5d74a
--- /dev/null
+++ b/include/gal/cairo/cairo_compositor.h
@@ -0,0 +1,127 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2013 CERN
+ * @author Maciej Suminski <maciej.suminski@cern.ch>
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+/**
+ * @file cairo_compositor.h
+ * @brief Class that handles multitarget rendering (ie. to different textures/surfaces) and
+ * later compositing into a single image (Cairo flavour).
+ */
+
+#ifndef CAIRO_COMPOSITOR_H_
+#define CAIRO_COMPOSITOR_H_
+
+#include <gal/compositor.h>
+#include <cairo.h>
+#include <boost/smart_ptr/shared_array.hpp>
+#include <deque>
+
+namespace KIGFX
+{
+class CAIRO_COMPOSITOR : public COMPOSITOR
+{
+public:
+ CAIRO_COMPOSITOR( cairo_t** aMainContext );
+ virtual ~CAIRO_COMPOSITOR();
+
+ /// @copydoc COMPOSITOR::Initialize()
+ virtual void Initialize();
+
+ /// @copydoc COMPOSITOR::Resize()
+ virtual void Resize( unsigned int aWidth, unsigned int aHeight );
+
+ /// @copydoc COMPOSITOR::CreateBuffer()
+ virtual unsigned int CreateBuffer();
+
+ /// @copydoc COMPOSITOR::GetBuffer()
+ inline virtual unsigned int GetBuffer() const
+ {
+ return m_current + 1;
+ }
+
+ /// @copydoc COMPOSITOR::SetBuffer()
+ virtual void SetBuffer( unsigned int aBufferHandle );
+
+ /// @copydoc COMPOSITOR::ClearBuffer()
+ virtual void ClearBuffer();
+
+ /// @copydoc COMPOSITOR::DrawBuffer()
+ virtual void DrawBuffer( unsigned int aBufferHandle );
+
+ /**
+ * Function SetMainContext()
+ * Sets a context to be treated as the main context (ie. as a target of buffers rendering and
+ * as a source of settings for newly created buffers).
+ *
+ * @param aMainContext is the context that should be treated as the main one.
+ */
+ inline virtual void SetMainContext( cairo_t* aMainContext )
+ {
+ m_mainContext = aMainContext;
+
+ // Use the context's transformation matrix
+ cairo_get_matrix( m_mainContext, &m_matrix );
+ }
+
+protected:
+ typedef boost::shared_array<unsigned int> BitmapPtr;
+ typedef struct
+ {
+ cairo_t* context; ///< Main texture handle
+ cairo_surface_t* surface; ///< Point to which an image from texture is attached
+ BitmapPtr bitmap; ///< Pixel storage
+ } CAIRO_BUFFER;
+
+ unsigned int m_current; ///< Currently used buffer handle
+ typedef std::deque<CAIRO_BUFFER> CAIRO_BUFFERS;
+
+ /// Pointer to the current context, so it can be changed
+ cairo_t** m_currentContext;
+
+ /// Rendering target used for compositing (the main display)
+ cairo_t* m_mainContext;
+
+ /// Transformation matrix
+ cairo_matrix_t m_matrix;
+
+ /// Stores information about initialized buffers
+ CAIRO_BUFFERS m_buffers;
+
+ unsigned int m_stride; ///< Stride to use given the desired format and width
+ unsigned int m_bufferSize; ///< Amount of memory needed to store a buffer
+
+ /**
+ * Function clean()
+ * performs freeing of resources.
+ */
+ void clean();
+
+ /// Returns number of currently used buffers
+ unsigned int usedBuffers()
+ {
+ return m_buffers.size();
+ }
+};
+} // namespace KIGFX
+
+#endif /* COMPOSITOR_H_ */