workbench/hidds/graphics/bitmap.doc

   1
   2
   3 BitMap interface
   4 ================
   5
   6 Attributes:
   7 ----------
   8
   9 NAME
  10     aHidd_BitMap_Width, ULONG, IG
  11
  12 FUNCTION
  13     Create a bitmap with this width
  14     or query the width. Note that most HIDD don't support to resize a bitmap.
  15     The width is in HIDD units. Some graphics HIDDs support text mode, then
  16     this is in characters. But most of the time, this will be in screen or
  17     printer pixels. Specifies width of bitmap to create.
  18
  19 NOTES
  20
  21 EXAMPLE
  22
  23 BUGS
  24
  25 SEE ALSO
  26     aHidd_BitMap_Height
  27
  28 INTERNALS
  29
  30 HISTORY
  31
  32 /*************************/
  33 NAME
  34     aHidd_BitMap_Height, ULONG, IG
  35
  36 FUNCTION
  37     Create a bitmap with this height
  38     or query the height. Note that most HIDD don't support to resize a bitmap.
  39     The height is in HIDD units. Some graphics HIDDs support text mode, then
  40     this is in characters. But most of the time, this will be in screen or
  41     printer pixels.
  42
  43 NOTES
  44
  45 EXAMPLE
  46
  47 BUGS
  48
  49 SEE ALSO
  50     aHidd_BitMap_Width
  51
  52 INTERNALS
  53
  54 HISTORY
  55
  56 /*************************/
  57 NAME
  58     aHidd_BitMap_Depth, UBYTE, IG
  59
  60 FUNCTION
  61     Create a bitmap with this depth. When
  62     the bitmap has been created, you can query the attribute. The number of
  63     distinct colors is |1L << depth|. Most HIDDs will support depths like 1, 8,
  64     15, 16, 24 and 32 bit.
  65 NOTES
  66
  67 EXAMPLE
  68
  69 BUGS
  70
  71 SEE ALSO
  72
  73 INTERNALS
  74
  75 HISTORY
  76
  77 /*************************/
  78 NAME
  79     aHidd_BitMap_Displayable, BOOL, IG
  80
  81 FUNCTION
  82     Create a bitmap which should later
  83     be displayed. When the bitmap has been created, you can query the
  84     attribute. On some systems, this will also display the bitmap when
  85     the method returns. To be safe, always call |HIDDV_Graphics_Cmd_ShowBitmap()|
  86     afterwards.
  87
  88 NOTES
  89
  90 EXAMPLE
  91
  92 BUGS
  93
  94 SEE ALSO
  95
  96 INTERNALS
  97
  98 HISTORY
  99
 100 /*************************/
 101 NAME
 102     aHidd_BitMap_Format, ULONG, G
 103
 104 FUNCTION
 105     Tell the format of the data in the bitmap.
 106
 107 NOTES
 108
 109 EXAMPLE
 110
 111 BUGS
 112
 113 SEE ALSO
 114
 115 INTERNALS
 116
 117 HISTORY
 118
 119 /*************************/
 120 NAME
 121     aHidd_BitMap_BitMap, UBYTE *, G
 122
 123 FUNCTION
 124     User can get a pointer directly to the internally used bitmap
 125     by getting this attribute.
 126
 127 NOTES
 128
 129 EXAMPLE
 130
 131 BUGS
 132
 133 SEE ALSO
 134     aHidd_BitMap_Format
 135
 136 INTERNALS
 137
 138 HISTORY
 139
 140 /*************************/
 141 NAME
 142
 143 SYNOPSIS
 144
 145 FUNCTION
 146
 147 INPUTS
 148
 149 RESULT
 150
 151 NOTES
 152
 153 EXAMPLE
 154
 155 BUGS
 156
 157 SEE ALSO
 158
 159 INTERNALS
 160
 161 HISTORY