summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/canvas/gl.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2014-08-19 17:10:03 -0400
committerTavian Barnes <tavianator@tavianator.com>2015-10-25 11:03:56 -0400
commit7b09710392d35fb55b52031d447a542d99fc6b4b (patch)
tree270eb927ee8c52ceeb99926ebf4843704775a610 /libdimension/dimension/canvas/gl.h
parent200c86b91ea7063d35be3bffc11c5da53c054653 (diff)
downloaddimension-7b09710392d35fb55b52031d447a542d99fc6b4b.tar.xz
Modularize the libdimension codebase.
Diffstat (limited to 'libdimension/dimension/canvas/gl.h')
-rw-r--r--libdimension/dimension/canvas/gl.h52
1 files changed, 52 insertions, 0 deletions
diff --git a/libdimension/dimension/canvas/gl.h b/libdimension/dimension/canvas/gl.h
new file mode 100644
index 0000000..c2d77a1
--- /dev/null
+++ b/libdimension/dimension/canvas/gl.h
@@ -0,0 +1,52 @@
+/*************************************************************************
+ * Copyright (C) 2009-2014 Tavian Barnes <tavianator@tavianator.com> *
+ * *
+ * This file is part of The Dimension Library. *
+ * *
+ * The Dimension Library is free software; you can redistribute it and/ *
+ * or modify it under the terms of the GNU Lesser General Public License *
+ * as published by the Free Software Foundation; either version 3 of the *
+ * License, or (at your option) any later version. *
+ * *
+ * The Dimension Library 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 *
+ * Lesser General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU Lesser General Public *
+ * License along with this program. If not, see *
+ * <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+/**
+ * @file
+ * OpenGL export/import of canvases.
+ */
+
+#ifndef DMNSN_CANVAS_H
+#error "Please include <dimension/canvas.h> instead of this header directly."
+#endif
+
+/**
+ * Optimize a canvas for GL drawing
+ * @param[in] pool The memory pool to allocate from.
+ * @param[in,out] canvas The canvas to optimize.
+ * @return Whether the canvas was successfully optimized.
+ */
+int dmnsn_gl_optimize_canvas(dmnsn_pool *pool, dmnsn_canvas *canvas);
+
+/**
+ * Write canvas to GL framebuffer.
+ * @param[in] canvas The canvas to draw.
+ * @return 0 on success, non-zero on failure.
+ */
+int dmnsn_gl_write_canvas(const dmnsn_canvas *canvas);
+
+/**
+ * Read a canvas from a GL framebuffer.
+ * @param[in] canvas The canvas to write to.
+ * @param[in] x0 The \a x screen coordinate to start copying from.
+ * @param[in] y0 The \a y screen coordinate to start copying from.
+ * @return 0 on success, non-zero on failure.
+ */
+int dmnsn_gl_read_canvas(dmnsn_canvas *canvas, size_t x0, size_t y0);