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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
GraphType
====================================================================
-->
<module name="GraphType">
<short>Definitions of several special types (including Raw Image) to be used for graphics</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- range type Visibility: default -->
<element name="TGraphicsColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TGraphicsFillStyle">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsFillStyle.fsSurface">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsFillStyle.fsBorder">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TGraphicsBevelCut">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsBevelCut.bvNone">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsBevelCut.bvLowered">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsBevelCut.bvRaised">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TGraphicsBevelCut.bvSpace">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TRawImageColorFormat">
<short>A raw image can contain RGBA or monochrome pixels.</short>
<descr>ricfNone indicates an uninitialized image.</descr>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageColorFormat.ricfRGBA">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageColorFormat.ricfGray">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TRawImageByteOrder">
<short>The LSB/MSB-first byte order of pixel data.</short>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageByteOrder.riboLSBFirst">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageByteOrder.riboMSBFirst">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TRawImageBitOrder">
<short>The first pixel in a raw image line can be the left or right pixel of the displaye image.</short>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageBitOrder.riboBitsInOrder">
<short>Bit 0 represents first pixel</short>
<notes><note>?</note>
</notes>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageBitOrder.riboReversedBits">
<short>Bit 0 represents highest pixel</short>
<notes><note>?</note>
</notes>
</element>
<!-- enumeration type Visibility: default -->
<element name="TRawImageLineEnd">
<short>The alignment of raw image scanlines.</short>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineEnd.rileTight">
<short>Scanlines can begin inside a byte.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineEnd.rileByteBoundary">
<short>Scanlines start at a byte boundary.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineEnd.rileWordBoundary">
<short>Scanlines start at a 16 bit boundary.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineEnd.rileDWordBoundary">
<short>Scanlines start at a 32 bit (DWORD) boundary.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineEnd.rileQWordBoundary">
<short>Scanlines start at a 64 bit (QWORD) boundary.</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TRawImageLineOrder">
<short>The first stored line of pixels can represent the logical top or bottom of the displayed image.</short>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineOrder.riloTopToBottom">
<short>First scanline at the top</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TRawImageLineOrder.riloBottomToTop">
<short>First scanline at the bottom</short>
</element>
<!-- record type Visibility: default -->
<element name="TRawImageDescription">
<short>Descriptor object for the image format of devices and raw (uncompressed) image data</short>
<descr>This effectivley is a record with some attached methods. More related procedures exist outside the object.
The object describes the presence and exact storage of the RGBA image and mask pixels, of a device or image. The color information is stored in aligned scanlines.
Note: palettes, BitOrder and ByteOrder seem not to be implemented yet. The meaning of the PaletteXXX values and of BitOrder is undefined, so far.
xxxBitsPerPixel and xxxPrecisionMask applies to color data. For masked images, the pixels and the mask are two different arrays, containing different elements.</descr>
<seealso>
<link id="TRawImage"/>
</seealso>
<notes><note>where?</note>
</notes>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.Format">
<short>An initialized image can contain color (RGBA) or monochrome pixels.</short>
<descr>
<var>ricfNone</var> indicates an uninitialized image.</descr>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.HasPalette">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.Depth">
<short>Number of used bits per pixel</short>
<descr>The color and pixel storage can be subject to alignment, so that the logical color Depth can be less than the physical BitsPerPixel.</descr>
<seealso/>
<notes><note>What if a palette is used?</note>
</notes>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.Width">
<short>Width of the image in pixels</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.Height">
<short>Height of the image in pixels.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.PaletteColorCount">
<short>Number of entries in the color palette. 0 when no palette is present.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.BitOrder">
<short>[unusable by definition]</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.ByteOrder">
<short>The LSB/MSB-first byte order of color data.</short>
<descr/>
<seealso/>
<errors>[Not yet implemented]</errors>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.LineOrder">
<short>The first stored line of pixels can represent the logical top or bottom of the displayed image.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.ColorCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.BitsPerPixel">
<short>Number of bits stored per pixel</short>
<descr>
<var>BitsPerPixel</var> can be greater than the logical (used) <var>Depth</var>.</descr>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.LineEnd">
<short>Alignment of the scanlines.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.RedPrec">
<short>Bits per pixel in the Red channel</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.RedShift">
<short>Bit offset of the Red channel in color data.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.GreenPrec">
<short>Bits per pixel in the Green channel</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.GreenShift">
<short>Bit offset of the Green channel in color data.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.BluePrec">
<short>Bits per pixel in the Blue channel</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.BlueShift">
<short>Bit offset of the Blue channel in color data.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaPrec">
<short>Bits per pixel in the Alpha channel</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaShift">
<short>Bit offset of the Alpha channel in color data.</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaSeparate">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaBitsPerPixel">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaLineEnd">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaBitOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImageDescription.AlphaByteOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- pointer type Visibility: default -->
<element name="PRawImageDescription">
<short>Pointer to <link id="TRawImageDescription"/>
</short>
<descr/>
<seealso/>
</element>
<!-- record type Visibility: default -->
<element name="TRawImage">
<short>An uncompressed graphics image (bitmap)</short>
<descr>This object hold the pixels, mask and color palette of the image, as well as a detailed <link id="TRawImageDescription">description</link> of the storage format of these parts.
This object currently is subject to refactoring, don't use it in application code.</descr>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.Description">
<short>
<var>Description</var> record for the Raw Image</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.Data">
<short>
<var>Data</var> - a pointer to the actual data of the image</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.DataSize">
<short>
<var>DataSize</var> - pointer to the size of the image</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.Mask">
<short>
<var>Mask</var> - pointer to the Mask for use with the image</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.MaskSize">
<short>
<var>MaskSize</var> - pointer to the size of the mask</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.Palette">
<short>
<var>Palette</var> - pointer to the palette of colours for this image</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImage.PaletteSize">
<short>
<var>PaletteSize</var> - pointer to the size of the palette</short>
<descr/>
<seealso/>
</element>
<!-- pointer type Visibility: default -->
<element name="PRawImage">
<short>
<var>PRawImage</var> - pointer to a <var>TRawImage</var>
</short>
<descr/>
<seealso/>
</element>
<!-- record type Visibility: default -->
<element name="TRawImagePosition">
<short>Record describing a position in Raw Image data</short>
<descr>Byte is the byte offset, Bit the bit number/offset in that byte.</descr>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImagePosition.Byte">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRawImagePosition.Bit">
<short/>
<descr/>
<seealso/>
</element>
<!-- pointer type Visibility: default -->
<element name="PRawImagePosition">
<short>
<var>PRawImagePosition</var> - pointer to a <var>TRawImagePosition</var>
</short>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="RawImageColorFormatNames">
<short/>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="RawImageByteOrderNames">
<short/>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="RawImageBitOrderNames">
<short/>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="RawImageLineEndNames">
<short/>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="RawImageLineOrderNames">
<short/>
<descr/>
<seealso/>
</element>
<!-- constant Visibility: default -->
<element name="DefaultByteOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="RawImageMaskIsEmpty">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="RawImageMaskIsEmpty.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="RawImageMaskIsEmpty.RawImage">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="RawImageMaskIsEmpty.TestPixels">
<short/>
</element>
<!-- function Visibility: default -->
<element name="RawImageDescriptionAsString">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="RawImageDescriptionAsString.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="RawImageDescriptionAsString.Desc">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="FreeRawImageData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="FreeRawImageData.RawImage">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="ReleaseRawImageData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="ReleaseRawImageData.RawImage">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="CreateRawImageData">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.Width">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.Height">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.BitsPerPixel">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.LineEnd">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.Data">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageData.DataSize">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="CreateRawImageLineStarts">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageLineStarts.Width">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageLineStarts.Height">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageLineStarts.BitsPerPixel">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageLineStarts.LineEnd">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageLineStarts.LineStarts">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="CreateRawImageDescFromMask">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageDescFromMask.SrcRawImageDesc">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CreateRawImageDescFromMask.DestRawImageDesc">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="GetRawImageXYPosition">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="GetRawImageXYPosition.RawImageDesc">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetRawImageXYPosition.LineStarts">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetRawImageXYPosition.x">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetRawImageXYPosition.y">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetRawImageXYPosition.Position">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="ExtractRawImageRect">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageRect.SrcRawImage">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageRect.SrcRect">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageRect.DestRawImage">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="ExtractRawImageDataRect">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.SrcRawImageDesc">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.SrcRect">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.SrcData">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.DestRawImageDesc">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.DestData">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ExtractRawImageDataRect.DestDataSize">
<short/>
</element>
<!-- function Visibility: default -->
<element name="GetBitsPerLine">
<short>
<var>GetBitsPerLine</var> - returns the number of bits per line (as a pointer)</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="GetBitsPerLine.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetBitsPerLine.Width">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetBitsPerLine.BitsPerPixel">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="GetBitsPerLine.LineEnd">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="ReadRawImageBits">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.TheData">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.Position">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.BitsPerPixel">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.Prec">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.Shift">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.BitOrder">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="ReadRawImageBits.Bits">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="WriteRawImageBits">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.TheData">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.Position">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.BitsPerPixel">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.Prec">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.Shift">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.BitOrder">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="WriteRawImageBits.Bits">
<short/>
</element>
<!-- variable Visibility: default -->
<element name="MissingBits">
<short/>
<descr/>
<seealso/>
</element>
<element name="TRawImageDescription.MaskBitsPerPixel">
<short>Bits per mask pixel, 0 when no mask is present.</short>
<descr>A pixel Mask (currently) has a logical depth of 1 bit per pixel, but a pixel can occupy an entire byte.
As opposed to the Alpha (transparency) channel, a Mask is stored in its own array.
A Mask value of 1 means that the pixel is masked (transparent); a value of 0 means the pixel value is shown (opaque).</descr>
<notes><note>?</note><note>of bits or bytes?</note>
</notes>
</element>
<element name="TRawImageDescription.MaskShift">
<short>The bit offset of the mask bit</short>
<notes><note>if stored in a byte?</note>
</notes>
</element>
<element name="TRawImageDescription.MaskLineEnd">
<short>Alignment of Mask lines.</short>
</element>
<element name="TRawImageDescription.MaskBitOrder">
<short>Bit order of the Mask.</short>
</element>
<element name="TRawImageDescription.PaletteBitsPerIndex">
<short>Bits per palette index, stored in the pixel data</short>
<descr>When a palette is used, the color description fields apply to the
palette colors, while pixel data contains the palette index. Then Depth
applies to the size of the palette colors, and the pixel data is described
by PaletteBitsPerIndex and PaletteShift</descr>
<errors>[palettes are not yet implemented]</errors>
<notes><note>?</note>
</notes>
</element>
<element name="TRawImageDescription.PaletteShift">
<short/>
</element>
<element name="TRawImageDescription.PaletteLineEnd">
<short/>
<descr/>
<notes><note>what?</note>
</notes>
</element>
<element name="TRawImageDescription.PaletteBitOrder">
<short>Bit order of the palette indices</short>
<notes><note>?</note>
</notes>
</element>
<element name="TRawImageDescription.PaletteByteOrder">
<short>Byte order of the palette indices</short>
<notes><note>?</note>
</notes>
</element>
<element name="TRawImageDescription.Init">
<short>Initialize the image descriptor to all zeroes.</short>
<descr>A constructor cannot be used here, it would break compatibility with a record.</descr>
</element>
<element name="TRawImageDescription.Init_BPP24_B8G8R8_BIO_TTB">
<short>Init for an unmasked 24 bit RGB image (LSB Blue).</short>
<descr>
<p>Init_BPP24_B8G8R8_BIO_TTB - initiator for specified format</p>
<pre>{ pf24bit:
Format=ricfRGBA HasPalette=false Depth=24 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=24 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
} </pre>
</descr>
</element>
<element name="TRawImageDescription.Init_BPP24_B8G8R8_M1_BIO_TTB">
<short>Init for a masked 24 bit RGB image (LSB Blue)</short>
<descr>
<p>Init_BPP24_B8G8R8_M1_BIO_TTB - initiator for specfied format</p>
<pre>{ pf24bit:
Format=ricfRGBA HasPalette=false Depth=24 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=24 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
Masked
}</pre>
</descr>
</element>
<element name="TRawImageDescription.Init_BPP32_B8G8R8_BIO_TTB">
<short>Init for an unmasked 32 bit RGB image (LSB blue)</short>
<descr>
<p>
<var>Init_BPP32_B8G8R8_BIO_TTB</var> - initiator for specified format</p>
<pre>{ pf32bit:
Format=ricfRGBA HasPalette=false Depth=24 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=32 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
No alpha
No mask
} </pre>
</descr>
</element>
<element name="TRawImageDescription.Init_BPP32_B8G8R8_M1_BIO_TTB">
<short>Init for a masked 32 bit RGB image (LSB blue)</short>
<descr>
<p>
<var>Init_BPP32_B8G8R8_M1_BIO_TTB</var> - initiator for specified format</p>
<pre>{ pf32bit:
Format=ricfRGBA HasPalette=false Depth=24 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=32 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
no alpha
with mask
}
</pre>
</descr>
</element>
<element name="TRawImageDescription.Init_BPP32_B8G8R8A8_BIO_TTB">
<short>Init for an unmasked 32 bit RGBA image (LSB blue)</short>
<descr>
<p>
<var>Init_BPP32_B8G8R8A8_BIO_TTB</var> - initiator for specified format</p>
<pre>{ pf32bit:
Format=ricfRGBA HasPalette=false Depth=32 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=32 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
alpha
no mask
}
</pre>
</descr>
</element>
<element name="TRawImageDescription.Init_BPP32_B8G8R8A8_M1_BIO_TTB">
<short>Init for a masked 32 bit RGBA image (LSB blue)</short>
<descr>
<p>
<var>Init_BPP32_B8G8R8A8_M1_BIO_TTB</var> - initiator for specified format</p>
<pre>{ pf32bit:
Format=ricfRGBA HasPalette=false Depth=32 PaletteColorCount=0
BitOrder=riboBitsInOrder ByteOrder=DefaultByteOrder
LineOrder=riloTopToBottom
BitsPerPixel=32 LineEnd=rileDWordBoundary
RedPrec=8 RedShift=16 GreenPrec=8 GreenShift=8 BluePrec=8 BlueShift=0
alpha
masked
}
</pre>
</descr>
</element>
<element name="TRawImageDescription.GetDescriptionFromMask">
<short>Returns an monochrome image descriptor constructed from the Mask</short>
</element>
<element name="TRawImageDescription.GetDescriptionFromAlpha">
<short>Returns an monochrome image descriptor constructed from the Alpha channel</short>
</element>
<element name="TRawImageDescription.BytesPerLine">
<short>The number of bytes per scanline.</short>
</element>
<element name="TRawImageDescription.BitsPerLine">
<short>The number of bits per scanline.</short>
</element>
<element name="TRawImageDescription.MaskBytesPerLine">
<short>The number of bytes per Mask scanline.</short>
</element>
<element name="TRawImageDescription.MaskBitsPerLine">
<short>The number of bits per Mask scanline.</short>
</element>
<element name="TRawImageDescription.AsString">
<short>The image descriptor as a string.</short>
</element>
<element name="TRawImageDescription.IsEqual">
<short>Compares with the given description, returns True if it's equal.</short>
</element>
<element name="TRawImage.Init">
<short>
<var>Init</var> - initiator for the object. Don't use a contructor here, it will break compatibility with a record</short>
</element>
<element name="TRawImage.CreateData">
<short>
<var>CreateData</var> - method to create the data for the record</short>
</element>
<element name="TRawImage.FreeData">
<short>Destroys the allocated Data, Mask and Palette arrays.</short>
</element>
<element name="TRawImage.ReleaseData">
<short>
<var>ReleaseData</var> - frees the resources when finished with th edata</short>
</element>
<element name="TRawImage.ExtractRect">
<short>
<var>ExtractRect</var> - find the position of the bounding rectangle from the raw data</short>
</element>
<element name="TRawImage.PerformEffect">
<short>
<var>PerformEffect</var> - applies a specified special effect to the data of the Raw Image</short>
</element>
<element name="TRawImage.ReadBits">
<short>
<var>ReadBits</var> - reads the bit values for the raw image data at a given position</short>
</element>
<element name="TRawImage.ReadChannels">
<short>Reads the R, G, B and Alpha channel values at a given position in pixel data.</short>
</element>
<element name="TRawImage.ReadMask">
<short>Read the Mask value at the given position in the image data. Returns AMask=True if the pixel is transparent.</short>
<descr>The position in the Mask data typically differs from the position in the color data.</descr>
</element>
<element name="TRawImage.WriteBits">
<short>Writes ABits into Data at the given position.</short>
</element>
<element name="TRawImage.WriteChannels">
<short>
<var>WriteChannels</var> - writes the specified channel values at the nominated position</short>
</element>
<element name="TRawImage.IsMasked">
<short>
<var>IsMasked</var> - returns True if the specified pixels are masked</short>
</element>
<element name="TRawImage.IsTransparent">
<short>
<var>IsTransparent</var> - returns True if the specified pixels are transparent</short>
</element>
<element name="TRawImage.IsEqual">
<short>
<var>IsEqual</var> - returns True if the current and specified images are equal</short>
</element>
<element name="TRawImageLineStarts">
<short>
<var>TRawImageLineStarts</var> - contains a list of the start positions of the lines in the Raw Image</short>
</element>
<element name="TRawImageLineStarts.Positions">
<short>
<var>Positions</var> - the array of start positions</short>
</element>
<element name="TRawImageLineStarts.Init">
<short>
<var>Init</var> - initiator for the object. Don't use a constructor here, it will break compatibility with a record</short>
</element>
<element name="TRawImageLineStarts.GetPosition">
<short>
<var>GetPosition</var> - returns the position specified by x, y coordinates as a <var>TRawImagePosition</var>
</short>
</element>
<element name="PRawImageLineStarts">
<short>
<var>PRawImageLineStarts</var> - pointer to <var>TRawImageLineStarts</var>
</short>
</element>
<element name="GetBytesPerLine">
<short>
<var>GetBytesPerLine</var> - returns the number of bytes per line (as a pointer)</short>
</element>
<element name="CopyImageData">
<short>
<var>CopyImageData</var> - copies data from <var>ASource</var> to <var>ADestination</var>, returning True if successful</short>
</element>
<element name="TRawImageLineEnd.rileDQWordBoundary">
<short>Scanlines start at a 128 bit boundary.</short>
</element>
<element name="TRawImageQueryFlag">
<short>Image formats supported by a device, or present in image data</short>
<notes><note>?</note>
</notes>
</element>
<element name="RawImage_ReadBits">
<short>Read color bits.</short>
<descr>AData is the pointer to the pixel data.
APosition is the position of a pixel within AData.
ABitsPerPixel is the size of a stored pixel.
APrec and AShift select the field (color channel or palette index).
The bits are extracted into the low order bits of the result (ABits).</descr>
<seealso>
<link id="RawImage_WriteBits"/>
</seealso>
</element>
<element name="RawImage_WriteBits">
<short>Write color or mask data, from the high bits of ABits.</short>
<errors>ReadBits returns the value in the low order bits</errors>
<seealso>
<link id="RawImage_ReadBits"/>
</seealso>
</element>
</module>
<!-- GraphType -->
</package>
</fpdoc-descriptions>
|