[clutter/wip/master-next: 23/31] Deprecate ClutterTexture's API
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [clutter/wip/master-next: 23/31] Deprecate ClutterTexture's API
- Date: Wed, 11 Jul 2012 14:41:26 +0000 (UTC)
commit b985c4035e1a7e9c5b5b9fe1af970a782d573762
Author: Emmanuele Bassi <ebassi gnome org>
Date: Mon Jul 9 17:43:09 2012 +0100
Deprecate ClutterTexture's API
ClutterTexture is full of side effects that have been picked up over the
years; they make improving ClutterTexture harder than necessary, as well
as making subclassing impossible without introducing weird behaviours in
the child classes as well.
Since Clutter 1.10 we have the ClutterImage content type, which is
side-effects free, given that it just paints texture data using the
state of the actor.
Sadly, we still have subclasses of ClutterTexture, both deprecated and
not, so we cannot deprecate ClutterTexture right out; the type and
structures will still be available, like we do for ClutterGroup, but the
whole API should be moved to the deprecated section, waiting for the
time in which we can get rid of it all.
clutter/Makefile.am | 2 +-
clutter/clutter-texture.h | 65 -----------------
clutter/deprecated/clutter-cairo-texture.c | 4 +-
clutter/{ => deprecated}/clutter-texture.c | 78 +++++++++++++++++++--
clutter/deprecated/clutter-texture.h | 104 ++++++++++++++++++++++++++--
clutter/x11/clutter-glx-texture-pixmap.c | 1 +
clutter/x11/clutter-x11-texture-pixmap.c | 1 +
7 files changed, 175 insertions(+), 80 deletions(-)
---
diff --git a/clutter/Makefile.am b/clutter/Makefile.am
index 7899493..4bb641e 100644
--- a/clutter/Makefile.am
+++ b/clutter/Makefile.am
@@ -196,7 +196,6 @@ source_c = \
$(srcdir)/clutter-stage-manager.c \
$(srcdir)/clutter-stage-window.c \
$(srcdir)/clutter-table-layout.c \
- $(srcdir)/clutter-texture.c \
$(srcdir)/clutter-text.c \
$(srcdir)/clutter-text-buffer.c \
$(srcdir)/clutter-transition-group.c \
@@ -304,6 +303,7 @@ deprecated_c = \
$(srcdir)/deprecated/clutter-score.c \
$(srcdir)/deprecated/clutter-shader.c \
$(srcdir)/deprecated/clutter-state.c \
+ $(srcdir)/deprecated/clutter-texture.c \
$(srcdir)/deprecated/clutter-timeout-pool.c \
$(NULL)
diff --git a/clutter/clutter-texture.h b/clutter/clutter-texture.h
index 690a8c1..4781b2c 100644
--- a/clutter/clutter-texture.h
+++ b/clutter/clutter-texture.h
@@ -123,71 +123,6 @@ struct _ClutterTextureClass
GType clutter_texture_get_type (void) G_GNUC_CONST;
-ClutterActor * clutter_texture_new (void);
-ClutterActor * clutter_texture_new_from_file (const gchar *filename,
- GError **error);
-
-gboolean clutter_texture_set_from_file (ClutterTexture *texture,
- const gchar *filename,
- GError **error);
-gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture,
- const guchar *data,
- gboolean has_alpha,
- gint width,
- gint height,
- gint rowstride,
- gint bpp,
- ClutterTextureFlags flags,
- GError **error);
-gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture,
- const guchar *data,
- gboolean has_alpha,
- gint x,
- gint y,
- gint width,
- gint height,
- gint rowstride,
- gint bpp,
- ClutterTextureFlags flags,
- GError **error);
-
-void clutter_texture_get_base_size (ClutterTexture *texture,
- gint *width,
- gint *height);
-void clutter_texture_set_filter_quality (ClutterTexture *texture,
- ClutterTextureQuality filter_quality);
-ClutterTextureQuality clutter_texture_get_filter_quality (ClutterTexture *texture);
-CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture);
-void clutter_texture_set_cogl_texture (ClutterTexture *texture,
- CoglHandle cogl_tex);
-CoglHandle clutter_texture_get_cogl_material (ClutterTexture *texture);
-void clutter_texture_set_cogl_material (ClutterTexture *texture,
- CoglHandle cogl_material);
-void clutter_texture_set_sync_size (ClutterTexture *texture,
- gboolean sync_size);
-gboolean clutter_texture_get_sync_size (ClutterTexture *texture);
-void clutter_texture_set_repeat (ClutterTexture *texture,
- gboolean repeat_x,
- gboolean repeat_y);
-void clutter_texture_get_repeat (ClutterTexture *texture,
- gboolean *repeat_x,
- gboolean *repeat_y);
-CoglPixelFormat clutter_texture_get_pixel_format (ClutterTexture *texture);
-gint clutter_texture_get_max_tile_waste (ClutterTexture *texture);
-void clutter_texture_set_keep_aspect_ratio (ClutterTexture *texture,
- gboolean keep_aspect);
-gboolean clutter_texture_get_keep_aspect_ratio (ClutterTexture *texture);
-void clutter_texture_set_load_async (ClutterTexture *texture,
- gboolean load_async);
-gboolean clutter_texture_get_load_async (ClutterTexture *texture);
-void clutter_texture_set_load_data_async (ClutterTexture *texture,
- gboolean load_async);
-gboolean clutter_texture_get_load_data_async (ClutterTexture *texture);
-
-void clutter_texture_set_pick_with_alpha (ClutterTexture *texture,
- gboolean pick_with_alpha);
-gboolean clutter_texture_get_pick_with_alpha (ClutterTexture *texture);
-
G_END_DECLS
#endif /* __CLUTTER_TEXTURE_H__ */
diff --git a/clutter/deprecated/clutter-cairo-texture.c b/clutter/deprecated/clutter-cairo-texture.c
index c9bf3a2..84ab061 100644
--- a/clutter/deprecated/clutter-cairo-texture.c
+++ b/clutter/deprecated/clutter-cairo-texture.c
@@ -74,6 +74,8 @@
#include <cairo-gobject.h>
#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
+#include "deprecated/clutter-texture.h"
+#include "deprecated/clutter-cairo-texture.h"
#include "clutter-cairo-texture.h"
@@ -84,8 +86,6 @@
#include "clutter-marshal.h"
#include "clutter-private.h"
-#include "deprecated/clutter-cairo-texture.h"
-
G_DEFINE_TYPE (ClutterCairoTexture,
clutter_cairo_texture,
CLUTTER_TYPE_TEXTURE);
diff --git a/clutter/clutter-texture.c b/clutter/deprecated/clutter-texture.c
similarity index 99%
rename from clutter/clutter-texture.c
rename to clutter/deprecated/clutter-texture.c
index fbac708..448c884 100644
--- a/clutter/clutter-texture.c
+++ b/clutter/deprecated/clutter-texture.c
@@ -38,6 +38,9 @@
* box requested using clutter_actor_set_size(). To display an area of
* a texture without scaling, you should set the clip area using
* clutter_actor_set_clip().
+ *
+ * The #ClutterTexture API is deprecated since Clutter 1.12. It is strongly
+ * recommended to use #ClutterImage instead.
*/
#ifdef HAVE_CONFIG_H
@@ -1072,6 +1075,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
*
* This property is unset when using the clutter_texture_set_from_*_data()
* family of functions.
+ *
+ * Deprecated: 1.12
*/
pspec = g_param_spec_string ("filename",
P_("Filename"),
@@ -1107,6 +1112,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
* clutter_main().
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
pspec = g_param_spec_boolean ("load-async",
P_("Load asynchronously"),
@@ -1124,6 +1131,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
* synchronously causing some blocking.
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
pspec = g_param_spec_boolean ("load-data-async",
P_("Load data asynchronously"),
@@ -1149,6 +1158,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
* only fully opaque parts of the texture will react to picking.
*
* Since: 1.4
+ *
+ * Deprecated: 1.12
*/
pspec = g_param_spec_boolean ("pick-with-alpha",
P_("Pick With Alpha"),
@@ -1167,6 +1178,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
* The ::size-change signal is emitted each time the size of the
* pixbuf used by @texture changes. The new size is given as
* argument to the callback.
+ *
+ * Deprecated: 1.12
*/
texture_signals[SIZE_CHANGE] =
g_signal_new ("size-change",
@@ -1184,6 +1197,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
*
* The ::pixbuf-change signal is emitted each time the pixbuf
* used by @texture changes.
+ *
+ * Deprecated: 1.12
*/
texture_signals[PIXBUF_CHANGE] =
g_signal_new ("pixbuf-change",
@@ -1204,6 +1219,8 @@ clutter_texture_class_init (ClutterTextureClass *klass)
* be set, otherwise it will be %NULL
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
texture_signals[LOAD_FINISHED] =
g_signal_new (I_("load-finished"),
@@ -1320,6 +1337,8 @@ clutter_texture_init (ClutterTexture *self)
* unreferenced
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
CoglHandle
clutter_texture_get_cogl_material (ClutterTexture *texture)
@@ -1345,6 +1364,7 @@ clutter_texture_get_cogl_material (ClutterTexture *texture)
*
* Since: 0.8
*
+ * Deprecated: 1.12
*/
void
clutter_texture_set_cogl_material (ClutterTexture *texture,
@@ -1418,6 +1438,8 @@ get_first_layer_index (CoglPipeline *pipeline, int *layer_index)
* handle is owned by the #ClutterTexture and it should not be unreferenced
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
CoglHandle
clutter_texture_get_cogl_texture (ClutterTexture *texture)
@@ -1445,6 +1467,8 @@ clutter_texture_get_cogl_texture (ClutterTexture *texture)
* no longer needed it should be deref'd with cogl_handle_unref.
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_cogl_texture (ClutterTexture *texture,
@@ -1656,7 +1680,9 @@ get_pixel_format_from_texture_flags (gint bpp,
*
* Return value: %TRUE on success, %FALSE on failure.
*
- * Since: 0.4.
+ * Since: 0.4
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_set_from_rgb_data (ClutterTexture *texture,
@@ -2028,6 +2054,8 @@ clutter_texture_async_load (ClutterTexture *self,
* Return value: %TRUE if the image was successfully loaded and set
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_set_from_file (ClutterTexture *texture,
@@ -2101,6 +2129,8 @@ clutter_texture_set_from_file (ClutterTexture *texture,
* is %CLUTTER_TEXTURE_QUALITY_MEDIUM.
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_filter_quality (ClutterTexture *texture,
@@ -2142,6 +2172,8 @@ clutter_texture_set_filter_quality (ClutterTexture *texture,
* Return value: The filter quality value.
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
ClutterTextureQuality
clutter_texture_get_filter_quality (ClutterTexture *texture)
@@ -2185,6 +2217,8 @@ clutter_texture_get_filter_quality (ClutterTexture *texture)
* unlimited.
*
* Since: 0.8
+ *
+ * Deprecated: 1.12
*/
gint
clutter_texture_get_max_tile_waste (ClutterTexture *texture)
@@ -2217,7 +2251,9 @@ clutter_texture_get_max_tile_waste (ClutterTexture *texture)
* error.
*
* Since: 0.8
- **/
+ *
+ * Deprecated: 1.12
+ */
ClutterActor*
clutter_texture_new_from_file (const gchar *filename,
GError **error)
@@ -2242,7 +2278,9 @@ clutter_texture_new_from_file (const gchar *filename,
* Creates a new empty #ClutterTexture object.
*
* Return value: A newly created #ClutterTexture object.
- **/
+ *
+ * Deprecated: 1.12
+ */
ClutterActor *
clutter_texture_new (void)
{
@@ -2256,6 +2294,8 @@ clutter_texture_new (void)
* @height: (out): return location for the height, or %NULL
*
* Gets the size in pixels of the untransformed underlying image
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_get_base_size (ClutterTexture *texture,
@@ -2291,6 +2331,8 @@ clutter_texture_get_base_size (ClutterTexture *texture,
* Return value: %TRUE on success, %FALSE on failure.
*
* Since: 0.6
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_set_area_from_rgb_data (ClutterTexture *texture,
@@ -2534,11 +2576,11 @@ fbo_source_queue_relayout_cb (ClutterActor *source,
*
* Return value: A newly created #ClutterTexture object, or %NULL on failure.
*
+ * Since: 0.6
+ *
* Deprecated: 1.8: Use the #ClutterOffscreenEffect and #ClutterShaderEffect
* directly on the intended #ClutterActor to replace the functionality of
* this function.
- *
- * Since: 0.6
*/
ClutterActor *
clutter_texture_new_from_actor (ClutterActor *actor)
@@ -2707,6 +2749,8 @@ texture_fbo_free_resources (ClutterTexture *texture)
* underlying image data.
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_sync_size (ClutterTexture *texture,
@@ -2738,6 +2782,8 @@ clutter_texture_set_sync_size (ClutterTexture *texture,
* preferred size of the underlying image data
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_get_sync_size (ClutterTexture *texture)
@@ -2757,6 +2803,8 @@ clutter_texture_get_sync_size (ClutterTexture *texture)
* vertically when the actor size is bigger than the image size
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_repeat (ClutterTexture *texture,
@@ -2806,6 +2854,8 @@ clutter_texture_set_repeat (ClutterTexture *texture,
* using clutter_texture_set_repeat()
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_get_repeat (ClutterTexture *texture,
@@ -2838,6 +2888,8 @@ clutter_texture_get_repeat (ClutterTexture *texture,
* Return value: a #CoglPixelFormat value
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
CoglPixelFormat
clutter_texture_get_pixel_format (ClutterTexture *texture)
@@ -2862,6 +2914,8 @@ clutter_texture_get_pixel_format (ClutterTexture *texture)
* the aspect ratio of the underlying image
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_keep_aspect_ratio (ClutterTexture *texture,
@@ -2893,6 +2947,8 @@ clutter_texture_set_keep_aspect_ratio (ClutterTexture *texture,
* aspect ratio of the underlying image
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_get_keep_aspect_ratio (ClutterTexture *texture)
@@ -2916,6 +2972,8 @@ clutter_texture_get_keep_aspect_ratio (ClutterTexture *texture)
* clutter_texture_set_load_data_async().
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_load_async (ClutterTexture *texture,
@@ -2951,6 +3009,8 @@ clutter_texture_set_load_async (ClutterTexture *texture,
* disk asynchronously
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_get_load_async (ClutterTexture *texture)
@@ -2975,6 +3035,8 @@ clutter_texture_get_load_async (ClutterTexture *texture)
* clutter_texture_set_load_async().
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_load_data_async (ClutterTexture *texture,
@@ -3009,6 +3071,8 @@ clutter_texture_set_load_data_async (ClutterTexture *texture,
* data from a file asynchronously
*
* Since: 1.0
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_get_load_data_async (ClutterTexture *texture)
@@ -3038,6 +3102,8 @@ clutter_texture_get_load_data_async (ClutterTexture *texture)
* fully opaque parts of the texture will react to picking.
*
* Since: 1.4
+ *
+ * Deprecated: 1.12
*/
void
clutter_texture_set_pick_with_alpha (ClutterTexture *texture,
@@ -3077,6 +3143,8 @@ clutter_texture_set_pick_with_alpha (ClutterTexture *texture,
* using the alpha channel when picking.
*
* Since: 1.4
+ *
+ * Deprecated: 1.12
*/
gboolean
clutter_texture_get_pick_with_alpha (ClutterTexture *texture)
diff --git a/clutter/deprecated/clutter-texture.h b/clutter/deprecated/clutter-texture.h
index b48b73a..f1bd01c 100644
--- a/clutter/deprecated/clutter-texture.h
+++ b/clutter/deprecated/clutter-texture.h
@@ -32,16 +32,106 @@
G_BEGIN_DECLS
+CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_image_new)
+ClutterActor * clutter_texture_new (void);
+
+CLUTTER_DEPRECATED_IN_1_12
+ClutterActor * clutter_texture_new_from_file (const gchar *filename,
+ GError **error);
+
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_set_from_file (ClutterTexture *texture,
+ const gchar *filename,
+ GError **error);
+CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_image_set_data)
+gboolean clutter_texture_set_from_rgb_data (ClutterTexture *texture,
+ const guchar *data,
+ gboolean has_alpha,
+ gint width,
+ gint height,
+ gint rowstride,
+ gint bpp,
+ ClutterTextureFlags flags,
+ GError **error);
+CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_image_set_area)
+gboolean clutter_texture_set_area_from_rgb_data (ClutterTexture *texture,
+ const guchar *data,
+ gboolean has_alpha,
+ gint x,
+ gint y,
+ gint width,
+ gint height,
+ gint rowstride,
+ gint bpp,
+ ClutterTextureFlags flags,
+ GError **error);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_get_base_size (ClutterTexture *texture,
+ gint *width,
+ gint *height);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_filter_quality (ClutterTexture *texture,
+ ClutterTextureQuality filter_quality);
+CLUTTER_DEPRECATED_IN_1_12
+ClutterTextureQuality clutter_texture_get_filter_quality (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+CoglHandle clutter_texture_get_cogl_texture (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_cogl_texture (ClutterTexture *texture,
+ CoglHandle cogl_tex);
+CLUTTER_DEPRECATED_IN_1_12
+CoglHandle clutter_texture_get_cogl_material (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_cogl_material (ClutterTexture *texture,
+ CoglHandle cogl_material);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_sync_size (ClutterTexture *texture,
+ gboolean sync_size);
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_get_sync_size (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_repeat (ClutterTexture *texture,
+ gboolean repeat_x,
+ gboolean repeat_y);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_get_repeat (ClutterTexture *texture,
+ gboolean *repeat_x,
+ gboolean *repeat_y);
+CLUTTER_DEPRECATED_IN_1_12
+CoglPixelFormat clutter_texture_get_pixel_format (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+gint clutter_texture_get_max_tile_waste (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_keep_aspect_ratio (ClutterTexture *texture,
+ gboolean keep_aspect);
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_get_keep_aspect_ratio (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_load_async (ClutterTexture *texture,
+ gboolean load_async);
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_get_load_async (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_load_data_async (ClutterTexture *texture,
+ gboolean load_async);
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_get_load_data_async (ClutterTexture *texture);
+CLUTTER_DEPRECATED_IN_1_12
+void clutter_texture_set_pick_with_alpha (ClutterTexture *texture,
+ gboolean pick_with_alpha);
+CLUTTER_DEPRECATED_IN_1_12
+gboolean clutter_texture_get_pick_with_alpha (ClutterTexture *texture);
+
CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterOffscreenEffect)
-ClutterActor * clutter_texture_new_from_actor (ClutterActor *actor);
+ClutterActor * clutter_texture_new_from_actor (ClutterActor *actor);
CLUTTER_DEPRECATED_IN_1_10
-gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture,
- const guchar *data,
- gint width,
- gint height,
- ClutterTextureFlags flags,
- GError **error);
+gboolean clutter_texture_set_from_yuv_data (ClutterTexture *texture,
+ const guchar *data,
+ gint width,
+ gint height,
+ ClutterTextureFlags flags,
+ GError **error);
G_END_DECLS
diff --git a/clutter/x11/clutter-glx-texture-pixmap.c b/clutter/x11/clutter-glx-texture-pixmap.c
index f3108e9..33166df 100644
--- a/clutter/x11/clutter-glx-texture-pixmap.c
+++ b/clutter/x11/clutter-glx-texture-pixmap.c
@@ -49,6 +49,7 @@
#include <string.h>
+#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
#include "x11/clutter-x11-texture-pixmap.h"
#include <cogl/cogl-texture-pixmap-x11.h>
diff --git a/clutter/x11/clutter-x11-texture-pixmap.c b/clutter/x11/clutter-x11-texture-pixmap.c
index efaa1f2..62add19 100644
--- a/clutter/x11/clutter-x11-texture-pixmap.c
+++ b/clutter/x11/clutter-x11-texture-pixmap.c
@@ -43,6 +43,7 @@
#endif
#define CLUTTER_ENABLE_EXPERIMENTAL_API
+#define CLUTTER_DISABLE_DEPRECATION_WARNINGS
#include "clutter-x11-texture-pixmap.h"
#include "clutter-x11.h"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
