Enlightenment CVS committal
Author : andrunko
Project : e17
Module : libs/evas
Dir : e17/libs/evas/src/lib/canvas
Modified Files:
evas_object_image.c
Log Message:
Updated documentation.
Fixed documentation of Evas_Object_Image.
Added some more documentation.
Fixed typo on evas_list_remove_list documentation.
===
RCS file: /cvs/e/e17/libs/evas/src/lib/canvas/evas_object_image.c,v
retrieving revision 1.58
retrieving revision 1.59
diff -u -3 -r1.58 -r1.59
--- evas_object_image.c 5 Oct 2007 04:52:10 - 1.58
+++ evas_object_image.c 5 Oct 2007 19:37:21 - 1.59
@@ -34,7 +34,7 @@
int pixels_checked_out;
int load_error;
Evas_List*pixel_updates;
-
+
struct {
unsigned char scale_down_by;
double dpi;
@@ -73,48 +73,48 @@
{
/* methods (compulsory) */
evas_object_image_free,
- evas_object_image_render,
- evas_object_image_render_pre,
- evas_object_image_render_post,
+ evas_object_image_render,
+ evas_object_image_render_pre,
+ evas_object_image_render_post,
/* these are optional. NULL = nothing */
- NULL,
- NULL,
- NULL,
- NULL,
- evas_object_image_is_opaque,
- evas_object_image_was_opaque,
- evas_object_image_is_inside,
- NULL,
- NULL
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ evas_object_image_is_opaque,
+ evas_object_image_was_opaque,
+ evas_object_image_is_inside,
+ NULL,
+ NULL
};
/**
* @defgroup Evas_Object_Image Image Object Functions
*
* Functions used to create and manipulate image objects.
- *
+ *
* Note - Image objects may return or accept "image data" in multiple formats.
* This is based on the colorspace of an object. Here is a rundown on formats:
- *
+ *
* EVAS_COLORSPACE_ARGB:
- *
+ *
* This pixel format is a linear block of pixels, starting at the top-left row
* by row until the bottom right of the image or pixel region. All pixels are
* 32-bit unsigned int's with the high-byte being alpha and the low byte being
- * blue in the format ARGB. Alpha may ore may not be used by evas depending on
+ * blue in the format ARGB. Alpha may or may not be used by evas depending on
* the alpha flag of the image, but if not used, should be set to 0xff anyway.
- *
+ *
* This colorspace uses premultiplied alpha. That means that R, G and B cannot
* exceed A in value. The conversion from non-premultiplied colorspace is:
- *
+ *
* R = (r * a) / 255; G = (g * a) / 255; B = (b * a) / 255;
- *
+ *
* So 50% transparent blue will be: 0x8080. This will not be "dark" - just
* 50% transparent. Values are 0 == black, 255 == solid or full red, green or
* blue.
- *
+ *
* EVAS_COLORSPACE_YCBCR422P601_PL:
- *
+ *
* This is a pointer-list indirected set of YUV (YCbCr) pixel data. This means
* that the data returned or set is not actual pixel data, but pointers TO
* lines of pixel data. The list of pointers will first be N rows of pointers
@@ -124,31 +124,31 @@
* point to rows in the U plane, and the next N / 2 pointers will point to
* the V plane rows. U and V planes are half the horizontal and vertical
* resolution of the U plane.
- *
+ *
* Row order is top to bottom and row pixels are stored left to right.
- *
+ *
* There is a limitation that these images MUST be a multiple of 2 pixels in
* size horizontally or vertically. This is due to the U and V planes being
* half resolution. Also note that this assumes the itu601 YUV colorspace
* specification. This is defined for standard television and mpeg streams.
* HDTV may use the itu709 specification.
- *
+ *
* Values are 0 to 255, indicating full or no signal in that plane
* respectively.
- *
+ *
* EVAS_COLORSPACE_YCBCR422P709_PL:
- *
+ *
* Not implemented yet.
- *
+ *
* EVAS_COLORSPACE_RGB565_A5P:
- *
+ *
* In the process of being implemented in 1 engine only. This may change.
- *
+ *
* This is a pointer to image data for 16-bit half-word pixel data in 16bpp
* RGB 565 format (5 bits red, 6 bits green, 5 bits blue), with the high-byte
* containing red and the low byte containing blue, per pixel. This data is
* packed row by row from the top-left to the bottom right.
- *
+ *
* If the image has an alpha channel enabled there will be an extra alpha plane
* after the color pixel plane. If not, then this data will not exist and
* should not be accessed in any way. This plane is a set of pixels with 1
@@ -156,19 +156,19 @@
* the top-left to the bottom right of the image, row by row. Even though
* the values of the alpha pixels can be 0 to 255, only values 0 through to 32
* are used, 32 being solid and 0 being transparent.
- *
+ *
* RGB values can be 0 to 31 for red and blue and 0 to 63 for green, with 0
* being black and 31 or 63 being full red, green or blue respectively. This
* colorspace is also pre-multiplied like
