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>
|
|
|
|
|
2009-04-30 17:00:22 +00:00
|
|
|
#include "cogl-handle.h"
|
2010-07-07 17:44:16 +00:00
|
|
|
#include "cogl-buffer.h"
|
2009-04-30 17:00:22 +00:00
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
/*
|
|
|
|
* CoglBitmapDestroyNotify:
|
|
|
|
* @data: The image data
|
|
|
|
* @destroy_data: The callback closure data that was given to
|
|
|
|
* _cogl_bitmap_new_from_data().
|
|
|
|
*
|
|
|
|
* Function prototype that is used to destroy the bitmap data when
|
|
|
|
* _cogl_bitmap_new_from_data() is called.
|
|
|
|
*/
|
|
|
|
typedef void (* CoglBitmapDestroyNotify) (guint8 *data, void *destroy_data);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* _cogl_bitmap_new_from_data:
|
|
|
|
* @data: A pointer to the data. The bitmap will take ownership of this data.
|
|
|
|
* @format: The format of the pixel data.
|
|
|
|
* @width: The width of the bitmap.
|
|
|
|
* @height: The height of the bitmap.
|
|
|
|
* @rowstride: The rowstride of the bitmap (the number of bytes from
|
|
|
|
* the start of one row of the bitmap to the next).
|
|
|
|
* @destroy_fn: A function to be called when the bitmap is
|
|
|
|
* destroyed. This should free @data. %NULL can be used instead if
|
|
|
|
* no free is needed.
|
|
|
|
* @destroy_fn_data: This pointer will get passed to @destroy_fn.
|
|
|
|
*
|
|
|
|
* Creates a bitmap using some existing data. The data is not copied
|
|
|
|
* so the bitmap will take ownership of the data pointer. When the
|
|
|
|
* bitmap is freed @destroy_fn will be called to free the data.
|
|
|
|
*
|
|
|
|
* Return value: A new %CoglBitmap.
|
|
|
|
*/
|
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_new_from_data (guint8 *data,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
int rowstride,
|
|
|
|
CoglBitmapDestroyNotify destroy_fn,
|
|
|
|
gpointer destroy_fn_data);
|
|
|
|
|
|
|
|
/* 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-15 12:05:55 +00:00
|
|
|
/* This creates a cogl bitmap that internally references a pixel
|
|
|
|
array. The data is not copied. _cogl_bitmap_map will divert to
|
|
|
|
mapping the pixel array */
|
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_new_from_buffer (CoglBuffer *buffer,
|
|
|
|
CoglPixelFormat format,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
int rowstride,
|
|
|
|
int offset);
|
|
|
|
|
2008-04-25 13:37:36 +00:00
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_can_convert (CoglPixelFormat src, CoglPixelFormat dst);
|
|
|
|
|
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_fallback_can_convert (CoglPixelFormat src, CoglPixelFormat dst);
|
|
|
|
|
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_can_unpremult (CoglPixelFormat format);
|
|
|
|
|
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_fallback_can_unpremult (CoglPixelFormat format);
|
|
|
|
|
2009-05-09 18:39:01 +00:00
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_can_premult (CoglPixelFormat format);
|
|
|
|
|
|
|
|
gboolean
|
|
|
|
_cogl_bitmap_fallback_can_premult (CoglPixelFormat format);
|
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_convert (CoglBitmap *bmp,
|
2008-04-25 13:37:36 +00:00
|
|
|
CoglPixelFormat dst_format);
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_fallback_convert (CoglBitmap *bmp,
|
2008-04-25 13:37:36 +00:00
|
|
|
CoglPixelFormat dst_format);
|
|
|
|
|
|
|
|
gboolean
|
2010-01-29 15:15:08 +00:00
|
|
|
_cogl_bitmap_unpremult (CoglBitmap *dst_bmp);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
|
|
|
gboolean
|
2010-01-29 15:15:08 +00:00
|
|
|
_cogl_bitmap_fallback_unpremult (CoglBitmap *dst_bmp);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
2009-05-09 18:39:01 +00:00
|
|
|
gboolean
|
2010-01-29 15:15:08 +00:00
|
|
|
_cogl_bitmap_premult (CoglBitmap *dst_bmp);
|
2009-05-09 18:39:01 +00:00
|
|
|
|
|
|
|
gboolean
|
2010-01-29 15:15:08 +00:00
|
|
|
_cogl_bitmap_fallback_premult (CoglBitmap *dst_bmp);
|
2009-05-09 18:39:01 +00:00
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_from_file (const char *filename,
|
2008-04-25 13:37:36 +00:00
|
|
|
GError **error);
|
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_fallback_from_file (const char *filename);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
|
|
|
gboolean
|
2010-01-29 15:15:08 +00:00
|
|
|
_cogl_bitmap_convert_premult_status (CoglBitmap *bmp,
|
|
|
|
CoglPixelFormat dst_format);
|
|
|
|
|
2010-07-07 17:44:16 +00:00
|
|
|
CoglBitmap *
|
|
|
|
_cogl_bitmap_convert_format_and_premult (CoglBitmap *bmp,
|
2010-01-29 15:15:08 +00:00
|
|
|
CoglPixelFormat dst_format);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
|
|
|
void
|
|
|
|
_cogl_bitmap_copy_subregion (CoglBitmap *src,
|
|
|
|
CoglBitmap *dst,
|
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
|
|
|
int src_x,
|
|
|
|
int src_y,
|
|
|
|
int dst_x,
|
|
|
|
int dst_y,
|
|
|
|
int width,
|
|
|
|
int height);
|
2008-04-25 13:37:36 +00:00
|
|
|
|
2009-01-12 16:52:20 +00:00
|
|
|
gboolean
|
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
|
|
|
CoglPixelFormat
|
|
|
|
_cogl_bitmap_get_format (CoglBitmap *bitmap);
|
|
|
|
|
|
|
|
void
|
|
|
|
_cogl_bitmap_set_format (CoglBitmap *bitmap,
|
|
|
|
CoglPixelFormat format);
|
|
|
|
|
|
|
|
int
|
|
|
|
_cogl_bitmap_get_width (CoglBitmap *bitmap);
|
|
|
|
|
|
|
|
int
|
|
|
|
_cogl_bitmap_get_height (CoglBitmap *bitmap);
|
|
|
|
|
|
|
|
int
|
|
|
|
_cogl_bitmap_get_rowstride (CoglBitmap *bitmap);
|
|
|
|
|
|
|
|
guint8 *
|
|
|
|
_cogl_bitmap_map (CoglBitmap *bitmap,
|
|
|
|
CoglBufferAccess access,
|
|
|
|
CoglBufferMapHint hints);
|
|
|
|
|
|
|
|
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
|
|
|
|
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 */
|
|
|
|
guint8 *
|
|
|
|
_cogl_bitmap_bind (CoglBitmap *bitmap,
|
|
|
|
CoglBufferAccess access,
|
|
|
|
CoglBufferMapHint hints);
|
|
|
|
|
|
|
|
void
|
|
|
|
_cogl_bitmap_unbind (CoglBitmap *bitmap);
|
|
|
|
|
2008-04-25 13:37:36 +00:00
|
|
|
#endif /* __COGL_BITMAP_H */
|