/docs/xml/fcl/fpimage.xml
XML | 376 lines | 376 code | 0 blank | 0 comment | 0 complexity | 24bbabfaa1f0236e252a50e37e698763 MD5 | raw file
1<?xml version="1.0"?> 2<fpdoc-descriptions> 3 <package name="fcl"> 4 <module name="FPImage"> 5 <element name="TFPMemoryImage"> 6 <short> 7 <var>TFPMemoryImage</var> - FreePascal base class for an image held in memory</short> 8 </element> 9 <element name="TFPPalette"> 10 <short> 11 <var>TFPPalette</var> - FreePascal Palette definition: base for LCL TPalette etc</short> 12 </element> 13 <element name="TFPCustomImage"> 14 <short> 15 <var>TFPCustomImage</var> - FreePascal base definition for all Image classes</short> 16 </element> 17 <element name="TFPMemoryImage"/> 18 <element name="TFPCustomImageHandler"> 19 <short> 20 <var>TFPCustomImageHandler</var> FreePascal base class for handling images</short> 21 </element> 22 <element name="TFPCustomImageReader"> 23 <short> 24 <var>TFPCustomImageReader</var> - FreePascal base class for Image reading</short> 25 </element> 26 <element name="TFPCustomImageWriter"> 27 <short> 28 <var>TFPCustomImageWriter</var> - FreePascal base class for writing image data</short> 29 </element> 30 <element name="TFPPalette.FData"> 31 <short> 32 <var>FData</var> - local variable to hold data as a Colour Array</short> 33 </element> 34 <element name="TFPPalette.FCount"> 35 <short> 36 <var>FCount</var> - local variable to hold number of colours in array</short> 37 </element> 38 <element name="TFPPalette.FCapacity"> 39 <short> 40 <var>FCapacity</var> - local variable to hold total capacity of array</short> 41 </element> 42 <element name="TFPPalette.SetCount"> 43 <short> 44 <var>SetCount</var> - specify the number of colours in the palette</short> 45 </element> 46 <element name="TFPPalette.GetCount"> 47 <short> 48 <var>GetCount</var> - returns the number of colours in the palette</short> 49 </element> 50 <element name="TFPPalette.SetColor"> 51 <short> 52 <var>SetColor</var> - specifies the value of colour to be associated with the specified index</short> 53 </element> 54 <element name="TFPPalette.GetColor"> 55 <short> 56 <var>GetColor</var> - returns the colour value for the specified index</short> 57 </element> 58 <element name="TFPPalette.CheckIndex"> 59 <short> 60 <var>CheckIndex</var> - checks validity of supplied index</short> 61 </element> 62 <element name="TFPPalette.EnlargeData"> 63 <short> 64 <var>EnlargeData</var> - makes room in the array for more data</short> 65 </element> 66 <element name="TFPPalette.Create"> 67 <short> 68 <var>Create</var> - constructor for <var>TFPPalette</var>: calls inherited <var>Create</var> then finds how much memory to allocate for the specified number of colours</short> 69 <seealso> 70 <link id="#rtl.System.TObject.Create">TObject.Create</link> 71 </seealso> 72 </element> 73 <element name="TFPPalette.Destroy"> 74 <short> 75 <var>Destroy</var> - destructor for <var>TFPPalette</var>: frees memory then calls inherited <var>Destroy</var> 76 </short> 77 <seealso> 78 <link id="#rtl.System.TObject.Destroy">TObject.Destroy</link> 79 </seealso> 80 </element> 81 <element name="TFPPalette.Build"> 82 <short> 83 <var>Build</var> an Image</short> 84 </element> 85 <element name="TFPPalette.Copy"> 86 <short> 87 <var>Copy</var> from the source (<var>APalette</var>) to the current Palette</short> 88 </element> 89 <element name="TFPPalette.Merge"> 90 <short> 91 <var>Merge</var> the contents of another palette (<var>pal</var>) with the current palette</short> 92 </element> 93 <element name="TFPPalette.IndexOf"> 94 <short> 95 <var>IndexOf</var> - returns the index value for the specified colour</short> 96 </element> 97 <element name="TFPPalette.Add"> 98 <short> 99 <var>Add</var> the specified colour to the palette and return the number of entries</short> 100 </element> 101 <element name="TFPPalette.Clear"> 102 <short> 103 <var>Clear</var> - empties the palette</short> 104 </element> 105 <element name="TFPPalette.Color"> 106 <short>The current <var>Color</var> from the palette</short> 107 </element> 108 <element name="TFPPalette.Count"> 109 <short> 110 <var>Count</var> - the total number of entries for colours in the palette</short> 111 </element> 112 <element name="TFPCustomImage.SetInternalColor"> 113 <short> 114 <var>SetInternalColor</var> - specify the internal colour (using TFPColor format)</short> 115 </element> 116 <element name="TFPCustomImage.GetInternalColor"> 117 <short> 118 <var>GetInternalColor</var> - finds the internal colour from local store</short> 119 </element> 120 <element name="TFPCustomImage.SetInternalPixel"> 121 <short> 122 <var>SetInternalPixel</var> - specifies the integer Color of a pixel located at the given coordinates</short> 123 </element> 124 <element name="TFPCustomImage.GetInternalPixel"> 125 <short> 126 <var>GetInternalPixel</var> - returns the integer Color of the specified pixel</short> 127 </element> 128 <element name="TFPCustomImage.SetUsePalette"> 129 <short> 130 <var>SetUsePalette</var> - specifies whether a palette is to be used in painting the Image</short> 131 </element> 132 <element name="TFPCustomImage.Progress"> 133 <short> 134 <var>Progress</var> - method for displaying the progress of a drawing or painting action</short> 135 <descr> 136 <p> 137 <var>Progress</var> - method for displaying the progress of a drawing or painting action</p> 138 <p>Sender: calling routine</p> 139 <p>Stage: Starting, Running or Ending</p> 140 <p>PercentDone: how much has been accomplished</p> 141 <p>RedrawNow: whether to refresh the Image</p> 142 <p>R: the rectangle in which drawing progress is being monitored</p> 143 <p>Msg: a message to show in the progress display</p> 144 <p>Continue: whether to keep on drawing</p> 145 </descr> 146 </element> 147 <element name="TFPCustomImage.create"> 148 <short> 149 <var>Create</var> - constructor for <var>TFPCustomImage</var>: calls inherited <var>Create</var> then initialises position and size, makes a stringlist</short> 150 <seealso> 151 <link id="#rtl.System.TObject.Create">TObject.Create</link> 152 </seealso> 153 </element> 154 <element name="TFPCustomImage.destroy"> 155 <short> 156 <var>Destroy</var> - destructor for <var>TFPCustomImage</var>: frees the Palette then calls inherited <var>Destroy</var> 157 </short> 158 <seealso> 159 <link id="#rtl.Classes.TPersistent.Destroy">TPersistent.Destroy</link> 160 </seealso> 161 </element> 162 <element name="TFPCustomImage.Assign" link="#rtl.Classes.TPersistent.Assign"/> 163 <element name="TFPCustomImage.LoadFromStream"> 164 <short> 165 <var>LoadFromStream</var> loads data from the specified stream, optionally using the specified reader</short> 166 </element> 167 <element name="TFPCustomImage.LoadFromFile"> 168 <short> 169 <var>LoadFromFile</var> - reads data from the specified file, optionally using the specified reader</short> 170 </element> 171 <element name="TFPCustomImage.SaveToStream"> 172 <short> 173 <var>SaveToStream</var> - writes the data to the specified stream, using the specified writer</short> 174 </element> 175 <element name="TFPCustomImage.SaveToFile"> 176 <short> 177 <var>SaveToFile</var> - writes image data to the specifed file, using the specified writer</short> 178 </element> 179 <element name="TFPCustomImage.SetSize"> 180 <short> 181 <var>SetSize</var> - specify the size of the Image</short> 182 </element> 183 <element name="TFPCustomImage.Height"> 184 <short>The <var>Height</var> of the image</short> 185 </element> 186 <element name="TFPCustomImage.Width"> 187 <short>The <var>Width</var> of the image</short> 188 </element> 189 <element name="TFPCustomImage.Colors"> 190 <short>The <var>Colors</var> to be used at the nominated position</short> 191 </element> 192 <element name="TFPCustomImage.UsePalette"> 193 <short> 194 <var>UsePalette</var> - Use of palette for colors</short> 195 </element> 196 <element name="TFPCustomImage.Palette"> 197 <short>The <var>Palette</var> to be used in painting the Image</short> 198 </element> 199 <element name="TFPCustomImage.Pixels"> 200 <short>The <var>Pixels</var> (integer value) found at the specified location</short> 201 </element> 202 <element name="TFPCustomImage.Extra"> 203 <short> 204 <var>Extra</var> - Info unrelated with the image representation</short> 205 </element> 206 <element name="TFPCustomImage.ExtraValue"> 207 <short> 208 <var>ExtraValue</var> - additional information stored with the image</short> 209 </element> 210 <element name="TFPCustomImage.ExtraKey"> 211 <short> 212 <var>ExtraKey</var> - an additional key stored with the image</short> 213 </element> 214 <element name="TFPCustomImage.RemoveExtra"> 215 <short> 216 <var>RemoveExtra</var> - ge rid of the ExtraKey</short> 217 </element> 218 <element name="TFPCustomImage.ExtraCount"> 219 <short> 220 <var>ExtraCount</var> - the number of additional (non-image) items stored with the Image</short> 221 </element> 222 <element name="TFPCustomImage.OnProgress"> 223 <short> 224 <var>OnProgress</var> - event handler for displaying progress of the painting process</short> 225 </element> 226 <element name="TFPCustomImageClass"> 227 <short> 228 <var>TFPCustomImageClass</var> - class of <var>TFPCustomImage</var> 229 </short> 230 </element> 231 <element name="PFPIntegerArray"> 232 <short> 233 <var>PFPIntegerArray</var> - pointer to an integer array</short> 234 </element> 235 <element name="TFPIntegerArray"> 236 <short> 237 <var>TFPIntegerArray</var> - definition of integer array for use in images</short> 238 </element> 239 <element name="TFPMemoryImage.SetInternalPixel" link="#fcl.FPimage.TFPCustomImage.SetInternalPixel"/> 240 <element name="TFPMemoryImage.GetInternalPixel" link="#fcl.FPimage.TFPCustomImage.GetInternalPixel"/> 241 <element name="TFPMemoryImage.create" link="#fcl.FPimage.TFPCustomImage.create"/> 242 <element name="TFPMemoryImage.destroy" link="#fcl.FPimage.TFPCustomImage.destroy"/> 243 <element name="TFPMemoryImage.SetSize" link="#fcl.FPimage.TFPCustomImage.SetSize"/> 244 <element name="TFPCustomImageHandler.Progress"> 245 <short> 246 <var>Progress</var> - method for displaying the progress of a drawing or painting action</short> 247 <descr> 248 <p> 249 <var>Progress</var> - method for displaying the progress of a drawing or painting action</p> 250 <p>Sender: calling routine</p> 251 <p>Stage: Starting, Running or Ending</p> 252 <p>PercentDone: how much has been accomplished</p> 253 <p>RedrawNow: whether to refresh the Image</p> 254 <p>R: the rectangle in which drawing progress is being monitored</p> 255 <p>Msg: a message to show in the progress display</p> 256 <p>Continue: whether to keep on drawing</p> 257 </descr> 258 </element> 259 <element name="TFPCustomImageHandler.TheStream"> 260 <short> 261 <var>TheStream</var> from or to which the image is being read or written</short> 262 </element> 263 <element name="TFPCustomImageHandler.TheImage"> 264 <short> 265 <var>TheImage</var> which is being read or written</short> 266 </element> 267 <element name="TFPCustomImageHandler.Create" link="#rtl.System.TObject.Create"/> 268 <element name="TFPCustomImageHandler.OnProgress"> 269 <short> 270 <var>OnProgress</var> event handler for showing progress of drawing or painting</short> 271 </element> 272 <element name="TFPCustomImageReader.InternalRead"> 273 <short> 274 <var>InternalRead</var> - read specified image from nominated stream</short> 275 </element> 276 <element name="TFPCustomImageReader.InternalCheck"> 277 <short> 278 <var>InternalCheck</var> - performs check on validity of stream, returns True if OK</short> 279 </element> 280 <element name="TFPCustomImageReader.Create" link="#rtl.System.TObject.Create"/> 281 <element name="TFPCustomImageReader.ImageRead"> 282 <short> 283 <var>ImageRead</var> read specified image from nominated stream; returns the image</short> 284 </element> 285 <element name="TFPCustomImageReader.CheckContents"> 286 <short> 287 <var>CheckContents</var> - Gives True if contents are readable</short> 288 </element> 289 <element name="TFPCustomImageReader.DefaultImageClass"> 290 <short> 291 <var>DefaultImageClass</var> - Image Class to create when no img is given for reading</short> 292 </element> 293 <element name="TFPCustomImageReaderClass"> 294 <short> 295 <var>TFPCustomImageReaderClass</var> - class of <var>TFPCustomImageReader</var> 296 </short> 297 </element> 298 <element name="TFPCustomImageWriter.InternalWrite"> 299 <short> 300 <var>InternalWrite</var> - write specified image to nominated stream</short> 301 </element> 302 <element name="TFPCustomImageWriter.ImageWrite"> 303 <short> 304 <var>ImageWrite</var> - writes given image to stream</short> 305 </element> 306 <element name="TFPCustomImageWriterClass"> 307 <short> 308 <var>TFPCustomImageWriterClass</var> - class of <var>TFPCustomImageWriter</var> 309 </short> 310 </element> 311 <element name="TIHData"> 312 <short> 313 <var>TIHData</var> - data for Image Handler</short> 314 </element> 315 <element name="TImageHandlersManager"> 316 <short> 317 <var>TImageHandlersManager</var> - class for managing image handlers</short> 318 </element> 319 <element name="TImageHandlersManager.Create"> 320 <short> 321 <var>Create</var> - constructor fro <var>TImageHandlersManager</var>: calls inherited <var>Create</var> then constructs list of handlers</short> 322 <seealso> 323 <link id="#rtl.System.TObject.Create">TObject.Create</link> 324 </seealso> 325 </element> 326 <element name="TImageHandlersManager.Destroy"> 327 <short> 328 <var>Destroy</var> - destructor for <var>TImageHandlersManager</var>: frees the list of handlers then calls inherited <var>Destroy</var> 329 </short> 330 <seealso> 331 <link id="#rtl.System.TObject.Destroy">TObject.Destroy</link> 332 </seealso> 333 </element> 334 <element name="TImageHandlersManager.RegisterImageHandlers"> 335 <short> 336 <var>RegisterImageHandlers</var> - method for registering Image Handlers</short> 337 </element> 338 <element name="TImageHandlersManager.RegisterImageReader"> 339 <short> 340 <var>RegisterImageReader</var> - method to register an Image Reader</short> 341 </element> 342 <element name="TImageHandlersManager.RegisterImageWriter"> 343 <short> 344 <var>RegisterImageWriter</var> - method to register an Image Writer</short> 345 </element> 346 <element name="TImageHandlersManager.Count"> 347 <short> 348 <var>Count</var> - the number of Image Handlers</short> 349 </element> 350 <element name="TImageHandlersManager.ImageReader"> 351 <short>The <var>ImageReader</var> being used</short> 352 </element> 353 <element name="TImageHandlersManager.ImageWriter"> 354 <short>The <var>ImageWriter</var> being used</short> 355 </element> 356 <element name="TImageHandlersManager.Extentions"> 357 <short>The filename <var>Extentions</var> for the image handlers</short> 358 </element> 359 <element name="TImageHandlersManager.DefaultExtention"> 360 <short>The <var>DefaultExtention</var> to be used if no extention is supplied</short> 361 </element> 362 <element name="TImageHandlersManager.TypeNames"> 363 <short>A list of <var>TypeNames</var> to be used with the handler files</short> 364 </element> 365 <element name="TFPColor"> 366 <short> 367 <var>TFPColor</var> - record type used as an internal representation for a colour: a <var>TColor</var> has been decomposed into its component Red, Green, Blue and Alpha parts, to allow easy manipulation of each</short> 368 </element> 369 <element name="PFPColor"> 370 <short> 371 <var>PFPColor</var> - pointer to a <var>TFPColor</var> 372 </short> 373 </element> 374 </module> 375 </package> 376</fpdoc-descriptions>