mirror of
https://github.com/brl/mutter.git
synced 2024-11-26 18:11:05 -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)
129 lines
4.0 KiB
C
129 lines
4.0 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2008,2009,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/>.
|
|
*
|
|
*
|
|
*
|
|
* Authors:
|
|
* Damien Lespiau <damien.lespiau@intel.com>
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*/
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL_PIXEL_BUFFER_H__
|
|
#define __COGL_PIXEL_BUFFER_H__
|
|
|
|
#include <glib.h>
|
|
#include <cogl/cogl-types.h>
|
|
#include <cogl/cogl-context.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* All of the cogl-pixel-buffer API is currently experimental so we
|
|
* suffix the actual symbols with _EXP so if somone is monitoring for
|
|
* ABI changes it will hopefully be clearer to them what's going on if
|
|
* any of the symbols dissapear at a later date.
|
|
*/
|
|
|
|
#define COGL_PIXEL_BUFFER(buffer) ((CoglPixelBuffer *)(buffer))
|
|
|
|
#define cogl_pixel_buffer_new cogl_pixel_buffer_new_EXP
|
|
#define cogl_pixel_buffer_new_with_size cogl_pixel_buffer_new_with_size_EXP
|
|
#define cogl_is_pixel_buffer cogl_is_pixel_buffer_EXP
|
|
#if 0
|
|
#define cogl_pixel_buffer_set_region cogl_pixel_buffer_set_region_EXP
|
|
#endif
|
|
|
|
typedef struct _CoglPixelBuffer CoglPixelBuffer;
|
|
|
|
/**
|
|
* cogl_pixel_buffer_new:
|
|
* @context: A #CoglContext
|
|
* @size: The number of bytes to allocate for the pixel data.
|
|
* @data: An optional pointer to vertex data to upload immediately
|
|
*
|
|
* Declares a new #CoglPixelBuffer of @size bytes to contain arrays of
|
|
* pixels. Once declared, data can be set using cogl_buffer_set_data()
|
|
* or by mapping it into the application's address space using
|
|
* cogl_buffer_map().
|
|
*
|
|
* If @data isn't %NULL then @size bytes will be read from @data and
|
|
* immediately copied into the new buffer.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglPixelBuffer *
|
|
cogl_pixel_buffer_new (CoglContext *context,
|
|
size_t size,
|
|
const void *data);
|
|
|
|
/**
|
|
* cogl_is_pixel_buffer:
|
|
* @object: a #CoglObject to test
|
|
*
|
|
* Checks whether @object is a pixel buffer.
|
|
*
|
|
* Return value: %TRUE if the @object is a pixel buffer, and %FALSE
|
|
* otherwise
|
|
*
|
|
* Since: 1.2
|
|
* Stability: Unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_pixel_buffer (void *object);
|
|
|
|
#if 0
|
|
/*
|
|
* cogl_pixel_buffer_set_region:
|
|
* @buffer: A #CoglPixelBuffer object
|
|
* @data: pixel data to upload to @array
|
|
* @src_width: width in pixels of the region to update
|
|
* @src_height: height in pixels of the region to update
|
|
* @src_rowstride: row stride in bytes of the source array
|
|
* @dst_x: upper left destination horizontal coordinate
|
|
* @dst_y: upper left destination vertical coordinate
|
|
*
|
|
* Uploads new data into a pixel array. The source data pointed by @data can
|
|
* have a different stride than @array in which case the function will do the
|
|
* right thing for you. For performance reasons, it is recommended for the
|
|
* source data to have the same stride than @array.
|
|
*
|
|
* Return value: %TRUE if the upload succeeded, %FALSE otherwise
|
|
*
|
|
* Since: 1.2
|
|
* Stability: Unstable
|
|
*/
|
|
CoglBool
|
|
cogl_pixel_buffer_set_region (CoglPixelBuffer *buffer,
|
|
uint8_t *data,
|
|
unsigned int src_width,
|
|
unsigned int src_height,
|
|
unsigned int src_rowstride,
|
|
unsigned int dst_x,
|
|
unsigned int dst_y);
|
|
#endif
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_PIXEL_BUFFER_H__ */
|