From 52cb20bb53fdb8ed8b0f2ffdaa5d67b11d77356a Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Wed, 13 Apr 2011 10:47:41 -0400 Subject: [PATCH] spec: Explicitly document components of on image data Since we're just passing it ultimately to gdk_pixbuf_new_from_data in the server, we really should be documenting the restrictions here, such as bits_per_sample always being 8. https://bugzilla.gnome.org/show_bug.cgi?id=647672 --- docs/notification-spec.xml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index a9dad38..2923fa1 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -380,9 +380,18 @@ Formats - The "image-data" and "icon_data" hints should be a raw image data structure - of signature (iiibiiay) which describes the width, height, rowstride, has - alpha, bits per sample, channels and image data respectively. + The "image-data" and "icon_data" hints should be a DBus structure + of signature (iiibiiay). The components of this structure are as follows: + + width (i): Width of image in pixels + height (i): Height of image in pixels + rowstride (i): Distance in bytes between row starts + has_alpha (b): Whether the image has an alpha channel + bits_per_sample (i): Must always be 8 + channels (i): If has_alpha is TRUE, must be 4, otherwise 3 + data (ay): The image data, in RGB byte order + + This image format is derived from gdk-pixbuf. The "app_icon" parameter and "image-path" hint should be either an URI