AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
d607312080
gtk2/gtk/gtkglarea.h

137 lines
5.1 KiB
C
Raw Normal View History

Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
/* GTK - The GIMP Toolkit
*
* gtkglarea.h: A GL drawing area
*
* Copyright © 2014 Emmanuele Bassi
*
* This 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 2 of the License, or (at your option) any later version.
*
* This 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 library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GTK_GL_AREA_H__
#define __GTK_GL_AREA_H__
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#include <gtk/gtkwidget.h>
G_BEGIN_DECLS
#define GTK_TYPE_GL_AREA (gtk_gl_area_get_type ())
#define GTK_GL_AREA(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_GL_AREA, GtkGLArea))
#define GTK_IS_GL_AREA(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_GL_AREA))
#define GTK_GL_AREA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_GL_AREA, GtkGLAreaClass))
#define GTK_IS_GL_AREA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_GL_AREA))
#define GTK_GL_AREA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_GL_AREA, GtkGLAreaClass))
typedef struct _GtkGLArea GtkGLArea;
typedef struct _GtkGLAreaClass GtkGLAreaClass;
/**
* GtkGLArea:
*
* A #GtkWidget used for drawing with OpenGL.
*
* Since: 3.16
*/
struct _GtkGLArea
{
/*< private >*/
GtkWidget parent_instance;
};
/**
* GtkGLAreaClass:
* @render: class closure for the #GtkGLArea::render signal
gl area: Add a few missing docs
2015-04-20 21:52:48 +00:00
* @resize: class closeure for the #GtkGLArea::resize signal
* @create_context: class closure for the #GtkGLArea::create-context signal
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
*
* The `GtkGLAreaClass` structure contains only private data.
*
* Since: 3.16
*/
struct _GtkGLAreaClass
{
/*< private >*/
GtkWidgetClass parent_class;
/*< public >*/
gboolean (* render) (GtkGLArea *area,
GdkGLContext *context);
GtkGLArea: Add resize signal This is very useful, as almost all GL code wants to recalculate the cameras each time the window size changes.
2014-10-30 18:49:43 +00:00
void (* resize) (GtkGLArea *area,
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
int width,
int height);
GtkGLArea: Add create-context signal This lets you hook into the GL context creation which is useful if you want to share one GL context between GtkGLArea widgets.
2014-11-03 09:43:31 +00:00
GdkGLContext * (* create_context) (GtkGLArea *area);
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
/*< private >*/
gpointer _padding[6];
};
GDK_AVAILABLE_IN_3_16
GType gtk_gl_area_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
GtkWidget * gtk_gl_area_new (void);
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
glarea: Relay the use-es flag to context creation https://bugzilla.gnome.org/show_bug.cgi?id=743746
2016-04-18 14:15:27 +00:00
GDK_AVAILABLE_IN_3_22
void gtk_gl_area_set_use_es (GtkGLArea *area,
gboolean use_es);
GDK_AVAILABLE_IN_3_22
gboolean gtk_gl_area_get_use_es (GtkGLArea *area);
glarea: Add accessors for the required GL version Specifying the version of OpenGL is enough of a common operation that it should not require overriding the creation of the GdkGLContext.
2015-02-12 13:20:24 +00:00
GDK_AVAILABLE_IN_3_16
void gtk_gl_area_set_required_version (GtkGLArea *area,
More documentation fixes
2015-03-14 02:01:47 +00:00
gint major,
gint minor);
glarea: Add accessors for the required GL version Specifying the version of OpenGL is enough of a common operation that it should not require overriding the creation of the GdkGLContext.
2015-02-12 13:20:24 +00:00
GDK_AVAILABLE_IN_3_16
void gtk_gl_area_get_required_version (GtkGLArea *area,
More documentation fixes
2015-03-14 02:01:47 +00:00
gint *major,
gint *minor);
GtkGLArea: Add profile property This lets you force a core 3.2 context if you want
2014-10-30 18:18:05 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
gboolean gtk_gl_area_get_has_depth_buffer (GtkGLArea *area);
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_set_has_depth_buffer (GtkGLArea *area,
gboolean has_depth_buffer);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
gboolean gtk_gl_area_get_has_stencil_buffer (GtkGLArea *area);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_set_has_stencil_buffer (GtkGLArea *area,
gboolean has_stencil_buffer);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
gboolean gtk_gl_area_get_auto_render (GtkGLArea *area);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_set_auto_render (GtkGLArea *area,
gboolean auto_render);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_queue_render (GtkGLArea *area);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
GdkGLContext * gtk_gl_area_get_context (GtkGLArea *area);
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_make_current (GtkGLArea *area);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_attach_buffers (GtkGLArea *area);
GtkGLArea: Major reworking This restructures the way buffers are allocated and bound in a way that is more flexible. Buffer operation happens in three phases: create_buffer() - Creates the gl objects allocate_buffers() - Allocates space for the buffers at a given size attach_buffers() - Attaches the buffers to the framebuffer and makes the framebuffer the default drawing target And destroy via delete_buffers() We call all these the first draw, and after that we allocate buffers each time the widget changes size until the buffers are deleted. We delete the buffers at unrealize. However, anyone that wants to manually control buffer allocation strategies can manually call allocate/delete_buffers(). There are also some other changes: * Support for stencil buffers. * A manual render mode where ::draw doesn't render unless you manually invalidated the previous rendering.
2014-10-30 17:22:44 +00:00
GtkGLArea: Add create-context signal This lets you hook into the GL context creation which is useful if you want to share one GL context between GtkGLArea widgets.
2014-11-03 09:43:31 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
void gtk_gl_area_set_error (GtkGLArea *area,
const GError *error);
GtkGLArea: Add create-context signal This lets you hook into the GL context creation which is useful if you want to share one GL context between GtkGLArea widgets.
2014-11-03 09:43:31 +00:00
GDK_AVAILABLE_IN_3_16
glarea: Clean up the header
2015-02-12 12:42:08 +00:00
GError * gtk_gl_area_get_error (GtkGLArea *area);
Add GtkGLArea widget
2014-10-09 09:11:32 +00:00
G_END_DECLS
#endif /* __GTK_GL_AREA_H__ */
Reference in New Issue Copy Permalink