The Ecere SDK - sdk/blob - doc/ecere/ecere/gfx/BitmapResource.econ

   1 {
   2    name = "BitmapResource",
   3    description = "A class to automatically manag loading and unloading Bitmap objects",
   4    usage = "Originally defined in the declaration section of code, typically within the class that will be using this resource.",
   5    example = "class Form1 : Window<br>{<br>   text = \"Form1\";<br>   background = activeBorder;<br>   borderStyle = fixed;<br>   hasClose = true;<br>   size = {640, 480};<br>   BitmapResource image { \":image.png\", window = this };<br>   void OnRedraw(Surface surface)<br>   {<br>      surface.Blit( image.bitmap, 0, 0, 0, 0, 20, 20 );<br>   }<br>}",
   6    remarks = "Very similar to the Bitmap class. In fact Bitmap could be said to be low level, while BitmapResource could be said to be a high level object.",
   7    also = "Bitmap, BitmapFormat",
   8    properties = [
   9       {
  10          "alphaBlend",
  11          {
  12             description = "When true, the alpha layer of the image is processed."
  13          }
  14       },
  15       {
  16          "bitmap",
  17          {
  18             description = "The actual bitmap to display. This is used when actually blitting the image to the screen."
  19          }
  20       },
  21       {
  22          "fileName",
  23          {
  24             description = "The filename of the bitmap to load. To specify that the file is to be loaded from the executables resources, precede the filename with a colon. ie: \":Tiles.png\""
  25          }
  26       },
  27       {
  28          "grayed",
  29          {
  30             description = "When true, the \"grayed\" filter is applied, so that the bitmap is stored similar to a grayed out control or button. Default is false."
  31          }
  32       },
  33       {
  34          "keepData",
  35          {
  36             description = "When true, the original data of the image is not changed in memory."
  37          }
  38       },
  39       {
  40          "monochrome",
  41          {
  42             description = "When true, the bitmap is stored with only two colors. Default is false."
  43          }
  44       },
  45       {
  46          "transparent",
  47          {
  48             description = "When true, any transparent background of the image is maintained and therefore when the image is rendered to the screen, it will have transparent areas. When false, the contents of the transparent areas may be surprising. Default is true."
  49          }
  50       },
  51       {
  52          "window",
  53          {
  54             description = "The Window class that this object belongs to."
  55          }
  56       }
  57    ]
  58 }