summaryrefslogtreecommitdiff
path: root/doc/fl_image.html
diff options
context:
space:
mode:
authorJedidiah Barber <contact@jedbarber.id.au>2024-02-20 18:04:23 +1300
committerJedidiah Barber <contact@jedbarber.id.au>2024-02-20 18:04:23 +1300
commitf18ea4474bb4905a00e0b39e7205c177ee994196 (patch)
tree67a06833192e0f47695ab872badb88fb0970280a /doc/fl_image.html
parentc47bea48a24e51e178354f3e3bb53d8b9964b769 (diff)
Improved binding for the FLTK.Images package subtree
Diffstat (limited to 'doc/fl_image.html')
-rw-r--r--doc/fl_image.html142
1 files changed, 119 insertions, 23 deletions
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>