documentation: Breaking the API Reference documentation ice
[sdk] / doc / ecere / ecere / gfx / Bitmap.econ
1 {
2    name = "Bitmap",
3    description = "Class reprsenting a rasterized 2D image in a number of formats. Once made device-dependent, the data is stored as a texture on the GPU for hardware- accelerated drivers.",
4    fields = [
5       {
6          "height",
7          {
8             description = "The Height in pixels of the image."
9          }
10       },
11       {
12          "pixelFormat",
13          {
14             description = "The format of the color encoding for the pixels of this image."
15          }
16       },
17       {
18          "size",
19          {
20             description = "The exact size of the image."
21          }
22       },
23       {
24          "sizeBytes",
25          {
26             description = "The size of the image in bytes."
27          }
28       },
29       {
30          "transparent",
31          {
32             description = "When true, the transparency layer of the image is recognized. When the image is later blitted to the screen the transparent regions of the image are not drawn."
33          }
34       },
35       {
36          "width",
37          {
38             description = "The Width in pixels of the image."
39          }
40       }
41    ],
42    methods = [
43       {
44          "Load",
45          {
46             description = "Load the bitmap file from the included resources."
47          }
48       }
49    ]
50 }