From c328e0608ff7c92b39524dfd3efa3e858b7260e0 Mon Sep 17 00:00:00 2001 From: Robert Bragg Date: Wed, 2 Mar 2011 15:19:57 +0000 Subject: [PATCH] Rename CoglPixelArray to CoglPixelBuffer This is part of a broader cleanup of some of the experimental Cogl API. One of the reasons for this particular rename is to switch away from using the term "Array" which implies a regular, indexable layout which isn't the case. We also want to strongly imply a relationship between CoglBuffers and CoglPixelBuffers and be consistent with the CoglAttributeBuffer and CoglIndexBuffer APIs. --- cogl/Makefile.am | 6 +-- cogl/cogl-buffer.c | 2 +- cogl/cogl-index-array.c | 2 +- ...-private.h => cogl-pixel-buffer-private.h} | 12 ++--- ...cogl-pixel-array.c => cogl-pixel-buffer.c} | 52 +++++++++---------- ...cogl-pixel-array.h => cogl-pixel-buffer.h} | 52 +++++++++---------- cogl/cogl-texture.c | 14 ++--- cogl/cogl.h | 2 +- doc/reference/cogl/Makefile.am | 2 +- 9 files changed, 72 insertions(+), 72 deletions(-) rename cogl/{cogl-pixel-array-private.h => cogl-pixel-buffer-private.h} (82%) rename cogl/{cogl-pixel-array.c => cogl-pixel-buffer.c} (71%) rename cogl/{cogl-pixel-array.h => cogl-pixel-buffer.h} (70%) diff --git a/cogl/Makefile.am b/cogl/Makefile.am index f79a71073..41bfcafbd 100644 --- a/cogl/Makefile.am +++ b/cogl/Makefile.am @@ -70,7 +70,7 @@ cogl_public_h = \ $(srcdir)/cogl-offscreen.h \ $(srcdir)/cogl-primitives.h \ $(srcdir)/cogl-path.h \ - $(srcdir)/cogl-pixel-array.h \ + $(srcdir)/cogl-pixel-buffer.h \ $(srcdir)/cogl-shader.h \ $(srcdir)/cogl-texture.h \ $(srcdir)/cogl-texture-3d.h \ @@ -216,8 +216,8 @@ cogl_sources_c = \ $(srcdir)/cogl-color.c \ $(srcdir)/cogl-buffer-private.h \ $(srcdir)/cogl-buffer.c \ - $(srcdir)/cogl-pixel-array-private.h \ - $(srcdir)/cogl-pixel-array.c \ + $(srcdir)/cogl-pixel-buffer-private.h \ + $(srcdir)/cogl-pixel-buffer.c \ $(srcdir)/cogl-vertex-buffer-private.h \ $(srcdir)/cogl-vertex-buffer.c \ $(srcdir)/cogl-index-array-private.h \ diff --git a/cogl/cogl-buffer.c b/cogl/cogl-buffer.c index ff62566d5..5a25fe7ee 100644 --- a/cogl/cogl-buffer.c +++ b/cogl/cogl-buffer.c @@ -43,7 +43,7 @@ #include "cogl-util.h" #include "cogl-context-private.h" #include "cogl-handle.h" -#include "cogl-pixel-array-private.h" +#include "cogl-pixel-buffer-private.h" /* * GL/GLES compatibility defines for the buffer API: diff --git a/cogl/cogl-index-array.c b/cogl/cogl-index-array.c index 0c81cc26d..5c9d722e0 100644 --- a/cogl/cogl-index-array.c +++ b/cogl/cogl-index-array.c @@ -106,7 +106,7 @@ cogl_index_array_allocate (CoglIndexArray *indices, * CoglAttributeBuffer (buffer sub-class) * CoglAttribute (defines meta data for sub-region of buffer) * CoglPrimitive (object encapsulating a set of attributes) - * CoglPixelArray (buffer sub-class) + * CoglPixelBuffer (buffer sub-class) * CoglIndexArray (buffer sub-class) * CoglIndices (defines meta data for sub-region of array) * diff --git a/cogl/cogl-pixel-array-private.h b/cogl/cogl-pixel-buffer-private.h similarity index 82% rename from cogl/cogl-pixel-array-private.h rename to cogl/cogl-pixel-buffer-private.h index d613f45ca..bccfb4bb8 100644 --- a/cogl/cogl-pixel-array-private.h +++ b/cogl/cogl-pixel-buffer-private.h @@ -25,8 +25,8 @@ * Robert Bragg */ -#ifndef __COGL_PIXEL_ARRAY_PRIVATE_H__ -#define __COGL_PIXEL_ARRAY_PRIVATE_H__ +#ifndef __COGL_PIXEL_BUFFER_PRIVATE_H__ +#define __COGL_PIXEL_BUFFER_PRIVATE_H__ #include "cogl-handle.h" #include "cogl-buffer-private.h" @@ -35,9 +35,9 @@ G_BEGIN_DECLS -#define COGL_PIXEL_ARRAY(array) ((CoglPixelArray *)(array)) +#define COGL_PIXEL_BUFFER(array) ((CoglPixelBuffer *)(array)) -struct _CoglPixelArray +struct _CoglPixelBuffer { CoglBuffer _parent; @@ -48,8 +48,8 @@ struct _CoglPixelArray }; GQuark -_cogl_handle_pixel_array_get_type (void); +_cogl_handle_pixel_buffer_get_type (void); G_END_DECLS -#endif /* __COGL_PIXEL_ARRAY_PRIVATE_H__ */ +#endif /* __COGL_PIXEL_BUFFER_PRIVATE_H__ */ diff --git a/cogl/cogl-pixel-array.c b/cogl/cogl-pixel-buffer.c similarity index 71% rename from cogl/cogl-pixel-array.c rename to cogl/cogl-pixel-buffer.c index fce42f19a..ea9255301 100644 --- a/cogl/cogl-pixel-array.c +++ b/cogl/cogl-pixel-buffer.c @@ -26,7 +26,7 @@ */ /* For an overview of the functionality implemented here, please see - * cogl-pixel-array.h, which contains the gtk-doc section overview for the + * cogl-buffer-array.h, which contains the gtk-doc section overview for the * Pixel Buffers API. */ @@ -43,8 +43,8 @@ #include "cogl-util.h" #include "cogl-context-private.h" #include "cogl-object.h" -#include "cogl-pixel-array-private.h" -#include "cogl-pixel-array.h" +#include "cogl-pixel-buffer-private.h" +#include "cogl-pixel-buffer.h" /* * GL/GLES compatibility defines for the buffer API: @@ -72,15 +72,15 @@ #endif static void -_cogl_pixel_array_free (CoglPixelArray *buffer); +_cogl_pixel_buffer_free (CoglPixelBuffer *buffer); -COGL_BUFFER_DEFINE (PixelArray, pixel_array) +COGL_BUFFER_DEFINE (PixelBuffer, pixel_buffer) -static CoglPixelArray * -_cogl_pixel_array_new (unsigned int size) +static CoglPixelBuffer * +_cogl_pixel_buffer_new (unsigned int size) { - CoglPixelArray *pixel_array = g_slice_new0 (CoglPixelArray); - CoglBuffer *buffer = COGL_BUFFER (pixel_array); + CoglPixelBuffer *pixel_buffer = g_slice_new0 (CoglPixelBuffer); + CoglBuffer *buffer = COGL_BUFFER (pixel_buffer); gboolean use_malloc; _COGL_GET_CONTEXT (ctx, COGL_INVALID_HANDLE); @@ -99,50 +99,50 @@ _cogl_pixel_array_new (unsigned int size) COGL_BUFFER_UPDATE_HINT_STATIC); /* return COGL_INVALID_HANDLE; */ - return _cogl_pixel_array_object_new (pixel_array); + return _cogl_pixel_buffer_object_new (pixel_buffer); } -CoglPixelArray * -cogl_pixel_array_new_with_size (unsigned int width, - unsigned int height, - CoglPixelFormat format, - unsigned int *rowstride) +CoglPixelBuffer * +cogl_pixel_buffer_new_with_size (unsigned int width, + unsigned int height, + CoglPixelFormat format, + unsigned int *rowstride) { - CoglPixelArray *buffer; - CoglPixelArray *pixel_array; + CoglPixelBuffer *buffer; + CoglPixelBuffer *pixel_buffer; unsigned int stride; /* creating a buffer to store "any" format does not make sense */ if (G_UNLIKELY (format == COGL_PIXEL_FORMAT_ANY)) return COGL_INVALID_HANDLE; - /* for now we fallback to cogl_pixel_array_new, later, we could ask + /* for now we fallback to cogl_pixel_buffer_new, later, we could ask * libdrm a tiled buffer for instance */ stride = width * _cogl_get_format_bpp (format); if (rowstride) *rowstride = stride; - buffer = _cogl_pixel_array_new (height * stride); + buffer = _cogl_pixel_buffer_new (height * stride); if (G_UNLIKELY (buffer == COGL_INVALID_HANDLE)) return COGL_INVALID_HANDLE; - pixel_array = COGL_PIXEL_ARRAY (buffer); - pixel_array->width = width; - pixel_array->height = height; - pixel_array->format = format; - pixel_array->stride = stride; + pixel_buffer = COGL_PIXEL_BUFFER (buffer); + pixel_buffer->width = width; + pixel_buffer->height = height; + pixel_buffer->format = format; + pixel_buffer->stride = stride; return buffer; } static void -_cogl_pixel_array_free (CoglPixelArray *buffer) +_cogl_pixel_buffer_free (CoglPixelBuffer *buffer) { _COGL_GET_CONTEXT (ctx, NO_RETVAL); /* parent's destructor */ _cogl_buffer_fini (COGL_BUFFER (buffer)); - g_slice_free (CoglPixelArray, buffer); + g_slice_free (CoglPixelBuffer, buffer); } diff --git a/cogl/cogl-pixel-array.h b/cogl/cogl-pixel-buffer.h similarity index 70% rename from cogl/cogl-pixel-array.h rename to cogl/cogl-pixel-buffer.h index 870ed9cbf..cd2f685fb 100644 --- a/cogl/cogl-pixel-array.h +++ b/cogl/cogl-pixel-buffer.h @@ -29,31 +29,31 @@ #error "Only can be included directly." #endif -#ifndef __COGL_PIXEL_ARRAY_H__ -#define __COGL_PIXEL_ARRAY_H__ +#ifndef __COGL_PIXEL_BUFFER_H__ +#define __COGL_PIXEL_BUFFER_H__ #include #include G_BEGIN_DECLS -/* All of the cogl-pixel-array API is currently experimental so we +/* 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_array_new cogl_pixel_array_new_EXP -#define cogl_pixel_array_new_with_size cogl_pixel_array_new_with_size_EXP -#define cogl_is_pixel_array cogl_is_pixel_array_EXP +#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_array_set_region cogl_pixel_array_set_region_EXP +#define cogl_pixel_buffer_set_region cogl_pixel_buffer_set_region_EXP #endif -typedef struct _CoglPixelArray CoglPixelArray; +typedef struct _CoglPixelBuffer CoglPixelBuffer; /** - * cogl_pixel_array_new_with_size: + * cogl_pixel_buffer_new_with_size: * @width: width of the pixel array in pixels * @height: height of the pixel array in pixels * @format: the format of the pixels the array will store @@ -68,20 +68,20 @@ typedef struct _CoglPixelArray CoglPixelArray; * arrays are likely to have a stride larger than width * bytes_per_pixel. The * user must take the stride into account when writing into it. * - * Return value: a #CoglPixelArray representing the newly created array or + * Return value: a #CoglPixelBuffer representing the newly created array or * %NULL on failure * * Since: 1.2 * Stability: Unstable */ -CoglPixelArray * -cogl_pixel_array_new_with_size (unsigned int width, - unsigned int height, - CoglPixelFormat format, - unsigned int *stride); +CoglPixelBuffer * +cogl_pixel_buffer_new_with_size (unsigned int width, + unsigned int height, + CoglPixelFormat format, + unsigned int *stride); /** - * cogl_is_pixel_array: + * cogl_is_pixel_buffer: * @object: a #CoglObject to test * * Checks whether @handle is a pixel array. @@ -93,11 +93,11 @@ cogl_pixel_array_new_with_size (unsigned int width, * Stability: Unstable */ gboolean -cogl_is_pixel_array (void *object); +cogl_is_pixel_buffer (void *object); #if 0 /* - * cogl_pixel_array_set_region: + * cogl_pixel_buffer_set_region: * @array: the #CoglHandle of a pixel array * @data: pixel data to upload to @array * @src_width: width in pixels of the region to update @@ -117,15 +117,15 @@ cogl_is_pixel_array (void *object); * Stability: Unstable */ gboolean -cogl_pixel_array_set_region (CoglHandle array, - guint8 *data, - unsigned int src_width, - unsigned int src_height, - unsigned int src_rowstride, - unsigned int dst_x, - unsigned int dst_y); +cogl_pixel_buffer_set_region (CoglHandle array, + guint8 *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_ARRAY_H__ */ +#endif /* __COGL_PIXEL_BUFFER_H__ */ diff --git a/cogl/cogl-texture.c b/cogl/cogl-texture.c index 4bf58ae24..57f4905c5 100644 --- a/cogl/cogl-texture.c +++ b/cogl/cogl-texture.c @@ -37,7 +37,7 @@ #include "cogl-bitmap.h" #include "cogl-bitmap-private.h" #include "cogl-buffer-private.h" -#include "cogl-pixel-array-private.h" +#include "cogl-pixel-buffer-private.h" #include "cogl-private.h" #include "cogl-texture-private.h" #include "cogl-texture-driver.h" @@ -574,7 +574,7 @@ cogl_texture_new_from_buffer_EXP (CoglHandle buffer, { CoglHandle texture; CoglBuffer *cogl_buffer; - CoglPixelArray *pixel_array; + CoglPixelBuffer *pixel_buffer; CoglBitmap *bmp; g_return_val_if_fail (cogl_is_buffer (buffer), COGL_INVALID_HANDLE); @@ -583,23 +583,23 @@ cogl_texture_new_from_buffer_EXP (CoglHandle buffer, return COGL_INVALID_HANDLE; cogl_buffer = COGL_BUFFER (buffer); - pixel_array = COGL_PIXEL_ARRAY (buffer); + pixel_buffer = COGL_PIXEL_BUFFER (buffer); /* Rowstride from CoglBuffer or even width * bpp if not given */ if (rowstride == 0) - rowstride = pixel_array->stride; + rowstride = pixel_buffer->stride; if (rowstride == 0) rowstride = width * _cogl_get_format_bpp (format); /* use the CoglBuffer height and width as last resort */ if (width == 0) - width = pixel_array->width; + width = pixel_buffer->width; if (height == 0) - height = pixel_array->height; + height = pixel_buffer->height; if (width == 0 || height == 0) { /* no width or height specified, neither at creation time (because the - * array was created by cogl_pixel_array_new()) nor when calling this + * array was created by cogl_pixel_buffer_new()) nor when calling this * function */ return COGL_INVALID_HANDLE; } diff --git a/cogl/cogl.h b/cogl/cogl.h index 50160f0fb..cf2d60637 100644 --- a/cogl/cogl.h +++ b/cogl/cogl.h @@ -75,7 +75,7 @@ typedef struct _CoglFramebuffer CoglFramebuffer; #include #include #include -#include +#include #include #include #include diff --git a/doc/reference/cogl/Makefile.am b/doc/reference/cogl/Makefile.am index 8b00b8a6f..00da6f790 100644 --- a/doc/reference/cogl/Makefile.am +++ b/doc/reference/cogl/Makefile.am @@ -74,7 +74,7 @@ IGNORE_HFILES=\ cogl-pipeline-progend-glsl-private.h \ cogl-pipeline-vertend-fixed-private.h \ cogl-pipeline-vertend-glsl-private.h \ - cogl-pixel-array-private.h \ + cogl-pixel-buffer-private.h \ cogl-primitive-private.h \ cogl-primitives-private.h \ cogl-private.h \