2008-04-25 13:37:36 +00:00
|
|
|
/*
|
|
|
|
* Clutter COGL
|
|
|
|
*
|
|
|
|
* A basic GL/GLES Abstraction/Utility Layer
|
|
|
|
*
|
|
|
|
* Authored By Matthew Allum <mallum@openedhand.com>
|
|
|
|
*
|
|
|
|
* Copyright (C) 2007 OpenedHand
|
|
|
|
*
|
|
|
|
* 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
|
2010-03-01 12:56:10 +00:00
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*
|
2008-04-25 13:37:36 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __COGL_BITMAP_H
|
|
|
|
#define __COGL_BITMAP_H
|
|
|
|
|
|
|
|
#include <glib.h>
|
|
|
|
|
2012-04-16 13:14:10 +00:00
|
|
|
#include "cogl-object-private.h"
|
2010-07-07 17:44:16 +00:00
|
|
|
#include "cogl-buffer.h"
|
2011-03-30 12:46:46 +00:00
|
|
|
#include "cogl-bitmap.h"
|
2009-04-30 17:00:22 +00:00
|
|
|
|
2012-05-09 18:43:06 +00:00
|
|
|
#ifdef COGL_HAS_ANDROID_SUPPORT
|
|
|
|
#include <android/asset_manager.h>
|
|
|
|
#endif
|
|
|
|
|
2012-04-24 16:44:38 +00:00
|
|
|
struct _CoglBitmap
|
|
|
|
{
|
|
|
|
CoglObject _parent;
|
|
|
|
|
|
|
|
/* Pointer back to the context that this bitmap was created with */
|
|
|
|
CoglContext *context;
|
|
|
|
|
|
|
|
CoglPixelFormat format;
|
|
|
|
int width;
|
|
|
|
int height;
|
|
|
|
int rowstride;
|
|
|
|
|
|
|
|
uint8_t *data;
|
|
|
|
|
|
|
|
CoglBool mapped;
|
|
|
|
CoglBool bound;
|
|
|
|
|
|
|
|
/* If this is non-null then 'data' is ignored and instead it is
|
|
|
|
fetched from this shared bitmap. */
|
|
|
|
CoglBitmap *shared_bmp;
|
|
|
|
|
|
|
|
/* If this is non-null then 'data' is treated as an offset into the
|
|
|
|
buffer and map will divert to mapping the buffer */
|
|
|
|
CoglBuffer *buffer;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
/*
|
2012-03-13 14:46:18 +00:00
|
|
|
* _cogl_bitmap_new_with_malloc_buffer:
|
|
|
|
* @context: A #CoglContext
|
|
|
|
* @width: width of the bitmap in pixels
|
|
|
|
* @height: height of the bitmap in pixels
|
|
|
|
* @format: the format of the pixels the array will store
|
2010-07-07 17:44:16 +00:00
|
|
|
*
|
2012-03-13 14:46:18 +00:00
|
|
|
* This is equivalent to cogl_bitmap_new_with_size() except that it
|
|
|
|
* allocated the buffer using g_malloc() instead of creating a
|
|
|
|
* #CoglPixelBuffer. The buffer will be automatically destroyed when
|
|
|
|
* the bitmap is freed.
|
2010-07-07 17:44:16 +00:00
|
|
|
*
|
2012-03-13 14:46:18 +00:00
|
|
|
* Return value: a #CoglPixelBuffer representing the newly created array
|
2010-07-07 17:44:16 +00:00
|
|
|
*
|
2012-03-13 14:46:18 +00:00
|
|
|
* Since: 1.10
|
|
|
|
* Stability: Unstable
|
2010-07-07 17:44:16 +00:00
|
|
|
*/
|
|
|
|
CoglBitmap *
|
2012-03-13 14:46:18 +00:00
|
|
|
_cogl_bitmap_new_with_malloc_buffer (CoglContext *context,
|
|
|
|
unsigned int width,
|
|
|
|
unsigned int height,
|
|
|
|
CoglPixelFormat format);
|
2010-07-07 17:44:16 +00:00
|
|
|
|
|
|
|
/* The idea of this function is that it will create a bitmap that
|
|
|
|
shares the actual data with another bitmap. This is needed for the
|
|
|
|
atlas texture backend because it needs upload a bitmap to a sub
|
|
|
|
texture but override the format so that it ignores the premult
|
|
|
|
flag. */
|
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_new_shared (CoglBitmap *shared_bmp,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
int rowstride);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_convert (CoglBitmap *bmp,
|
2012-11-08 17:54:10 +00:00
|
|
|
CoglPixelFormat dst_format,
|
|
|
|
CoglError **error);
|
2012-03-01 13:14:10 +00:00
|
|
|
|
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-03-01 14:44:41 +00:00
|
|
|
_cogl_bitmap_convert_into_bitmap (CoglBitmap *src_bmp,
|
2012-11-08 17:54:10 +00:00
|
|
|
CoglBitmap *dst_bmp,
|
|
|
|
CoglError **error);
|
2012-03-01 14:44:41 +00:00
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
2012-05-09 18:43:06 +00:00
|
|
|
_cogl_bitmap_from_file (CoglContext *ctx,
|
|
|
|
const char *filename,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2012-05-09 18:43:06 +00:00
|
|
|
|
|
|
|
#ifdef COGL_HAS_ANDROID_SUPPORT
|
|
|
|
CoglBitmap *
|
|
|
|
_cogl_android_bitmap_new_from_asset (CoglContext *ctx,
|
|
|
|
AAssetManager *manager,
|
|
|
|
const char *filename,
|
2012-08-31 18:28:27 +00:00
|
|
|
CoglError **error);
|
2012-05-09 18:43:06 +00:00
|
|
|
#endif
|
2008-04-25 13:37:36 +00:00
|
|
|
|
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-11-08 17:54:10 +00:00
|
|
|
_cogl_bitmap_unpremult (CoglBitmap *dst_bmp,
|
|
|
|
CoglError **error);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
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-11-08 17:54:10 +00:00
|
|
|
_cogl_bitmap_premult (CoglBitmap *dst_bmp,
|
|
|
|
CoglError **error);
|
2009-05-09 18:39:01 +00:00
|
|
|
|
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-11-08 17:54:10 +00:00
|
|
|
_cogl_bitmap_convert_premult_status (CoglBitmap *bmp,
|
|
|
|
CoglPixelFormat dst_format,
|
|
|
|
CoglError **error);
|
2010-01-29 15:15:08 +00:00
|
|
|
|
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
|
2008-04-25 13:37:36 +00:00
|
|
|
_cogl_bitmap_copy_subregion (CoglBitmap *src,
|
|
|
|
CoglBitmap *dst,
|
2012-11-08 17:54:10 +00:00
|
|
|
int src_x,
|
|
|
|
int src_y,
|
|
|
|
int dst_x,
|
|
|
|
int dst_y,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
CoglError **error);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
2010-12-17 14:52:25 +00:00
|
|
|
/* Creates a deep copy of the source bitmap */
|
|
|
|
CoglBitmap *
|
2012-11-08 17:54:10 +00:00
|
|
|
_cogl_bitmap_copy (CoglBitmap *src_bmp,
|
|
|
|
CoglError **error);
|
2010-12-17 14:52:25 +00:00
|
|
|
|
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
|
cogl: improves header and coding style consistency
We've had complaints that our Cogl code/headers are a bit "special" so
this is a first pass at tidying things up by giving them some
consistency. These changes are all consistent with how new code in Cogl
is being written, but the style isn't consistently applied across all
code yet.
There are two parts to this patch; but since each one required a large
amount of effort to maintain tidy indenting it made sense to combine the
changes to reduce the time spent re indenting the same lines.
The first change is to use a consistent style for declaring function
prototypes in headers. Cogl headers now consistently use this style for
prototypes:
return_type
cogl_function_name (CoglType arg0,
CoglType arg1);
Not everyone likes this style, but it seems that most of the currently
active Cogl developers agree on it.
The second change is to constrain the use of redundant glib data types
in Cogl. Uses of gint, guint, gfloat, glong, gulong and gchar have all
been replaced with int, unsigned int, float, long, unsigned long and char
respectively. When talking about pixel data; use of guchar has been
replaced with guint8, otherwise unsigned char can be used.
The glib types that we continue to use for portability are gboolean,
gint{8,16,32,64}, guint{8,16,32,64} and gsize.
The general intention is that Cogl should look palatable to the widest
range of C programmers including those outside the Gnome community so
- especially for the public API - we want to minimize the number of
foreign looking typedefs.
2010-02-10 01:57:32 +00:00
|
|
|
_cogl_bitmap_get_size_from_file (const char *filename,
|
|
|
|
int *width,
|
|
|
|
int *height);
|
2009-01-12 16:52:20 +00:00
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
void
|
|
|
|
_cogl_bitmap_set_format (CoglBitmap *bitmap,
|
|
|
|
CoglPixelFormat format);
|
|
|
|
|
2010-12-17 16:30:23 +00:00
|
|
|
/* Maps the bitmap so that the pixels can be accessed directly or if
|
|
|
|
the bitmap is just a memory bitmap then it just returns the pointer
|
|
|
|
to memory. Note that the bitmap isn't guaranteed to allocated to
|
|
|
|
the full size of rowstride*height so it is not safe to read up to
|
|
|
|
the rowstride of the last row. This will be the case if the user
|
|
|
|
uploads data using gdk_pixbuf_new_subpixbuf with a sub region
|
|
|
|
containing the last row of the pixbuf because in that case the
|
|
|
|
rowstride can be much larger than the width of the image */
|
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
|
|
|
uint8_t *
|
2010-07-07 17:44:16 +00:00
|
|
|
_cogl_bitmap_map (CoglBitmap *bitmap,
|
|
|
|
CoglBufferAccess access,
|
2012-11-08 17:54:10 +00:00
|
|
|
CoglBufferMapHint hints,
|
|
|
|
CoglError **error);
|
2010-07-07 17:44:16 +00:00
|
|
|
|
|
|
|
void
|
|
|
|
_cogl_bitmap_unmap (CoglBitmap *bitmap);
|
|
|
|
|
2010-07-15 12:05:55 +00:00
|
|
|
/* These two are replacements for map and unmap that should used when
|
2012-09-19 20:59:19 +00:00
|
|
|
* the pointer is going to be passed to GL for pixel packing or
|
|
|
|
* unpacking. The address might not be valid for reading if the bitmap
|
|
|
|
* was created with new_from_buffer but it will however be good to
|
|
|
|
* pass to glTexImage2D for example. The access should be READ for
|
|
|
|
* unpacking and WRITE for packing. It can not be both
|
|
|
|
*
|
|
|
|
* TODO: split this bind/unbind functions out into a GL specific file
|
|
|
|
*/
|
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
|
|
|
uint8_t *
|
2012-09-19 20:59:19 +00:00
|
|
|
_cogl_bitmap_gl_bind (CoglBitmap *bitmap,
|
|
|
|
CoglBufferAccess access,
|
2012-11-08 17:54:10 +00:00
|
|
|
CoglBufferMapHint hints,
|
|
|
|
CoglError **error);
|
2010-07-15 12:05:55 +00:00
|
|
|
|
|
|
|
void
|
2012-09-19 20:59:19 +00:00
|
|
|
_cogl_bitmap_gl_unbind (CoglBitmap *bitmap);
|
2010-07-15 12:05:55 +00:00
|
|
|
|
2012-04-04 12:57:42 +00:00
|
|
|
CoglContext *
|
|
|
|
_cogl_bitmap_get_context (CoglBitmap *bitmap);
|
|
|
|
|
2008-04-25 13:37:36 +00:00
|
|
|
#endif /* __COGL_BITMAP_H */
|