autodoc.git/
autodoc.xml
Branch:
Tag:
Non-build tags
All tags
No tags
1999-03-22
1999-03-22 14:35:25 by Mirar (Pontus Hagland) <pike@sort.mirar.org>
120ee660ade87a5a985952566276c778f8275db2 (
65
lines) (+
65
/-
0
)
[
Show
|
Annotate
]
Branch:
8.0
oops, forgot this one. :)
Rev: src/modules/Image/encodings/bmp.c:1.1
2201:
</doc> </module>
+
<module name='BMP'>
+
<doc>
+
<text>
+
<p>
+
This submodule keeps the BMP (Windows Bitmap)
+
encode/decode capabilities of the <ref resolved='predef::Image'>Image</ref> module.</p>
+
+
<p>BMP is common in the Windows environment.</p>
+
+
<p>Simple encoding:<br/>
+
<ref resolved='predef::Image.BMP.encode'>encode</ref></p>
+
+
<p>Advanced encoding:<br/>
+
<ref>encode_P1</ref>, <br/>
+
<ref>encode_P2</ref>, <br/>
+
<ref>encode_P3</ref>, <br/>
+
<ref>encode_P4</ref>, <br/>
+
<ref>encode_P5</ref>, <br/>
+
<ref>encode_P6</ref>
+
</p>
+
</text>
+
<group><seealso/><text>
+
<p><ref resolved='predef::Image'>Image</ref>, <ref resolved='predef::Image.image'>Image.image</ref>, <ref resolved='predef::Image.colortable'>Image.colortable</ref></p></text></group>
+
+
</doc>
+
<docgroup homogen-name='encode' homogen-type='method'>
+
<method name='encode'>
+
<returntype>
+
<object>string </object></returntype>
+
<arguments><argument name='image'><type><object resolved='predef::Image.BMP.encode'/></type></argument>
+
+
</arguments>
+
</method><method name='encode'>
+
<returntype>
+
<object>string </object></returntype>
+
<arguments><argument name='image'><type><object resolved='predef::Image.BMP.encode'/></type></argument>
+
<argument name='colortable'><type><object resolved='predef::Image.BMP.encode'/></type></argument>
+
+
</arguments>
+
</method><doc>
+
<text>
+
<p>Make a BMP. It default to a 24 bpp BMP file,
+
but if a colortable is given, it will be 8bpp
+
with a palette entry.
+
</p>
+
</text>
+
<group>
+
<param name='image'/>
+
<text><p>Source image.</p></text></group>
+
<group>
+
<param name='colortable'/>
+
<text><p>Colortable object.</p>
+
+
<p/></text></group>
+
<group><returns/><text>
+
<p>the encoded image as a string</p>
+
</text></group>
+
<group><bugs/><text>
+
<p>Doesn't support all BMP modes. At all.</p>
+
</text></group>
+
+
</doc>
+
</docgroup>
+
</module>
<module name='GIF'> <doc> <text>