clutter 2.0.2-x86-mingw32 → 2.0.3-x86-mingw32

data/vendor/local/include/cogl/cogl/cogl-atlas-texture.h

@@ -0,0 +1,230 @@
+/*
+ * Cogl
+ *
+ * An object oriented GL/GLES Abstraction/Utility Layer
+ *
+ * Copyright (C) 2013 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(COGL_COMPILATION)
+#error "Only <cogl/cogl.h> can be included directly."
+#endif
+
+#ifndef _COGL_ATLAS_TEXTURE_H_
+#define _COGL_ATLAS_TEXTURE_H_
+
+#include <cogl/cogl-context.h>
+
+COGL_BEGIN_DECLS
+
+/**
+ * SECTION:cogl-atlas-texture
+ * @short_description: Functions for managing textures in Cogl's global
+ *                     set of texture atlases
+ *
+ * A texture atlas is a texture that contains many smaller images that
+ * an application is interested in. These are packed together as a way
+ * of optimizing drawing with those images by avoiding the costs of
+ * repeatedly telling the hardware to change what texture it should
+ * sample from.  This can enable more geometry to be batched together
+ * into few draw calls.
+ *
+ * Each #CoglContext has an shared, pool of texture atlases that are
+ * are managed by Cogl.
+ *
+ * This api lets applications upload texture data into one of Cogl's
+ * shared texture atlases using a high-level #CoglAtlasTexture which
+ * represents a sub-region of one of these atlases.
+ *
+ * <note>A #CoglAtlasTexture is a high-level meta texture which has
+ * some limitations to be aware of. Please see the documentation for
+ * #CoglMetaTexture for more details.</note>
+ */
+
+
+typedef struct _CoglAtlasTexture CoglAtlasTexture;
+#define COGL_ATLAS_TEXTURE(tex) ((CoglAtlasTexture *) tex)
+
+
+/**
+ * cogl_atlas_texture_new_with_size:
+ * @ctx: A #CoglContext
+ * @width: The width of your atlased texture.
+ * @height: The height of your atlased texture.
+ * @internal_format: The format of the texture
+ *
+ * Creates a #CoglAtlasTexture with a given @width and @height. A
+ * #CoglAtlasTexture represents a sub-region within one of Cogl's
+ * shared texture atlases.
+ *
+ * The storage for the texture is not allocated before this function
+ * returns. You can call cogl_texture_allocate() to explicitly
+ * allocate the underlying storage or let Cogl automatically allocate
+ * storage lazily.
+ *
+ * <note>This call can fail if Cogl considers the given
+ * @internal_format incompatible with the format of its internal
+ * atlases.</note>
+ *
+ * <note>The returned #CoglAtlasTexture is a high-level meta-texture
+ * with some limitations. See the documentation for #CoglMetaTexture
+ * for more details.</note>
+ *
+ * Return value: (transfer full): A new #CoglAtlasTexture object with
+ *          no storage allocated yet or %NULL on failure and @error
+ *          will be updated.
+ * Since: 1.16
+ * Stability: unstable
+ */
+CoglAtlasTexture *
+cogl_atlas_texture_new_with_size (CoglContext *ctx,
+                                  int width,
+                                  int height,
+                                  CoglPixelFormat internal_format,
+                                  CoglError **error);
+
+/**
+ * cogl_atlas_texture_new_from_file:
+ * @ctx: A #CoglContext
+ * @filename: the file to load
+ * @internal_format: The format of the texture
+ *
+ * Creates a #CoglAtlasTexture from an image file. A #CoglAtlasTexture
+ * represents a sub-region within one of Cogl's shared texture
+ * atlases.
+ *
+ * <note>This call can fail if Cogl considers the given
+ * @internal_format incompatible with the format of its internal
+ * atlases.</note>
+ *
+ * <note>The returned #CoglAtlasTexture is a high-level meta-texture
+ * with some limitations. See the documentation for #CoglMetaTexture
+ * for more details.</note>
+ *
+ * Return value: (transfer full): A new #CoglAtlasTexture object or
+ *          %NULL on failure and @error will be updated.
+ * Since: 1.16
+ * Stability: unstable
+ */
+CoglAtlasTexture *
+cogl_atlas_texture_new_from_file (CoglContext *ctx,
+                                  const char *filename,
+                                  CoglPixelFormat internal_format,
+                                  CoglError **error);
+
+/**
+ * cogl_atlas_texture_new_from_data:
+ * @ctx: A #CoglContext
+ * @width: width of texture in pixels
+ * @height: height of texture in pixels
+ * @format: the #CoglPixelFormat the buffer is stored in in RAM
+ * @internal_format: the #CoglPixelFormat to use for the GPU storage of the
+ *    texture. If %COGL_PIXEL_FORMAT_ANY is given then a premultiplied
+ *    format similar to the format of the source data will be used. The
+ *    default blending equations of Cogl expect premultiplied color data;
+ *    the main use of passing a non-premultiplied format here is if you
+ *    have non-premultiplied source data and are going to adjust the blend
+ *    mode (see cogl_material_set_blend()) or use the data for something
+ *    other than straight blending.
+ * @rowstride: the memory offset in bytes between the start of each
+ *    row in @data. A value of 0 will make Cogl automatically
+ *    calculate @rowstride from @width and @format.
+ * @data: pointer to the memory region where the source buffer resides
+ * @error: A #CoglError to catch exceptional errors or %NULL
+ *
+ * Creates a new #CoglAtlasTexture texture based on data residing in
+ * memory. A #CoglAtlasTexture represents a sub-region within one of
+ * Cogl's shared texture atlases.
+ *
+ * <note>This call can fail if Cogl considers the given
+ * @internal_format incompatible with the format of its internal
+ * atlases.</note>
+ *
+ * <note>The returned #CoglAtlasTexture is a high-level
+ * meta-texture with some limitations. See the documentation for
+ * #CoglMetaTexture for more details.</note>
+ *
+ * Return value: (transfer full): A new #CoglAtlasTexture object or
+ *          %NULL on failure and @error will be updated.
+ * Since: 1.16
+ * Stability: unstable
+ */
+CoglAtlasTexture *
+cogl_atlas_texture_new_from_data (CoglContext *ctx,
+                                  int width,
+                                  int height,
+                                  CoglPixelFormat format,
+                                  CoglPixelFormat internal_format,
+                                  int rowstride,
+                                  const uint8_t *data,
+                                  CoglError **error);
+
+/**
+ * cogl_atlas_texture_new_from_bitmap:
+ * @bmp: A #CoglBitmap
+ * @internal_format: the #CoglPixelFormat to use for the GPU storage of the
+ *    texture. If %COGL_PIXEL_FORMAT_ANY is given then a premultiplied
+ *    format similar to the format of the source data will be used. The
+ *    default blending equations of Cogl expect premultiplied color data;
+ *    the main use of passing a non-premultiplied format here is if you
+ *    have non-premultiplied source data and are going to adjust the blend
+ *    mode (see cogl_material_set_blend()) or use the data for something
+ *    other than straight blending.
+ * @error: A #CoglError to catch exceptional errors or %NULL
+ *
+ * Creates a new #CoglAtlasTexture texture based on data residing in a
+ * @bitmap. A #CoglAtlasTexture represents a sub-region within one of
+ * Cogl's shared texture atlases.
+ *
+ * <note>This call can fail if Cogl considers the given
+ * @internal_format incompatible with the format of its internal
+ * atlases.</note>
+ *
+ * <note>The returned #CoglAtlasTexture is a high-level meta-texture
+ * with some limitations. See the documentation for #CoglMetaTexture
+ * for more details.</note>
+ *
+ * Return value: (transfer full): A new #CoglAtlasTexture object or
+ *          %NULL on failure and @error will be updated.
+ * Since: 1.16
+ * Stability: unstable
+ */
+CoglAtlasTexture *
+cogl_atlas_texture_new_from_bitmap (CoglBitmap *bmp,
+                                    CoglPixelFormat internal_format,
+                                    CoglError **error);
+
+/**
+ * cogl_is_atlas_texture:
+ * @object: a #CoglObject
+ *
+ * Checks whether the given object references a #CoglAtlasTexture
+ *
+ * Return value: %TRUE if the passed object represents an atlas
+ *   texture and %FALSE otherwise
+ *
+ * Since: 1.16
+ * Stability: Unstable
+ */
+CoglBool
+cogl_is_atlas_texture (void *object);
+
+COGL_END_DECLS
+
+#endif /* _COGL_ATLAS_TEXTURE_H_ */

data/vendor/local/include/cogl/cogl/cogl-attribute-buffer.h

@@ -69,7 +69,7 @@ COGL_BEGIN_DECLS
  * Note: You can assume this function always succeeds and won't return
  * %NULL
  *
- * Return value: A newly allocated #CoglAttributeBuffer. Never %NULL.
+ * Return value: (transfer full): A newly allocated #CoglAttributeBuffer. Never %NULL.
  *
  * Stability: Unstable
  */
@@ -81,7 +81,8 @@ cogl_attribute_buffer_new_with_size (CoglContext *context,
  * cogl_attribute_buffer_new:
  * @context: A #CoglContext
  * @bytes: The number of bytes to allocate for vertex attribute data.
- * @data: An optional pointer to vertex data to upload immediately.
+ * @data: (array length=bytes): An optional pointer to vertex data to
+ *        upload immediately.
  *
  * Describes a new #CoglAttributeBuffer of @size bytes to contain
  * arrays of vertex attribute data and also uploads @size bytes read
@@ -100,7 +101,7 @@ cogl_attribute_buffer_new_with_size (CoglContext *context,
  * explicitly catch errors with cogl_buffer_set_data() or
  * cogl_buffer_map().</note>
  *
- * Return value: A newly allocated #CoglAttributeBuffer (never %NULL)
+ * Return value: (transfer full): A newly allocated #CoglAttributeBuffer (never %NULL)
  *
  * Since: 1.4
  * Stability: Unstable

data/vendor/local/include/cogl/cogl/cogl-attribute.h

@@ -50,7 +50,7 @@ COGL_BEGIN_DECLS
  */
 
 /**
- * cogl_attribute_new:
+ * cogl_attribute_new: (constructor)
  * @attribute_buffer: The #CoglAttributeBuffer containing the actual
  *                    attribute data
  * @name: The name of the attribute (used to reference it from GLSL)
@@ -76,6 +76,11 @@ COGL_BEGIN_DECLS
  *    <listitem>"cogl_tex_coord0_in", "cogl_tex_coord1", ...
  * (used for vertex texture coordinates)</listitem>
  *    <listitem>"cogl_normal_in" (used for vertex normals)</listitem>
+ *    <listitem>"cogl_point_size_in" (used to set the size of points
+ *    per-vertex. Note this can only be used if
+ *    %COGL_FEATURE_ID_POINT_SIZE_ATTRIBUTE is advertised and
+ *    cogl_pipeline_set_per_vertex_point_size() is called on the pipeline.
+ *    </listitem>
  *  </itemizedlist>
  *
  * The attribute values corresponding to different vertices can either
@@ -125,8 +130,9 @@ COGL_BEGIN_DECLS
  * mapped into the GPU which can be a bottlneck when dealing with
  * a large number of vertices.
  *
- * Returns: A newly allocated #CoglAttribute describing the
- *          layout for a list of attribute values stored in @array.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          describing the layout for a list of attribute values
+ *          stored in @array.
  *
  * Since: 1.4
  * Stability: Unstable
@@ -158,8 +164,8 @@ cogl_attribute_new (CoglAttributeBuffer *attribute_buffer,
  * attribute float name;
  * |]
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant @value.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant @value.
  */
 CoglAttribute *
 cogl_attribute_new_const_1f (CoglContext *context,
@@ -170,8 +176,8 @@ cogl_attribute_new_const_1f (CoglContext *context,
  * cogl_attribute_new_const_2f:
  * @context: A #CoglContext
  * @name: The name of the attribute (used to reference it from GLSL)
- * @constant0: The first component of a 2 component vector
- * @constant1: The second component of a 2 component vector
+ * @component0: The first component of a 2 component vector
+ * @component1: The second component of a 2 component vector
  *
  * Creates a new, 2 component, attribute whose value remains
  * constant across all the vertices of a primitive without needing to
@@ -185,8 +191,8 @@ cogl_attribute_new_const_1f (CoglContext *context,
  * attribute vec2 name;
  * |]
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_2f (CoglContext *context,
@@ -198,9 +204,9 @@ cogl_attribute_new_const_2f (CoglContext *context,
  * cogl_attribute_new_const_3f:
  * @context: A #CoglContext
  * @name: The name of the attribute (used to reference it from GLSL)
- * @constant0: The first component of a 3 component vector
- * @constant1: The second component of a 3 component vector
- * @constant2: The third component of a 3 component vector
+ * @component0: The first component of a 3 component vector
+ * @component1: The second component of a 3 component vector
+ * @component2: The third component of a 3 component vector
  *
  * Creates a new, 3 component, attribute whose value remains
  * constant across all the vertices of a primitive without needing to
@@ -217,8 +223,8 @@ cogl_attribute_new_const_2f (CoglContext *context,
  * unless the built in name "cogl_normal_in" is being used where no
  * explicit GLSL declaration need be made.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_3f (CoglContext *context,
@@ -231,10 +237,10 @@ cogl_attribute_new_const_3f (CoglContext *context,
  * cogl_attribute_new_const_4f:
  * @context: A #CoglContext
  * @name: The name of the attribute (used to reference it from GLSL)
- * @constant0: The first component of a 4 component vector
- * @constant1: The second component of a 4 component vector
- * @constant2: The third component of a 4 component vector
- * @constant3: The fourth component of a 4 component vector
+ * @component0: The first component of a 4 component vector
+ * @component1: The second component of a 4 component vector
+ * @component2: The third component of a 4 component vector
+ * @component3: The fourth component of a 4 component vector
  *
  * Creates a new, 4 component, attribute whose value remains
  * constant across all the vertices of a primitive without needing to
@@ -252,8 +258,8 @@ cogl_attribute_new_const_3f (CoglContext *context,
  * "cogl_tex_coord0_in or "cogl_tex_coord1_in" etc is being used where
  * no explicit GLSL declaration need be made.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_4f (CoglContext *context,
@@ -281,8 +287,8 @@ cogl_attribute_new_const_4f (CoglContext *context,
  * attribute vec2 name;
  * |]
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_2fv (CoglContext *context,
@@ -310,8 +316,8 @@ cogl_attribute_new_const_2fv (CoglContext *context,
  * unless the built in name "cogl_normal_in" is being used where no
  * explicit GLSL declaration need be made.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_3fv (CoglContext *context,
@@ -340,8 +346,8 @@ cogl_attribute_new_const_3fv (CoglContext *context,
  * "cogl_tex_coord0_in or "cogl_tex_coord1_in" etc is being used where
  * no explicit GLSL declaration need be made.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant vector.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant vector.
  */
 CoglAttribute *
 cogl_attribute_new_const_4fv (CoglContext *context,
@@ -373,8 +379,8 @@ cogl_attribute_new_const_4fv (CoglContext *context,
  * around the diagonal of the matrix such that the first column
  * becomes the first row and the second column becomes the second row.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant matrix.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant matrix.
  */
 CoglAttribute *
 cogl_attribute_new_const_2x2fv (CoglContext *context,
@@ -408,8 +414,8 @@ cogl_attribute_new_const_2x2fv (CoglContext *context,
  * becomes the first row and the second column becomes the second row
  * etc.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant matrix.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant matrix.
  */
 CoglAttribute *
 cogl_attribute_new_const_3x3fv (CoglContext *context,
@@ -443,8 +449,8 @@ cogl_attribute_new_const_3x3fv (CoglContext *context,
  * becomes the first row and the second column becomes the second row
  * etc.
  *
- * Returns: A newly allocated #CoglAttribute representing the given
- *          constant matrix.
+ * Return value: (transfer full): A newly allocated #CoglAttribute
+ *          representing the given constant matrix.
  */
 CoglAttribute *
 cogl_attribute_new_const_4x4fv (CoglContext *context,
@@ -491,8 +497,8 @@ cogl_attribute_get_normalized (CoglAttribute *attribute);
  * cogl_attribute_get_buffer:
  * @attribute: A #CoglAttribute
  *
- * Return value: the #CoglAttributeBuffer that was set with
- * cogl_attribute_set_buffer() or cogl_attribute_new().
+ * Return value: (transfer none): the #CoglAttributeBuffer that was
+ *        set with cogl_attribute_set_buffer() or cogl_attribute_new().
  *
  * Stability: unstable
  * Since: 1.10

data/vendor/local/include/cogl/cogl/cogl-bitmap.h

@@ -28,6 +28,10 @@
 #ifndef __COGL_BITMAP_H__
 #define __COGL_BITMAP_H__
 
+/* XXX: We forward declare CoglBitmap here to allow for circular
+ * dependencies between some headers */
+typedef struct _CoglBitmap CoglBitmap;
+
 #include <cogl/cogl-types.h>
 #include <cogl/cogl-buffer.h>
 #include <cogl/cogl-context.h>
@@ -39,8 +43,6 @@
 
 COGL_BEGIN_DECLS
 
-typedef struct _CoglBitmap CoglBitmap;
-
 /**
  * SECTION:cogl-bitmap
  * @short_description: Functions for loading images
@@ -60,8 +62,8 @@ typedef struct _CoglBitmap CoglBitmap;
  * Loads an image file from disk. This function can be safely called from
  * within a thread.
  *
- * Return value: a #CoglBitmap to the new loaded image data, or
- *   %NULL if loading the image failed.
+ * Return value: (transfer full): a #CoglBitmap to the new loaded
+ *               image data, or %NULL if loading the image failed.
  *
  * Since: 1.0
  */
@@ -79,8 +81,8 @@ cogl_bitmap_new_from_file (const char *filename,
  *
  * Loads an Android asset into a newly allocated #CoglBitmap.
  *
- * Return value: A newly allocated #CoglBitmap holding the image data of the
- *               specified asset.
+ * Return value: (transfer full): A newly allocated #CoglBitmap
+ *               holding the image data of the specified asset.
  *
  * Since: 2.0
  */
@@ -107,7 +109,7 @@ cogl_android_bitmap_new_from_asset (CoglContext *context,
  * Wraps some image data that has been uploaded into a #CoglBuffer as
  * a #CoglBitmap. The data is not copied in this process.
  *
- * Return value: a #CoglBitmap encapsulating the given @buffer.
+ * Return value: (transfer full): a #CoglBitmap encapsulating the given @buffer.
  *
  * Since: 1.8
  * Stability: unstable
@@ -143,8 +145,8 @@ cogl_bitmap_new_from_buffer (CoglBuffer *buffer,
  * writing into it. The stride can be retrieved with
  * cogl_bitmap_get_rowstride().</note>
  *
- * Return value: a #CoglPixelBuffer representing the newly created array or
- *               %NULL on failure
+ * Return value: (transfer full): a #CoglPixelBuffer representing the
+ *               newly created array or %NULL on failure
  *
  * Since: 1.10
  * Stability: Unstable
@@ -171,7 +173,7 @@ cogl_bitmap_new_with_size (CoglContext *context,
  * cogl_framebuffer_read_pixels_into_bitmap() to read data directly
  * into an application buffer with the specified rowstride.
  *
- * Return value: A new #CoglBitmap.
+ * Return value: (transfer full): A new #CoglBitmap.
  * Since: 1.10
  * Stability: unstable
  */
@@ -233,8 +235,8 @@ cogl_bitmap_get_rowstride (CoglBitmap *bitmap);
  * cogl_bitmap_get_buffer:
  * @bitmap: A #CoglBitmap
  *
- * Return value: the #CoglPixelBuffer that this buffer uses for
- *   storage. Note that if the bitmap was created with
+ * Return value: (transfer none): the #CoglPixelBuffer that this
+ *   buffer uses for storage. Note that if the bitmap was created with
  *   cogl_bitmap_new_from_file() then it will not actually be using a
  *   pixel buffer and this function will return %NULL.
  * Stability: unstable