diff options
Diffstat (limited to 'doc/fl_rgb_image.html')
| -rw-r--r-- | doc/fl_rgb_image.html | 149 |
1 files changed, 124 insertions, 25 deletions
diff --git a/doc/fl_rgb_image.html b/doc/fl_rgb_image.html index 95ee4e0..6d5427d 100644 --- a/doc/fl_rgb_image.html +++ b/doc/fl_rgb_image.html @@ -1,4 +1,3 @@ - <!DOCTYPE html> <html lang="en"> @@ -14,6 +13,9 @@ <h2>Fl_RGB_Image Binding Map</h2> +<a href="index.html">Back to Index</a> + + <table class="package"> <tr><th colspan="2">Package name</th></tr> @@ -44,22 +46,129 @@ <table class="function"> - <tr><th colspan="2">Functions and Procedures</th></tr> + <tr><th colspan="2">Attributes</th></tr> <tr> <td><pre> -Fl_RGB_Image(const uchar *bits, int W, int H, int D=3, int LD=0); +int alloc_array; +</pre></td> +<td>Intentionally left unbound.</td> + </tr> + + <tr> +<td><pre> +const uchar * array; +</pre></td> +<td><pre> +function Data_Size + (This : in RGB_Image) + return Size_Type; + +function Get_Datum + (This : in RGB_Image; + Place : in Positive_Size) + return Color_Component +with Pre => Place <= This.Data_Size; + +procedure Set_Datum + (This : in out RGB_Image; + Place : in Positive_Size; + Value : in Color_Component) +with Pre => Place <= This.Data_Size; + +function Slice + (This : in RGB_Image; + Low : in Positive_Size; + High : in Size_Type) + return Color_Component_Array +with Pre => High <= This.Data_Size, + Post => Slice'Result'Length = Size_Type'Max (0, High - Low + 1); + +procedure Overwrite + (This : in out RGB_Image; + Place : in Positive_Size; + Values : in Color_Component_Array) +with Pre => Place + Values'Length - 1 <= This.Data_Size; + +function All_Data + (This : in RGB_Image) + return Color_Component_Array +with Post => All_Data'Result'Length = This.Data_Size; +</pre></td> + </tr> + +</table> + + + +<table class="function"> + <tr><th colspan="2">Constructors</th></tr> + + <tr> +<td><pre> +Fl_RGB_Image(const uchar *bits, int W, int H, + int D=3, int LD=0); +</pre></td> +<td><pre> +function Create + (Data : in Color_Component_Array; + Width, Height : in Natural; + Depth : in Natural := 3; + Line_Size : in Natural := 0) + return RGB_Image +with Pre => (if Line_Size = 0 + then Data'Length >= Size_Type (Width) * Size_Type (Height) * Size_Type (Depth) + else Data'Length >= Size_Type (Line_Size) * Size_Type (Height)) + and Data'Length <= Get_Max_Size; </pre></td> -<td> </td> </tr> <tr> <td><pre> Fl_RGB_Image(const Fl_Pixmap *pxm, Fl_Color bg=FL_GRAY); </pre></td> -<td> </td> +<td><pre> +function Create + (Data : in FLTK.Images.Pixmaps.Pixmap; + Background : in Color := Background_Color) + return RGB_Image; +</pre></td> </tr> +</table> + + + +<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 Size_Type); +</pre></td> + </tr> + + <tr> +<td><pre> +static size_t max_size(); +</pre></td> +<td><pre> +function Get_Max_Size + return Size_Type; +</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); @@ -107,13 +216,14 @@ 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 - (This : in RGB_Image; - X, Y, W, H : in Integer; - CX, CY : in Integer := 0); + (This : in RGB_Image; + X, Y, W, H : in Integer; + Clip_X, Clip_Y : in Integer := 0); </pre></td> </tr> @@ -132,35 +242,24 @@ procedure Draw <td><pre> virtual void label(Fl_Widget *w); </pre></td> -<td> </td> +<td>Marked as obsolete.</td> </tr> <tr> <td><pre> virtual void label(Fl_Menu_Item *m); </pre></td> -<td> </td> +<td>Marked as obsolete.</td> </tr> <tr> <td><pre> -static void max_size(size_t size); -</pre></td> -<td> </td> - </tr> - - <tr> -<td><pre> -static size_t max_size(); +virtual void uncache(); </pre></td> -<td> </td> - </tr> - - <tr> <td><pre> -virtual void uncache(); +procedure Uncache + (This : in out RGB_Image); </pre></td> -<td> </td> </tr> </table> |