2010-05-25 17:56:14 +00:00
|
|
|
/*
|
|
|
|
* Cogl
|
|
|
|
*
|
2014-02-22 01:28:54 +00:00
|
|
|
* A Low Level GPU Graphics and Utilities API
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
|
|
|
* Copyright (C) 2010 Intel Corporation.
|
|
|
|
*
|
2014-02-22 01:28:54 +00:00
|
|
|
* Permission is hereby granted, free of charge, to any person
|
|
|
|
* obtaining a copy of this software and associated documentation
|
|
|
|
* files (the "Software"), to deal in the Software without
|
|
|
|
* restriction, including without limitation the rights to use, copy,
|
|
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
|
|
* of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be
|
|
|
|
* included in all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
* SOFTWARE.
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __COGL_TEXTURE_PIXMAP_X11_H
|
|
|
|
#define __COGL_TEXTURE_PIXMAP_X11_H
|
|
|
|
|
2013-10-09 12:31:12 +00:00
|
|
|
/* NB: this is a top-level header that can be included directly but we
|
|
|
|
* want to be careful not to define __COGL_H_INSIDE__ when this is
|
|
|
|
* included internally while building Cogl itself since
|
|
|
|
* __COGL_H_INSIDE__ is used in headers to guard public vs private api
|
|
|
|
* definitions
|
|
|
|
*/
|
|
|
|
#ifndef COGL_COMPILATION
|
2013-11-28 12:34:45 +00:00
|
|
|
|
|
|
|
/* Note: When building Cogl .gir we explicitly define
|
|
|
|
* __COGL_H_INSIDE__ */
|
|
|
|
#ifndef __COGL_H_INSIDE__
|
2012-02-19 23:05:30 +00:00
|
|
|
#define __COGL_H_INSIDE__
|
2013-11-28 12:34:45 +00:00
|
|
|
#define __COGL_MUST_UNDEF_COGL_H_INSIDE__
|
2013-10-09 12:31:12 +00:00
|
|
|
#endif
|
2012-02-19 23:05:30 +00:00
|
|
|
|
2013-11-28 12:34:45 +00:00
|
|
|
#endif /* COGL_COMPILATION */
|
|
|
|
|
2012-02-18 16:53:07 +00:00
|
|
|
#include <cogl/cogl-context.h>
|
|
|
|
|
2012-11-22 18:01:10 +00:00
|
|
|
COGL_BEGIN_DECLS
|
2010-05-25 17:56:14 +00:00
|
|
|
|
|
|
|
#ifdef COGL_ENABLE_EXPERIMENTAL_API
|
|
|
|
|
2011-10-28 17:31:05 +00:00
|
|
|
/**
|
|
|
|
* SECTION:cogl-texture-pixmap-x11
|
|
|
|
* @short_description: Functions for creating and manipulating 2D meta
|
|
|
|
* textures derived from X11 pixmaps.
|
|
|
|
*
|
|
|
|
* These functions allow high-level meta textures (See the
|
|
|
|
* #CoglMetaTexture interface) that derive their contents from an X11
|
|
|
|
* pixmap.
|
|
|
|
*/
|
|
|
|
|
2012-02-18 16:53:07 +00:00
|
|
|
typedef struct _CoglTexturePixmapX11 CoglTexturePixmapX11;
|
|
|
|
|
|
|
|
#define COGL_TEXTURE_PIXMAP_X11(X) ((CoglTexturePixmapX11 *)X)
|
2010-06-30 17:06:04 +00:00
|
|
|
|
2010-05-25 17:56:14 +00:00
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
COGL_TEXTURE_PIXMAP_X11_DAMAGE_RAW_RECTANGLES,
|
|
|
|
COGL_TEXTURE_PIXMAP_X11_DAMAGE_DELTA_RECTANGLES,
|
|
|
|
COGL_TEXTURE_PIXMAP_X11_DAMAGE_BOUNDING_BOX,
|
|
|
|
COGL_TEXTURE_PIXMAP_X11_DAMAGE_NON_EMPTY
|
|
|
|
} CoglTexturePixmapX11ReportLevel;
|
|
|
|
|
2012-02-18 16:53:07 +00:00
|
|
|
/**
|
|
|
|
* COGL_TEXTURE_PIXMAP_X11_ERROR:
|
|
|
|
*
|
2012-08-31 18:28:27 +00:00
|
|
|
* #CoglError domain for texture-pixmap-x11 errors.
|
2012-02-18 16:53:07 +00:00
|
|
|
*
|
|
|
|
* Since: 1.10
|
|
|
|
*/
|
|
|
|
#define COGL_TEXTURE_PIXMAP_X11_ERROR (cogl_texture_pixmap_x11_error_quark ())
|
|
|
|
|
|
|
|
/**
|
|
|
|
* CoglTexturePixmapX11Error:
|
|
|
|
* @COGL_TEXTURE_PIXMAP_X11_ERROR_X11: An X11 protocol error
|
|
|
|
*
|
|
|
|
* Error codes that can be thrown when performing texture-pixmap-x11
|
|
|
|
* operations.
|
|
|
|
*
|
|
|
|
* Since: 1.10
|
|
|
|
*/
|
|
|
|
typedef enum {
|
|
|
|
COGL_TEXTURE_PIXMAP_X11_ERROR_X11,
|
|
|
|
} CoglTexturePixmapX11Error;
|
|
|
|
|
2012-08-31 18:28:27 +00:00
|
|
|
uint32_t cogl_texture_pixmap_x11_error_quark (void);
|
2012-02-18 16:53:07 +00:00
|
|
|
|
2010-05-25 17:56:14 +00:00
|
|
|
/**
|
|
|
|
* cogl_texture_pixmap_x11_new:
|
2012-02-18 16:53:07 +00:00
|
|
|
* @context: A #CoglContext
|
2010-05-25 17:56:14 +00:00
|
|
|
* @pixmap: A X11 pixmap ID
|
|
|
|
* @automatic_updates: Whether to automatically copy the contents of
|
|
|
|
* the pixmap to the texture.
|
2012-08-31 18:28:27 +00:00
|
|
|
* @error: A #CoglError for exceptions
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
|
|
|
* Creates a texture that contains the contents of @pixmap. If
|
|
|
|
* @automatic_updates is %TRUE then Cogl will attempt to listen for
|
|
|
|
* damage events on the pixmap and automatically update the texture
|
|
|
|
* when it changes.
|
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Return value: a new #CoglTexturePixmapX11 instance
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Since: 1.10
|
2010-05-25 17:56:14 +00:00
|
|
|
* Stability: Unstable
|
|
|
|
*/
|
2012-02-18 16:53:07 +00:00
|
|
|
CoglTexturePixmapX11 *
|
|
|
|
cogl_texture_pixmap_x11_new (CoglContext *context,
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
uint32_t pixmap,
|
|
|
|
CoglBool automatic_updates,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2010-05-25 17:56:14 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_texture_pixmap_x11_update_area:
|
2012-02-18 16:53:07 +00:00
|
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
2010-05-25 17:56:14 +00:00
|
|
|
* @x: x coordinate of the area to update
|
|
|
|
* @y: y coordinate of the area to update
|
|
|
|
* @width: width of the area to update
|
|
|
|
* @height: height of the area to update
|
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Forces an update of the given @texture so that it is refreshed with
|
|
|
|
* the contents of the pixmap that was given to
|
2010-05-25 17:56:14 +00:00
|
|
|
* cogl_texture_pixmap_x11_new().
|
|
|
|
*
|
2010-07-09 16:55:31 +00:00
|
|
|
* Since: 1.4
|
2010-05-25 17:56:14 +00:00
|
|
|
* Stability: Unstable
|
|
|
|
*/
|
|
|
|
void
|
2012-02-18 16:53:07 +00:00
|
|
|
cogl_texture_pixmap_x11_update_area (CoglTexturePixmapX11 *texture,
|
2010-05-25 17:56:14 +00:00
|
|
|
int x,
|
|
|
|
int y,
|
|
|
|
int width,
|
|
|
|
int height);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_texture_pixmap_x11_is_using_tfp_extension:
|
2012-02-18 16:53:07 +00:00
|
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Checks whether the given @texture is using the
|
|
|
|
* GLX_EXT_texture_from_pixmap or similar extension to copy the
|
|
|
|
* contents of the pixmap to the texture. This extension is usually
|
|
|
|
* implemented as zero-copy operation so it implies the updates are
|
|
|
|
* working efficiently.
|
2010-09-20 12:15:44 +00:00
|
|
|
*
|
|
|
|
* Return value: %TRUE if the texture is using an efficient extension
|
|
|
|
* and %FALSE otherwise
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
2010-07-09 16:55:31 +00:00
|
|
|
* Since: 1.4
|
2010-05-25 17:56:14 +00:00
|
|
|
* Stability: Unstable
|
|
|
|
*/
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
CoglBool
|
2012-02-18 16:53:07 +00:00
|
|
|
cogl_texture_pixmap_x11_is_using_tfp_extension (CoglTexturePixmapX11 *texture);
|
2010-05-25 17:56:14 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_texture_pixmap_x11_set_damage_object:
|
2012-02-18 16:53:07 +00:00
|
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
2010-05-25 17:56:14 +00:00
|
|
|
* @damage: A X11 Damage object or 0
|
|
|
|
* @report_level: The report level which describes how to interpret
|
|
|
|
* the damage events. This should match the level that the damage
|
|
|
|
* object was created with.
|
|
|
|
*
|
|
|
|
* Sets the damage object that will be used to track automatic updates
|
2012-02-18 16:53:07 +00:00
|
|
|
* to the @texture. Damage tracking can be disabled by passing 0 for
|
2010-05-25 17:56:14 +00:00
|
|
|
* @damage. Otherwise this damage will replace the one used if %TRUE
|
|
|
|
* was passed for automatic_updates to cogl_texture_pixmap_x11_new().
|
|
|
|
*
|
|
|
|
* Note that Cogl will subtract from the damage region as it processes
|
|
|
|
* damage events.
|
2010-07-09 16:55:31 +00:00
|
|
|
*
|
|
|
|
* Since: 1.4
|
|
|
|
* Stability: Unstable
|
2010-05-25 17:56:14 +00:00
|
|
|
*/
|
|
|
|
void
|
2012-02-18 16:53:07 +00:00
|
|
|
cogl_texture_pixmap_x11_set_damage_object (CoglTexturePixmapX11 *texture,
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
uint32_t damage,
|
2010-05-25 17:56:14 +00:00
|
|
|
CoglTexturePixmapX11ReportLevel
|
|
|
|
report_level);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* cogl_is_texture_pixmap_x11:
|
2012-02-18 16:53:07 +00:00
|
|
|
* @object: A pointer to a #CoglObject
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Checks whether @object points to a #CoglTexturePixmapX11 instance.
|
2010-09-20 12:15:44 +00:00
|
|
|
*
|
2012-02-18 16:53:07 +00:00
|
|
|
* Return value: %TRUE if the object is a #CoglTexturePixmapX11, and
|
2010-09-20 12:15:44 +00:00
|
|
|
* %FALSE otherwise
|
2010-05-25 17:56:14 +00:00
|
|
|
*
|
2010-07-09 16:55:31 +00:00
|
|
|
* Since: 1.4
|
2010-05-25 17:56:14 +00:00
|
|
|
* Stability: Unstable
|
|
|
|
*/
|
Switch use of primitive glib types to c99 equivalents
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
2012-04-16 20:56:40 +00:00
|
|
|
CoglBool
|
2012-02-18 16:53:07 +00:00
|
|
|
cogl_is_texture_pixmap_x11 (void *object);
|
2010-05-25 17:56:14 +00:00
|
|
|
|
|
|
|
#endif /* COGL_ENABLE_EXPERIMENTAL_API */
|
|
|
|
|
2012-11-22 18:01:10 +00:00
|
|
|
COGL_END_DECLS
|
2012-02-18 16:53:07 +00:00
|
|
|
|
2013-11-28 12:34:45 +00:00
|
|
|
/* The gobject introspection scanner seems to parse public headers in
|
|
|
|
* isolation which means we need to be extra careful about how we
|
|
|
|
* define and undefine __COGL_H_INSIDE__ used to detect when internal
|
|
|
|
* headers are incorrectly included by developers. In the gobject
|
|
|
|
* introspection case we have to manually define __COGL_H_INSIDE__ as
|
|
|
|
* a commandline argument for the scanner which means we must be
|
|
|
|
* careful not to undefine it in a header...
|
|
|
|
*/
|
|
|
|
#ifdef __COGL_MUST_UNDEF_COGL_H_INSIDE__
|
|
|
|
#undef __COGL_H_INSIDE__
|
|
|
|
#undef __COGL_MUST_UNDEF_COGL_H_INSIDE__
|
|
|
|
#endif
|
|
|
|
|
2010-05-25 17:56:14 +00:00
|
|
|
#endif /* __COGL_TEXTURE_PIXMAP_X11_H */
|