summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/fl_bitmap.html21
-rw-r--r--doc/fl_image.html142
-rw-r--r--doc/fl_jpeg_image.html7
-rw-r--r--doc/fl_pixmap.html9
-rw-r--r--doc/fl_png_image.html10
-rw-r--r--doc/fl_rgb_image.html64
-rw-r--r--doc/fl_shared_image.html153
7 files changed, 281 insertions, 125 deletions
diff --git a/doc/fl_bitmap.html b/doc/fl_bitmap.html
index 54f2ae1..57d8a2a 100644
--- a/doc/fl_bitmap.html
+++ b/doc/fl_bitmap.html
@@ -52,15 +52,15 @@
<tr>
<td><pre>
Fl_Bitmap(const uchar *bits, int W, int H);
-</pre></td>
-<td>&nbsp;</td>
- </tr>
- <tr>
-<td><pre>
Fl_Bitmap(const char *bits, int W, int H);
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Create
+ (Data : in Color_Component_Array;
+ Width, Height : in Natural)
+ return Bitmap;
+</pre></td>
</tr>
<tr>
@@ -113,21 +113,24 @@ procedure Draw
<td><pre>
virtual void label(Fl_Widget *w);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void label(Fl_Menu_Item *m);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void uncache();
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+procedure Uncache
+ (This : in out Bitmap);
+</pre></td>
</tr>
</table>
diff --git a/doc/fl_image.html b/doc/fl_image.html
index 4addc4e..7838289 100644
--- a/doc/fl_image.html
+++ b/doc/fl_image.html
@@ -56,6 +56,55 @@
+<table class="type">
+ <tr><th colspan="2">Errors</th></tr>
+
+ <tr>
+ <td>ERR_FILE_ACCESS</td>
+ <td>File_Access_Error</td>
+ </tr>
+
+ <tr>
+ <td>ERR_FORMAT</td>
+ <td>Format_Error</td>
+ </tr>
+
+ <tr>
+ <td>ERR_NO_IMAGE</td>
+ <td>No_Image_Error</td>
+ </tr>
+
+</table>
+
+
+
+<table class="function">
+ <tr><th colspan="2">Static Functions and Procedures</th></tr>
+
+ <tr>
+<td><pre>
+static void RGB_scaling(Fl_RGB_Scaling);
+</pre></td>
+<td><pre>
+procedure Set_Copy_Algorithm
+ (To : in Scaling_Kind);
+</pre></td>
+ </tr>
+
+ <tr>
+<td><pre>
+static Fl_RGB_Scaling RGB_scaling();
+</pre></td>
+<td><pre>
+function Get_Copy_Algorithm
+ return Scaling_Kind;
+</pre></td>
+ </tr>
+
+</table>
+
+
+
<table class="function">
<tr><th colspan="2">Functions and Procedures</th></tr>
@@ -109,7 +158,20 @@ function Copy
<td><pre>
int count() const;
</pre></td>
+<td><pre>
+function Get_Data_Count
+ (This : in Image)
+ return Natural;
+</pre></td>
+ </tr>
+
+ <tr>
<td>&nbsp;</td>
+<td><pre>
+function Get_Data_Size
+ (This : in Image)
+ return Natural;
+</pre></td>
</tr>
<tr>
@@ -127,7 +189,53 @@ function Get_D
<td><pre>
const char * const * data() const;
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Get_Datum
+ (This : in Image;
+ Data : in Positive;
+ Position : in Positive)
+ return Color_Component
+with Pre =>
+ Data <= Get_Data_Count (This) and
+ Position <= Get_Data_Size (This);
+
+procedure Set_Datum
+ (This : in out Image;
+ Data : in Positive;
+ Position : in Positive;
+ Value : in Color_Component)
+with Pre =>
+ Data <= Get_Data_Count (This) and
+ Position <= Get_Data_Size (This);
+
+function Get_Data
+ (This : in Image;
+ Data : in Positive;
+ Position : in Positive;
+ Count : in Natural)
+ return Color_Component_Array
+with Pre =>
+ Data <= Get_Data_Count (This) and
+ Position <= Get_Data_Size (This) and
+ Count <= Get_Data_Size (This) - Position + 1;
+
+function All_Data
+ (This : in Image;
+ Data : in Positive)
+ return Color_Component_Array
+with Pre =>
+ Data <= Get_Data_Count (This);
+
+procedure Update_Data
+ (This : in out Image;
+ Data : in Positive;
+ Position : in Positive;
+ Values : in Color_Component_Array)
+with Pre =>
+ Data <= Get_Data_Count (This) and
+ Position <= Get_Data_Size (This) and
+ Values'Length <= Get_Data_Size (This) - Position + 1;
+</pre></td>
</tr>
<tr>
@@ -142,7 +250,8 @@ procedure Desaturate
<tr>
<td><pre>
-virtual void draw(int X, int Y, int W, int H, int cx=0, int cy=0);
+virtual void draw(int X, int Y, int W, int H,
+ int cx=0, int cy=0);
</pre></td>
<td><pre>
procedure Draw
@@ -210,48 +319,35 @@ procedure Inactive
<td><pre>
virtual void label(Fl_Widget *w);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void label(Fl_Menu_Item *m);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
int ld() const;
</pre></td>
-<td>&nbsp;</td>
- </tr>
-
- <tr>
-<td><pre>
-static void RGB_scaling(Fl_RGB_Scaling);
-</pre></td>
<td><pre>
-procedure Set_Copy_Algorithm
- (To : in Scaling_Kind);
+function Get_Line_Data
+ (This : in Image)
+ return Natural;
</pre></td>
</tr>
<tr>
<td><pre>
-static Fl_RGB_Scaling RGB_scaling();
-</pre></td>
-<td><pre>
-function Get_Copy_Algorithm
- return Scaling_Kind;
+virtual void uncache();
</pre></td>
- </tr>
-
- <tr>
<td><pre>
-virtual void uncache();
+procedure Uncache
+ (This : in out Image);
</pre></td>
-<td>&nbsp;</td>
</tr>
<tr>
diff --git a/doc/fl_jpeg_image.html b/doc/fl_jpeg_image.html
index a3f42f6..0bc768d 100644
--- a/doc/fl_jpeg_image.html
+++ b/doc/fl_jpeg_image.html
@@ -64,7 +64,12 @@ function Create
<td><pre>
Fl_JPEG_Image(const char *name, const unsigned char *data);
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Create
+ (Name : in String := "";
+ Data : in Color_Component_Array)
+ return JPEG_Image;
+</pre></td>
</tr>
</table>
diff --git a/doc/fl_pixmap.html b/doc/fl_pixmap.html
index 50c8cb8..81d3cc5 100644
--- a/doc/fl_pixmap.html
+++ b/doc/fl_pixmap.html
@@ -131,21 +131,24 @@ procedure Draw
<td><pre>
virtual void label(Fl_Widget *w);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void label(Fl_Menu_Item *m);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void uncache();
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+procedure Uncache
+ (This : in out Pixmap);
+</pre></td>
</tr>
</table>
diff --git a/doc/fl_png_image.html b/doc/fl_png_image.html
index c064ffe..7905098 100644
--- a/doc/fl_png_image.html
+++ b/doc/fl_png_image.html
@@ -62,9 +62,15 @@ function Create
<tr>
<td><pre>
-Fl_PNG_Image(const char *name, const unsigned char *buffer, int datasize);
+Fl_PNG_Image(const char *name, const unsigned char *buffer,
+ int datasize);
+</pre></td>
+<td><pre>
+function Create
+ (Name : in String := "";
+ Data : in Color_Component_Array)
+ return PNG_Image;
</pre></td>
-<td>&nbsp;</td>
</tr>
</table>
diff --git a/doc/fl_rgb_image.html b/doc/fl_rgb_image.html
index 3ab1b01..f85686e 100644
--- a/doc/fl_rgb_image.html
+++ b/doc/fl_rgb_image.html
@@ -47,20 +47,59 @@
<table class="function">
+ <tr><th colspan="2">Static Functions and Procedures</th></tr>
+
+ <tr>
+<td><pre>
+static void max_size(size_t size);
+</pre></td>
+<td><pre>
+procedure Set_Max_Size
+ (Value : in Natural);
+</pre></td>
+ </tr>
+
+ <tr>
+<td><pre>
+static size_t max_size();
+</pre></td>
+<td><pre>
+function Get_Max_Size
+ return Natural;
+</pre></td>
+ </tr>
+
+</table>
+
+
+
+<table class="function">
<tr><th colspan="2">Functions and Procedures</th></tr>
<tr>
<td><pre>
Fl_RGB_Image(const uchar *bits, int W, int H, int D=3, int LD=0);
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Create
+ (Data : in Color_Component_Array;
+ Width, Height : in Natural;
+ Depth : in Natural := 3;
+ Line_Data : in Natural := 0)
+ return RGB_Image;
+</pre></td>
</tr>
<tr>
<td><pre>
Fl_RGB_Image(const Fl_Pixmap *pxm, Fl_Color bg=FL_GRAY);
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Create
+ (Data : in FLTK.Images.Pixmaps.Pixmap;
+ Background : in Color := Background_Color)
+ return RGB_Image;
+</pre></td>
</tr>
<tr>
@@ -135,35 +174,24 @@ procedure Draw
<td><pre>
virtual void label(Fl_Widget *w);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
virtual void label(Fl_Menu_Item *m);
</pre></td>
-<td>&nbsp;</td>
+<td>Not applicable as the original is marked as obsolete</td>
</tr>
<tr>
<td><pre>
-static void max_size(size_t size);
-</pre></td>
-<td>&nbsp;</td>
- </tr>
-
- <tr>
-<td><pre>
-static size_t max_size();
+virtual void uncache();
</pre></td>
-<td>&nbsp;</td>
- </tr>
-
- <tr>
<td><pre>
-virtual void uncache();
+procedure Uncache
+ (This : in out RGB_Image);
</pre></td>
-<td>&nbsp;</td>
</tr>
</table>
diff --git a/doc/fl_shared_image.html b/doc/fl_shared_image.html
index 1dd8943..0c43ff7 100644
--- a/doc/fl_shared_image.html
+++ b/doc/fl_shared_image.html
@@ -47,31 +47,93 @@
<table class="function">
- <tr><th colspan="2">Functions and Procedures</th></tr>
+ <tr><th colspan="2">Static Functions and Procedures</th></tr>
<tr>
<td><pre>
-Fl_Shared_Image();
+static void add_handler(Fl_Shared_Handler f);
</pre></td>
-<td>&nbsp;</td>
+<td>Documentation lacking, claims to be a test function yet used for adding extra formats?</td>
</tr>
<tr>
<td><pre>
-Fl_Shared_Image(const char *n, Fl_Image *img=0);
+static Fl_Shared_Image * find(const char *name, int W=0, int H=0);
+</pre></td>
+<td><pre>
+function Find
+ (Name : in String;
+ W, H : in Integer := 0)
+ return Shared_Image;
</pre></td>
-<td>&nbsp;</td>
</tr>
<tr>
<td><pre>
-static void add_handler(Fl_Shared_Handler f);
+static Fl_Shared_Image * get(const char *name, int W=0, int H=0);
+</pre></td>
+<td><pre>
+function Create
+ (Filename : in String;
+ W, H : in Integer)
+ return Shared_Image;
+</pre></td>
+ </tr>
+
+ <tr>
+<td><pre>
+static Fl_Shared_Image * get(Fl_RGB_Image *rgb, int own_it=1);
+</pre></td>
+<td><pre>
+function Create
+ (From : in FLTK.Images.RGB.RGB_Image'Class)
+ return Shared_Image;
+</pre></td>
+ </tr>
+
+ <tr>
+<td><pre>
+static Fl_Shared_Image ** images();
</pre></td>
<td>&nbsp;</td>
</tr>
<tr>
<td><pre>
+static int num_images();
+</pre></td>
+<td><pre>
+function Number_Of_Images
+ return Natural;
+</pre></td>
+ </tr>
+
+ <tr>
+<td><pre>
+static void remove_handler(Fl_Shared_Handler f);
+</pre></td>
+<td>Documentation lacking, claims to be a test function yet used for adding extra formats?</td>
+ </tr>
+
+ <tr>
+<td><pre>
+static void scaling_algorithm(Fl_RGB_Scaling algorithm);
+</pre></td>
+<td><pre>
+procedure Set_Scaling_Algorithm
+ (To : in Scaling_Kind);
+</pre></td>
+ </tr>
+
+</table>
+
+
+
+<table class="function">
+ <tr><th colspan="2">Functions and Procedures</th></tr>
+
+ <tr>
+<td><pre>
virtual void color_average(Fl_Color c, float i);
</pre></td>
<td><pre>
@@ -140,48 +202,6 @@ procedure Draw
<tr>
<td><pre>
-static Fl_Shared_Image * find(const char *name, int W=0, int H=0);
-</pre></td>
-<td><pre>
-function Find
- (Name : in String;
- W, H : in Integer := 0)
- return Shared_Image;
-</pre></td>
- </tr>
-
- <tr>
-<td><pre>
-static Fl_Shared_Image * get(const char *name, int W=0, int H=0);
-</pre></td>
-<td><pre>
-function Create
- (Filename : in String;
- W, H : in Integer)
- return Shared_Image;
-</pre></td>
- </tr>
-
- <tr>
-<td><pre>
-static Fl_Shared_Image * get(Fl_RGB_Image *rgb, int own_it=1);
-</pre></td>
-<td><pre>
-function Create
- (From : in FLTK.Images.RGB.RGB_Image'Class)
- return Shared_Image;
-</pre></td>
- </tr>
-
- <tr>
-<td><pre>
-static Fl_Shared_Image ** images();
-</pre></td>
-<td>&nbsp;</td>
- </tr>
-
- <tr>
-<td><pre>
const char * name();
</pre></td>
<td><pre>
@@ -193,16 +213,24 @@ function Name
<tr>
<td><pre>
-static int num_images();
+int original();
+</pre></td>
+<td><pre>
+function Original
+ (This : in Shared_Image)
+ return Boolean;
</pre></td>
-<td>&nbsp;</td>
</tr>
<tr>
<td><pre>
int refcount();
</pre></td>
-<td>&nbsp;</td>
+<td><pre>
+function Reference_Count
+ (This : in Shared_Image)
+ return Natural;
+</pre></td>
</tr>
<tr>
@@ -224,14 +252,8 @@ procedure Reload
<tr>
<td><pre>
-static void remove_handler(Fl_Shared_Handler f);
-</pre></td>
-<td>&nbsp;</td>
- </tr>
-
- <tr>
-<td><pre>
-void scale(int width, int height, int proportional=1, int can_expand=0);
+void scale(int width, int height,
+ int proportional=1, int can_expand=0);
</pre></td>
<td><pre>
procedure Scale
@@ -244,19 +266,12 @@ procedure Scale
<tr>
<td><pre>
-static void scaling_algorithm(Fl_RGB_Scaling algorithm);
-</pre></td>
-<td><pre>
-procedure Set_Scaling_Algorithm
- (To : in Scaling_Kind);
+virtual void uncache();
</pre></td>
- </tr>
-
- <tr>
<td><pre>
-virtual void uncache();
+procedure Uncache
+ (This : in out Shared_Image);
</pre></td>
-<td>&nbsp;</td>
</tr>
</table>