mirror of
https://github.com/brl/mutter.git
synced 2024-11-22 16:10:41 -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)
118 lines
3.4 KiB
C
118 lines
3.4 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2007,2008,2009,2012 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/>.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL_OFFSCREEN_H__
|
|
#define __COGL_OFFSCREEN_H__
|
|
|
|
#include <cogl/cogl-types.h>
|
|
#include <cogl/cogl-texture.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* SECTION:cogl-offscreen
|
|
* @short_description: Fuctions for creating and manipulating offscreen
|
|
* framebuffers.
|
|
*
|
|
* Cogl allows creating and operating on offscreen framebuffers.
|
|
*/
|
|
|
|
typedef struct _CoglOffscreen CoglOffscreen;
|
|
|
|
#define COGL_OFFSCREEN(X) ((CoglOffscreen *)X)
|
|
|
|
/* Offscreen api */
|
|
|
|
/**
|
|
* cogl_offscreen_new_to_texture:
|
|
* @texture: A #CoglTexture pointer
|
|
*
|
|
* This creates an offscreen buffer object using the given @texture as the
|
|
* primary color buffer. It doesn't just initialize the contents of the
|
|
* offscreen buffer with the @texture; they are tightly bound so that
|
|
* drawing to the offscreen buffer effectivly updates the contents of the
|
|
* given texture. You don't need to destroy the offscreen buffer before
|
|
* you can use the @texture again.
|
|
*
|
|
* <note>This only works with low-level #CoglTexture types such as
|
|
* #CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not
|
|
* with meta-texture types such as #CoglTexture2DSliced.</note>
|
|
*
|
|
* Return value: (transfer full): a newly instantiated #CoglOffscreen
|
|
* framebuffer or %NULL if it wasn't possible to create the
|
|
* buffer.
|
|
*/
|
|
CoglOffscreen *
|
|
cogl_offscreen_new_to_texture (CoglTexture *texture);
|
|
|
|
/**
|
|
* cogl_is_offscreen:
|
|
* @object: A pointer to a #CoglObject
|
|
*
|
|
* Determines whether the given #CoglObject references an offscreen
|
|
* framebuffer object.
|
|
*
|
|
* Returns: %TRUE if @object is a #CoglOffscreen framebuffer,
|
|
* %FALSE otherwise
|
|
*/
|
|
CoglBool
|
|
cogl_is_offscreen (void *object);
|
|
|
|
#ifndef COGL_DISABLE_DEPRECATED
|
|
|
|
/**
|
|
* cogl_offscreen_ref:
|
|
* @offscreen: A pointer to a #CoglOffscreen framebuffer
|
|
*
|
|
* Increments the reference count on the @offscreen framebuffer.
|
|
*
|
|
* Return value: (transfer none): For convenience it returns the
|
|
* given @offscreen
|
|
*
|
|
* Deprecated: 1.2: cogl_object_ref() should be used in new code.
|
|
*/
|
|
void *
|
|
cogl_offscreen_ref (void *offscreen) G_GNUC_DEPRECATED;
|
|
|
|
/**
|
|
* cogl_offscreen_unref:
|
|
* @offscreen: A pointer to a #CoglOffscreen framebuffer
|
|
*
|
|
* Decreases the reference count for the @offscreen buffer and frees it when
|
|
* the count reaches 0.
|
|
*
|
|
* Deprecated: 1.2: cogl_object_unref() should be used in new code.
|
|
*/
|
|
void
|
|
cogl_offscreen_unref (void *offscreen) G_GNUC_DEPRECATED;
|
|
|
|
#endif /* COGL_DISABLE_DEPRECATED */
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_OFFSCREEN_H__ */
|