summaryrefslogtreecommitdiff
path: root/docs/xml/corelib/fpg_imgfmt_bmp.xml
blob: aad03cc20c43415a46721961f0a04663d74a68df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fpGUI">

<module name="fpg_imgfmt_bmp">
<short>BMP image reader implementation</short>
<descr><p>This unit implements a BMP (Bitmap) image reader.</p></descr>

<!-- procedure Visibility: default -->
<element name="ReadImage_BMP">
<short>Reads the internal structure of the BMP file.</short>
</element>

<!-- function Visibility: default -->
<element name="LoadImage_BMP">
<short>Load's the image from the file specified.</short>
<descr><p>This functions loads the BMP image from the file specified and returns
a <link id="fpg_main.TfpgImage">TfpgImage</link> object representing the BMP file.</p></descr>
</element>

<!-- function result Visibility: default -->
<element name="LoadImage_BMP.Result">
<short>The TfpgImage represeting the BMP file.</short>
</element>

<!-- argument Visibility: default -->
<element name="LoadImage_BMP.AFileName">
<short>The file name on disk containing the BMP data.</short>
</element>

<!-- function Visibility: default -->
<element name="CreateImage_BMP">
<short>Creates a <link id="fpg_main.TfpgImage">TfpgImage</link> representing a BMP file from data in memory.</short>
<descr><printshort id="CreateImage_BMP"/>.
</descr>
</element>

<!-- argument Visibility: default -->
<element name="CreateImage_BMP.bmp">
<short>Pointer to BMP data in memory.</short>
</element>

<!-- argument Visibility: default -->
<element name="CreateImage_BMP.bmpsize">
<short>Size of the data in memory to read.</short>
</element>

</module>

</package>
</fpdoc-descriptions>