diff options
author | Graeme Geldenhuys <graemeg@gmail.com> | 2015-02-22 13:20:29 +0000 |
---|---|---|
committer | Graeme Geldenhuys <graemeg@gmail.com> | 2015-02-22 13:20:29 +0000 |
commit | 8656c7f6a92113c6d5e224aef5e1e59f1c97140b (patch) | |
tree | 86ba28a180c215b7c6f2ce54c57f9beab91ac523 /docs | |
parent | f0fa04c7db10ba28667df8a3a222b4089090a3fc (diff) | |
download | fpGUI-8656c7f6a92113c6d5e224aef5e1e59f1c97140b.tar.xz |
docs: TfpgImageBase
Diffstat (limited to 'docs')
-rw-r--r-- | docs/xml/corelib/fpg_base.xml | 31 |
1 files changed, 26 insertions, 5 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index 30fbbc4f..5cd3a598 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -764,11 +764,32 @@ you must keep copy of the original image before you call <var>Invert</var>.</des <descr/> </element> - <!-- procedure Visibility: public --> - <element name="TfpgImageBase.UpdateImage"> - <short>Updates the internal image resources and OS resources from image data</short> - <descr/> - </element> +<element name="TfpgImageBase.UpdateImage"> +<short>Updates the internal image resources and OS resources from image data</short> +<descr><printshort id="TfpgImageBase.UpdateImage"/>. This method must always be called <b>after</b> +you populated the <var>ImageData</var> array. Then only does it allocate OS resources.</descr> +<seealso> + <link id="TfpgImageBase.ImageData"/> +</seealso> +</element> + +<element name="TfpgImageBase.ImageData"> +<short>Internal representation of color data of the image</short> +<descr><printshort id="TfpgImageBase.ImageData"/>. This method gives you a pointer to the image date +which is always in the format ARGB. If you update the internal data you <b>always</b> need to call +<var>UpdateImage</var> afterwards.</descr> +<seealso> + <link id="TfpgImageBase.UpdateImage"/> +</seealso> +</element> + +<element name="TfpgImageBase.ImageDataSize"> +<short>Tells you the size of the image data</short> +<descr><printshort id="TfpgImageBase.ImageDataSize"/>. You would need this if you work directly with +the ImageData values.</descr> +</element> + + <!-- property Visibility: public --> <element name="TfpgImageBase.Width"> |