1 2<!doctype html> 3<html lang="en" class="no-js"> 4 <head> 5 6 <meta charset="utf-8"> 7 <meta name="viewport" content="width=device-width,initial-scale=1"> 8 9 <meta name="description" content="API Reference Documentation for FreeType-2.12.1"> 10 11 12 13 <meta name="author" content="FreeType Contributors"> 14 15 16 <link rel="icon" href="images/favico.ico"> 17 <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.1.9"> 18 19 20 21 <title>LZW Streams - FreeType-2.12.1 API Reference</title> 22 23 24 25 <link rel="stylesheet" href="assets/stylesheets/main.ca7ac06f.min.css"> 26 27 28 <link rel="stylesheet" href="assets/stylesheets/palette.f1a3b89f.min.css"> 29 30 31 32 <meta name="theme-color" content="#4cae4f"> 33 34 35 36 37 38 39 40 <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> 41 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Noto+Serif:300,400,400i,700%7CRoboto+Mono&display=fallback"> 42 <style>:root{--md-text-font-family:"Noto Serif";--md-code-font-family:"Roboto Mono"}</style> 43 44 45 46 47 <link rel="stylesheet" href="stylesheets/extra.css"> 48 49 50 51 52 53 54 55 </head> 56 57 58 59 60 61 62 63 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="green" data-md-color-accent="green"> 64 65 66 <script>function __prefix(e){return new URL(".",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> 67 68 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> 69 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> 70 <label class="md-overlay" for="__drawer"></label> 71 <div data-md-component="skip"> 72 73 74 <a href="#lzw-streams" class="md-skip"> 75 Skip to content 76 </a> 77 78 </div> 79 <div data-md-component="announce"> 80 81 </div> 82 83 <header class="md-header" data-md-component="header"> 84 <nav class="md-header__inner md-grid" aria-label="Header"> 85 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-header__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 86 87 <img src="images/favico.ico" alt="logo"> 88 89 </a> 90 <label class="md-header__button md-icon" for="__drawer"> 91 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> 92 </label> 93 <div class="md-header__title" data-md-component="header-title"> 94 <div class="md-header__ellipsis"> 95 <div class="md-header__topic"> 96 <span class="md-ellipsis"> 97 FreeType-2.12.1 API Reference 98 </span> 99 </div> 100 <div class="md-header__topic" data-md-component="header-topic"> 101 <span class="md-ellipsis"> 102 103 LZW Streams 104 105 </span> 106 </div> 107 </div> 108 </div> 109 110 111 112 <label class="md-header__button md-icon" for="__search"> 113 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> 114 </label> 115 116<div class="md-search" data-md-component="search" role="dialog"> 117 <label class="md-search__overlay" for="__search"></label> 118 <div class="md-search__inner" role="search"> 119 <form class="md-search__form" name="search"> 120 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required> 121 <label class="md-search__icon md-icon" for="__search"> 122 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> 123 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> 124 </label> 125 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> 126 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> 127 </button> 128 </form> 129 <div class="md-search__output"> 130 <div class="md-search__scrollwrap" data-md-scrollfix> 131 <div class="md-search-result" data-md-component="search-result"> 132 <div class="md-search-result__meta"> 133 Initializing search 134 </div> 135 <ol class="md-search-result__list"></ol> 136 </div> 137 </div> 138 </div> 139 </div> 140</div> 141 142 143 </nav> 144</header> 145 146 <div class="md-container" data-md-component="container"> 147 148 149 150 151 <main class="md-main" data-md-component="main"> 152 <div class="md-main__inner md-grid"> 153 154 155 156 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > 157 <div class="md-sidebar__scrollwrap"> 158 <div class="md-sidebar__inner"> 159 160 161 162<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> 163 <label class="md-nav__title" for="__drawer"> 164 <a href="index.html" title="FreeType-2.12.1 API Reference" class="md-nav__button md-logo" aria-label="FreeType-2.12.1 API Reference" data-md-component="logo"> 165 166 <img src="images/favico.ico" alt="logo"> 167 168 </a> 169 FreeType-2.12.1 API Reference 170 </label> 171 172 <ul class="md-nav__list" data-md-scrollfix> 173 174 175 176 177 178 179 180 181 <li class="md-nav__item"> 182 <a href="index.html" class="md-nav__link"> 183 TOC 184 </a> 185 </li> 186 187 188 189 190 191 192 193 194 195 196 <li class="md-nav__item"> 197 <a href="ft2-index.html" class="md-nav__link"> 198 Index 199 </a> 200 </li> 201 202 203 204 205 206 207 208 209 210 211 212 <li class="md-nav__item md-nav__item--nested"> 213 214 215 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > 216 217 <label class="md-nav__link" for="__nav_3"> 218 General Remarks 219 <span class="md-nav__icon md-icon"></span> 220 </label> 221 <nav class="md-nav" aria-label="General Remarks" data-md-level="1"> 222 <label class="md-nav__title" for="__nav_3"> 223 <span class="md-nav__icon md-icon"></span> 224 General Remarks 225 </label> 226 <ul class="md-nav__list" data-md-scrollfix> 227 228 229 230 231 232 <li class="md-nav__item"> 233 <a href="ft2-preamble.html" class="md-nav__link"> 234 Preamble 235 </a> 236 </li> 237 238 239 240 241 242 243 244 <li class="md-nav__item"> 245 <a href="ft2-header_inclusion.html" class="md-nav__link"> 246 FreeType's header inclusion scheme 247 </a> 248 </li> 249 250 251 252 253 254 255 256 <li class="md-nav__item"> 257 <a href="ft2-user_allocation.html" class="md-nav__link"> 258 User allocation 259 </a> 260 </li> 261 262 263 264 </ul> 265 </nav> 266 </li> 267 268 269 270 271 272 273 274 275 276 277 278 <li class="md-nav__item md-nav__item--nested"> 279 280 281 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > 282 283 <label class="md-nav__link" for="__nav_4"> 284 Core API 285 <span class="md-nav__icon md-icon"></span> 286 </label> 287 <nav class="md-nav" aria-label="Core API" data-md-level="1"> 288 <label class="md-nav__title" for="__nav_4"> 289 <span class="md-nav__icon md-icon"></span> 290 Core API 291 </label> 292 <ul class="md-nav__list" data-md-scrollfix> 293 294 295 296 297 298 <li class="md-nav__item"> 299 <a href="ft2-version.html" class="md-nav__link"> 300 FreeType Version 301 </a> 302 </li> 303 304 305 306 307 308 309 310 <li class="md-nav__item"> 311 <a href="ft2-basic_types.html" class="md-nav__link"> 312 Basic Data Types 313 </a> 314 </li> 315 316 317 318 319 320 321 322 <li class="md-nav__item"> 323 <a href="ft2-base_interface.html" class="md-nav__link"> 324 Base Interface 325 </a> 326 </li> 327 328 329 330 331 332 333 334 <li class="md-nav__item"> 335 <a href="ft2-glyph_variants.html" class="md-nav__link"> 336 Unicode Variation Sequences 337 </a> 338 </li> 339 340 341 342 343 344 345 346 <li class="md-nav__item"> 347 <a href="ft2-color_management.html" class="md-nav__link"> 348 Glyph Color Management 349 </a> 350 </li> 351 352 353 354 355 356 357 358 <li class="md-nav__item"> 359 <a href="ft2-layer_management.html" class="md-nav__link"> 360 Glyph Layer Management 361 </a> 362 </li> 363 364 365 366 367 368 369 370 <li class="md-nav__item"> 371 <a href="ft2-glyph_management.html" class="md-nav__link"> 372 Glyph Management 373 </a> 374 </li> 375 376 377 378 379 380 381 382 <li class="md-nav__item"> 383 <a href="ft2-mac_specific.html" class="md-nav__link"> 384 Mac Specific Interface 385 </a> 386 </li> 387 388 389 390 391 392 393 394 <li class="md-nav__item"> 395 <a href="ft2-sizes_management.html" class="md-nav__link"> 396 Size Management 397 </a> 398 </li> 399 400 401 402 403 404 405 406 <li class="md-nav__item"> 407 <a href="ft2-header_file_macros.html" class="md-nav__link"> 408 Header File Macros 409 </a> 410 </li> 411 412 413 414 </ul> 415 </nav> 416 </li> 417 418 419 420 421 422 423 424 425 426 427 428 <li class="md-nav__item md-nav__item--nested"> 429 430 431 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > 432 433 <label class="md-nav__link" for="__nav_5"> 434 Format-Specific API 435 <span class="md-nav__icon md-icon"></span> 436 </label> 437 <nav class="md-nav" aria-label="Format-Specific API" data-md-level="1"> 438 <label class="md-nav__title" for="__nav_5"> 439 <span class="md-nav__icon md-icon"></span> 440 Format-Specific API 441 </label> 442 <ul class="md-nav__list" data-md-scrollfix> 443 444 445 446 447 448 <li class="md-nav__item"> 449 <a href="ft2-multiple_masters.html" class="md-nav__link"> 450 Multiple Masters 451 </a> 452 </li> 453 454 455 456 457 458 459 460 <li class="md-nav__item"> 461 <a href="ft2-truetype_tables.html" class="md-nav__link"> 462 TrueType Tables 463 </a> 464 </li> 465 466 467 468 469 470 471 472 <li class="md-nav__item"> 473 <a href="ft2-type1_tables.html" class="md-nav__link"> 474 Type 1 Tables 475 </a> 476 </li> 477 478 479 480 481 482 483 484 <li class="md-nav__item"> 485 <a href="ft2-sfnt_names.html" class="md-nav__link"> 486 SFNT Names 487 </a> 488 </li> 489 490 491 492 493 494 495 496 <li class="md-nav__item"> 497 <a href="ft2-bdf_fonts.html" class="md-nav__link"> 498 BDF and PCF Files 499 </a> 500 </li> 501 502 503 504 505 506 507 508 <li class="md-nav__item"> 509 <a href="ft2-cid_fonts.html" class="md-nav__link"> 510 CID Fonts 511 </a> 512 </li> 513 514 515 516 517 518 519 520 <li class="md-nav__item"> 521 <a href="ft2-pfr_fonts.html" class="md-nav__link"> 522 PFR Fonts 523 </a> 524 </li> 525 526 527 528 529 530 531 532 <li class="md-nav__item"> 533 <a href="ft2-winfnt_fonts.html" class="md-nav__link"> 534 Window FNT Files 535 </a> 536 </li> 537 538 539 540 541 542 543 544 <li class="md-nav__item"> 545 <a href="ft2-svg_fonts.html" class="md-nav__link"> 546 OpenType SVG Fonts 547 </a> 548 </li> 549 550 551 552 553 554 555 556 <li class="md-nav__item"> 557 <a href="ft2-font_formats.html" class="md-nav__link"> 558 Font Formats 559 </a> 560 </li> 561 562 563 564 565 566 567 568 <li class="md-nav__item"> 569 <a href="ft2-gasp_table.html" class="md-nav__link"> 570 Gasp Table 571 </a> 572 </li> 573 574 575 576 </ul> 577 </nav> 578 </li> 579 580 581 582 583 584 585 586 587 588 589 590 <li class="md-nav__item md-nav__item--nested"> 591 592 593 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > 594 595 <label class="md-nav__link" for="__nav_6"> 596 Controlling FreeType Modules 597 <span class="md-nav__icon md-icon"></span> 598 </label> 599 <nav class="md-nav" aria-label="Controlling FreeType Modules" data-md-level="1"> 600 <label class="md-nav__title" for="__nav_6"> 601 <span class="md-nav__icon md-icon"></span> 602 Controlling FreeType Modules 603 </label> 604 <ul class="md-nav__list" data-md-scrollfix> 605 606 607 608 609 610 <li class="md-nav__item"> 611 <a href="ft2-auto_hinter.html" class="md-nav__link"> 612 The auto-hinter 613 </a> 614 </li> 615 616 617 618 619 620 621 622 <li class="md-nav__item"> 623 <a href="ft2-cff_driver.html" class="md-nav__link"> 624 The CFF driver 625 </a> 626 </li> 627 628 629 630 631 632 633 634 <li class="md-nav__item"> 635 <a href="ft2-t1_cid_driver.html" class="md-nav__link"> 636 The Type 1 and CID drivers 637 </a> 638 </li> 639 640 641 642 643 644 645 646 <li class="md-nav__item"> 647 <a href="ft2-tt_driver.html" class="md-nav__link"> 648 The TrueType driver 649 </a> 650 </li> 651 652 653 654 655 656 657 658 <li class="md-nav__item"> 659 <a href="ft2-pcf_driver.html" class="md-nav__link"> 660 The PCF driver 661 </a> 662 </li> 663 664 665 666 667 668 669 670 <li class="md-nav__item"> 671 <a href="ft2-ot_svg_driver.html" class="md-nav__link"> 672 The SVG driver 673 </a> 674 </li> 675 676 677 678 679 680 681 682 <li class="md-nav__item"> 683 <a href="ft2-properties.html" class="md-nav__link"> 684 Driver properties 685 </a> 686 </li> 687 688 689 690 691 692 693 694 <li class="md-nav__item"> 695 <a href="ft2-parameter_tags.html" class="md-nav__link"> 696 Parameter Tags 697 </a> 698 </li> 699 700 701 702 703 704 705 706 <li class="md-nav__item"> 707 <a href="ft2-lcd_rendering.html" class="md-nav__link"> 708 Subpixel Rendering 709 </a> 710 </li> 711 712 713 714 </ul> 715 </nav> 716 </li> 717 718 719 720 721 722 723 724 725 726 727 728 <li class="md-nav__item md-nav__item--nested"> 729 730 731 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > 732 733 <label class="md-nav__link" for="__nav_7"> 734 Cache Sub-System 735 <span class="md-nav__icon md-icon"></span> 736 </label> 737 <nav class="md-nav" aria-label="Cache Sub-System" data-md-level="1"> 738 <label class="md-nav__title" for="__nav_7"> 739 <span class="md-nav__icon md-icon"></span> 740 Cache Sub-System 741 </label> 742 <ul class="md-nav__list" data-md-scrollfix> 743 744 745 746 747 748 <li class="md-nav__item"> 749 <a href="ft2-cache_subsystem.html" class="md-nav__link"> 750 Cache Sub-System 751 </a> 752 </li> 753 754 755 756 </ul> 757 </nav> 758 </li> 759 760 761 762 763 764 765 766 767 768 769 770 771 772 <li class="md-nav__item md-nav__item--active md-nav__item--nested"> 773 774 775 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked> 776 777 <label class="md-nav__link" for="__nav_8"> 778 Support API 779 <span class="md-nav__icon md-icon"></span> 780 </label> 781 <nav class="md-nav" aria-label="Support API" data-md-level="1"> 782 <label class="md-nav__title" for="__nav_8"> 783 <span class="md-nav__icon md-icon"></span> 784 Support API 785 </label> 786 <ul class="md-nav__list" data-md-scrollfix> 787 788 789 790 791 792 <li class="md-nav__item"> 793 <a href="ft2-computations.html" class="md-nav__link"> 794 Computations 795 </a> 796 </li> 797 798 799 800 801 802 803 804 <li class="md-nav__item"> 805 <a href="ft2-list_processing.html" class="md-nav__link"> 806 List Processing 807 </a> 808 </li> 809 810 811 812 813 814 815 816 <li class="md-nav__item"> 817 <a href="ft2-outline_processing.html" class="md-nav__link"> 818 Outline Processing 819 </a> 820 </li> 821 822 823 824 825 826 827 828 <li class="md-nav__item"> 829 <a href="ft2-quick_advance.html" class="md-nav__link"> 830 Quick retrieval of advance values 831 </a> 832 </li> 833 834 835 836 837 838 839 840 <li class="md-nav__item"> 841 <a href="ft2-bitmap_handling.html" class="md-nav__link"> 842 Bitmap Handling 843 </a> 844 </li> 845 846 847 848 849 850 851 852 <li class="md-nav__item"> 853 <a href="ft2-raster.html" class="md-nav__link"> 854 Scanline Converter 855 </a> 856 </li> 857 858 859 860 861 862 863 864 <li class="md-nav__item"> 865 <a href="ft2-glyph_stroker.html" class="md-nav__link"> 866 Glyph Stroker 867 </a> 868 </li> 869 870 871 872 873 874 875 876 <li class="md-nav__item"> 877 <a href="ft2-system_interface.html" class="md-nav__link"> 878 System Interface 879 </a> 880 </li> 881 882 883 884 885 886 887 888 <li class="md-nav__item"> 889 <a href="ft2-module_management.html" class="md-nav__link"> 890 Module Management 891 </a> 892 </li> 893 894 895 896 897 898 899 900 <li class="md-nav__item"> 901 <a href="ft2-gzip.html" class="md-nav__link"> 902 GZIP Streams 903 </a> 904 </li> 905 906 907 908 909 910 911 912 913 914 <li class="md-nav__item md-nav__item--active"> 915 916 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> 917 918 919 920 921 922 <label class="md-nav__link md-nav__link--active" for="__toc"> 923 LZW Streams 924 <span class="md-nav__icon md-icon"></span> 925 </label> 926 927 <a href="ft2-lzw.html" class="md-nav__link md-nav__link--active"> 928 LZW Streams 929 </a> 930 931 932<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> 933 934 935 936 937 938 939 <label class="md-nav__title" for="__toc"> 940 <span class="md-nav__icon md-icon"></span> 941 Table of contents 942 </label> 943 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> 944 945 <li class="md-nav__item"> 946 <a href="#synopsis" class="md-nav__link"> 947 Synopsis 948 </a> 949 950</li> 951 952 <li class="md-nav__item"> 953 <a href="#ft_stream_openlzw" class="md-nav__link"> 954 FT_Stream_OpenLZW 955 </a> 956 957</li> 958 959 </ul> 960 961</nav> 962 963 </li> 964 965 966 967 968 969 970 971 <li class="md-nav__item"> 972 <a href="ft2-bzip2.html" class="md-nav__link"> 973 BZIP2 Streams 974 </a> 975 </li> 976 977 978 979 980 981 982 983 <li class="md-nav__item"> 984 <a href="ft2-debugging_apis.html" class="md-nav__link"> 985 External Debugging APIs 986 </a> 987 </li> 988 989 990 991 </ul> 992 </nav> 993 </li> 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 <li class="md-nav__item md-nav__item--nested"> 1006 1007 1008 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > 1009 1010 <label class="md-nav__link" for="__nav_9"> 1011 Error Codes 1012 <span class="md-nav__icon md-icon"></span> 1013 </label> 1014 <nav class="md-nav" aria-label="Error Codes" data-md-level="1"> 1015 <label class="md-nav__title" for="__nav_9"> 1016 <span class="md-nav__icon md-icon"></span> 1017 Error Codes 1018 </label> 1019 <ul class="md-nav__list" data-md-scrollfix> 1020 1021 1022 1023 1024 1025 <li class="md-nav__item"> 1026 <a href="ft2-error_enumerations.html" class="md-nav__link"> 1027 Error Enumerations 1028 </a> 1029 </li> 1030 1031 1032 1033 1034 1035 1036 1037 <li class="md-nav__item"> 1038 <a href="ft2-error_code_values.html" class="md-nav__link"> 1039 Error Code Values 1040 </a> 1041 </li> 1042 1043 1044 1045 </ul> 1046 </nav> 1047 </li> 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 <li class="md-nav__item md-nav__item--nested"> 1060 1061 1062 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > 1063 1064 <label class="md-nav__link" for="__nav_10"> 1065 Miscellaneous 1066 <span class="md-nav__icon md-icon"></span> 1067 </label> 1068 <nav class="md-nav" aria-label="Miscellaneous" data-md-level="1"> 1069 <label class="md-nav__title" for="__nav_10"> 1070 <span class="md-nav__icon md-icon"></span> 1071 Miscellaneous 1072 </label> 1073 <ul class="md-nav__list" data-md-scrollfix> 1074 1075 1076 1077 1078 1079 <li class="md-nav__item"> 1080 <a href="ft2-gx_validation.html" class="md-nav__link"> 1081 TrueTypeGX/AAT Validation 1082 </a> 1083 </li> 1084 1085 1086 1087 1088 1089 1090 1091 <li class="md-nav__item"> 1092 <a href="ft2-incremental.html" class="md-nav__link"> 1093 Incremental Loading 1094 </a> 1095 </li> 1096 1097 1098 1099 1100 1101 1102 1103 <li class="md-nav__item"> 1104 <a href="ft2-truetype_engine.html" class="md-nav__link"> 1105 The TrueType Engine 1106 </a> 1107 </li> 1108 1109 1110 1111 1112 1113 1114 1115 <li class="md-nav__item"> 1116 <a href="ft2-ot_validation.html" class="md-nav__link"> 1117 OpenType Validation 1118 </a> 1119 </li> 1120 1121 1122 1123 </ul> 1124 </nav> 1125 </li> 1126 1127 1128 1129 </ul> 1130</nav> 1131 </div> 1132 </div> 1133 </div> 1134 1135 1136 1137 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > 1138 <div class="md-sidebar__scrollwrap"> 1139 <div class="md-sidebar__inner"> 1140 1141<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> 1142 1143 1144 1145 1146 1147 1148 <label class="md-nav__title" for="__toc"> 1149 <span class="md-nav__icon md-icon"></span> 1150 Table of contents 1151 </label> 1152 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> 1153 1154 <li class="md-nav__item"> 1155 <a href="#synopsis" class="md-nav__link"> 1156 Synopsis 1157 </a> 1158 1159</li> 1160 1161 <li class="md-nav__item"> 1162 <a href="#ft_stream_openlzw" class="md-nav__link"> 1163 FT_Stream_OpenLZW 1164 </a> 1165 1166</li> 1167 1168 </ul> 1169 1170</nav> 1171 </div> 1172 </div> 1173 </div> 1174 1175 1176 <div class="md-content" data-md-component="content"> 1177 <article class="md-content__inner md-typeset"> 1178 1179 1180 1181 <p><a href="https://www.freetype.org">FreeType</a> » <a href="../">Docs</a> » <a href="index.html#support-api">Support API</a> » LZW Streams</p> 1182<hr /> 1183<h1 id="lzw-streams">LZW Streams<a class="headerlink" href="#lzw-streams" title="Permanent link">¶</a></h1> 1184<h2 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">¶</a></h2> 1185<p>In certain builds of the library, LZW compression recognition is automatically handled when calling <code><a href="ft2-base_interface.html#ft_new_face">FT_New_Face</a></code> or <code><a href="ft2-base_interface.html#ft_open_face">FT_Open_Face</a></code>. This means that if no font driver is capable of handling the raw compressed file, the library will try to open a LZW stream from it and re-open the face with it.</p> 1186<p>The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream, which significantly undermines the performance.</p> 1187<p>This section contains the declaration of LZW-specific functions.</p> 1188<h2 id="ft_stream_openlzw">FT_Stream_OpenLZW<a class="headerlink" href="#ft_stream_openlzw" title="Permanent link">¶</a></h2> 1189<p>Defined in FT_LZW_H (freetype/ftlzw.h).</p> 1190<div class = "codehilite"><pre><code> FT_EXPORT( <a href="ft2-basic_types.html#ft_error">FT_Error</a> ) 1191 <b>FT_Stream_OpenLZW</b>( <a href="ft2-system_interface.html#ft_stream">FT_Stream</a> stream, 1192 <a href="ft2-system_interface.html#ft_stream">FT_Stream</a> source ); 1193</code></pre></div> 1194 1195<p>Open a new stream to parse LZW-compressed font files. This is mainly used to support the compressed <code>*.pcf.Z</code> fonts that come with XFree86.</p> 1196<h4>input</h4> 1197<table class="fields"> 1198<tr><td class="val" id="stream">stream</td><td class="desc"> 1199<p>The target embedding stream.</p> 1200</td></tr> 1201<tr><td class="val" id="source">source</td><td class="desc"> 1202<p>The source stream.</p> 1203</td></tr> 1204</table> 1205 1206<h4>return</h4> 1207 1208<p>FreeType error code. 0 means success.</p> 1209<h4>note</h4> 1210 1211<p>The source stream must be opened <em>before</em> calling this function.</p> 1212<p>Calling the internal function <code>FT_Stream_Close</code> on the new stream will <strong>not</strong> call <code>FT_Stream_Close</code> on the source stream. None of the stream objects will be released to the heap.</p> 1213<p>This function may return <code>FT_Err_Unimplemented_Feature</code> if your build of FreeType was not compiled with LZW support.</p> 1214<hr> 1215 1216 1217 1218 1219 1220 1221 1222 </article> 1223 </div> 1224 </div> 1225 1226 </main> 1227 1228 1229<footer class="md-footer"> 1230 1231 <nav class="md-footer__inner md-grid" aria-label="Footer"> 1232 1233 1234 <a href="ft2-gzip.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: GZIP Streams" rel="prev"> 1235 <div class="md-footer__button md-icon"> 1236 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> 1237 </div> 1238 <div class="md-footer__title"> 1239 <div class="md-ellipsis"> 1240 <span class="md-footer__direction"> 1241 Previous 1242 </span> 1243 GZIP Streams 1244 </div> 1245 </div> 1246 </a> 1247 1248 1249 1250 <a href="ft2-bzip2.html" class="md-footer__link md-footer__link--next" aria-label="Next: BZIP2 Streams" rel="next"> 1251 <div class="md-footer__title"> 1252 <div class="md-ellipsis"> 1253 <span class="md-footer__direction"> 1254 Next 1255 </span> 1256 BZIP2 Streams 1257 </div> 1258 </div> 1259 <div class="md-footer__button md-icon"> 1260 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg> 1261 </div> 1262 </a> 1263 1264 </nav> 1265 1266 <div class="md-footer-meta md-typeset"> 1267 <div class="md-footer-meta__inner md-grid"> 1268 <div class="md-footer-copyright"> 1269 1270 <div class="md-footer-copyright__highlight"> 1271 Copyright 2022 <a href = "https://www.freetype.org/license.html">The FreeType Project</a>. 1272 </div> 1273 1274 Made with 1275 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> 1276 Material for MkDocs 1277 </a> 1278 1279 </div> 1280 1281 </div> 1282 </div> 1283</footer> 1284 1285 </div> 1286 <div class="md-dialog" data-md-component="dialog"> 1287 <div class="md-dialog__inner md-typeset"></div> 1288 </div> 1289 <script id="__config" type="application/json">{"base": ".", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.477d984a.min.js", "version": null}</script> 1290 1291 1292 <script src="assets/javascripts/bundle.82b56eb2.min.js"></script> 1293 1294 <script src="javascripts/extra.js"></script> 1295 1296 1297 </body> 1298</html>