mirror of
https://github.com/brl/mutter.git
synced 2024-11-30 03:50:47 -05:00
54735dec84
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)
193 lines
5.6 KiB
C
193 lines
5.6 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2010 Intel Corporation.
|
|
*
|
|
* 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 __COGL_TEXTURE_PIXMAP_X11_H
|
|
#define __COGL_TEXTURE_PIXMAP_X11_H
|
|
|
|
#define __COGL_H_INSIDE__
|
|
|
|
#include <glib.h>
|
|
|
|
#include <cogl/cogl-context.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#ifdef COGL_ENABLE_EXPERIMENTAL_API
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
|
|
typedef struct _CoglTexturePixmapX11 CoglTexturePixmapX11;
|
|
|
|
#define COGL_TEXTURE_PIXMAP_X11(X) ((CoglTexturePixmapX11 *)X)
|
|
|
|
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;
|
|
|
|
/**
|
|
* COGL_TEXTURE_PIXMAP_X11_ERROR:
|
|
*
|
|
* #GError domain for texture-pixmap-x11 errors.
|
|
*
|
|
* 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;
|
|
|
|
GQuark cogl_texture_pixmap_x11_error_quark (void);
|
|
|
|
/**
|
|
* cogl_texture_pixmap_x11_new:
|
|
* @context: A #CoglContext
|
|
* @pixmap: A X11 pixmap ID
|
|
* @automatic_updates: Whether to automatically copy the contents of
|
|
* the pixmap to the texture.
|
|
* @error: A #GError for exceptions
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: a new #CoglTexturePixmapX11 instance
|
|
*
|
|
* Since: 1.10
|
|
* Stability: Unstable
|
|
*/
|
|
CoglTexturePixmapX11 *
|
|
cogl_texture_pixmap_x11_new (CoglContext *context,
|
|
uint32_t pixmap,
|
|
CoglBool automatic_updates,
|
|
GError **error);
|
|
|
|
/**
|
|
* cogl_texture_pixmap_x11_update_area:
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
|
* @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
|
|
*
|
|
* Forces an update of the given @texture so that it is refreshed with
|
|
* the contents of the pixmap that was given to
|
|
* cogl_texture_pixmap_x11_new().
|
|
*
|
|
* Since: 1.4
|
|
* Stability: Unstable
|
|
*/
|
|
void
|
|
cogl_texture_pixmap_x11_update_area (CoglTexturePixmapX11 *texture,
|
|
int x,
|
|
int y,
|
|
int width,
|
|
int height);
|
|
|
|
/**
|
|
* cogl_texture_pixmap_x11_is_using_tfp_extension:
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: %TRUE if the texture is using an efficient extension
|
|
* and %FALSE otherwise
|
|
*
|
|
* Since: 1.4
|
|
* Stability: Unstable
|
|
*/
|
|
CoglBool
|
|
cogl_texture_pixmap_x11_is_using_tfp_extension (CoglTexturePixmapX11 *texture);
|
|
|
|
/**
|
|
* cogl_texture_pixmap_x11_set_damage_object:
|
|
* @texture: A #CoglTexturePixmapX11 instance
|
|
* @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
|
|
* to the @texture. Damage tracking can be disabled by passing 0 for
|
|
* @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.
|
|
*
|
|
* Since: 1.4
|
|
* Stability: Unstable
|
|
*/
|
|
void
|
|
cogl_texture_pixmap_x11_set_damage_object (CoglTexturePixmapX11 *texture,
|
|
uint32_t damage,
|
|
CoglTexturePixmapX11ReportLevel
|
|
report_level);
|
|
|
|
/**
|
|
* cogl_is_texture_pixmap_x11:
|
|
* @object: A pointer to a #CoglObject
|
|
*
|
|
* Checks whether @object points to a #CoglTexturePixmapX11 instance.
|
|
*
|
|
* Return value: %TRUE if the object is a #CoglTexturePixmapX11, and
|
|
* %FALSE otherwise
|
|
*
|
|
* Since: 1.4
|
|
* Stability: Unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_texture_pixmap_x11 (void *object);
|
|
|
|
#endif /* COGL_ENABLE_EXPERIMENTAL_API */
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_TEXTURE_PIXMAP_X11_H */
|