/modules/freetype2/docs/reference/ft2-lzw.html
HTML | 94 lines | 83 code | 11 blank | 0 comment | 0 complexity | a2cc2ce5bd160bbab5635df1a82c220d MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 2"http://www.w3.org/TR/html4/loose.dtd"> 3<html> 4<head> 5<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 6<title>FreeType-2.4.3 API Reference</title> 7<style type="text/css"> 8 body { font-family: Verdana, Geneva, Arial, Helvetica, serif; 9 color: #000000; 10 background: #FFFFFF; } 11 12 p { text-align: justify; } 13 h1 { text-align: center; } 14 li { text-align: justify; } 15 td { padding: 0 0.5em 0 0.5em; } 16 td.left { padding: 0 0.5em 0 0.5em; 17 text-align: left; } 18 19 a:link { color: #0000EF; } 20 a:visited { color: #51188E; } 21 a:hover { color: #FF0000; } 22 23 span.keyword { font-family: monospace; 24 text-align: left; 25 white-space: pre; 26 color: darkblue; } 27 28 pre.colored { color: blue; } 29 30 ul.empty { list-style-type: none; } 31</style> 32</head> 33<body> 34 35<table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td> 36<td width="100%"></td> 37<td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> 38<center><h1>FreeType-2.4.3 API Reference</h1></center> 39 40<center><h1> 41LZW Streams 42</h1></center> 43<h2>Synopsis</h2> 44<table align=center cellspacing=5 cellpadding=0 border=0> 45<tr><td></td><td><a href="#FT_Stream_OpenLZW">FT_Stream_OpenLZW</a></td><td></td><td></td><td></td><td></td><td></td><td></td></tr> 46</table><br><br> 47 48<table align=center width="87%"><tr><td> 49<p>This section contains the declaration of LZW-specific functions.</p> 50</td></tr></table><br> 51<table align=center width="75%"><tr><td> 52<h4><a name="FT_Stream_OpenLZW">FT_Stream_OpenLZW</a></h4> 53<table align=center width="87%"><tr><td> 54Defined in FT_LZW_H (freetype/ftlzw.h). 55</td></tr></table><br> 56<table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre> 57 58 FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> ) 59 <b>FT_Stream_OpenLZW</b>( <a href="ft2-system_interface.html#FT_Stream">FT_Stream</a> stream, 60 <a href="ft2-system_interface.html#FT_Stream">FT_Stream</a> source ); 61 62</pre></table><br> 63<table align=center width="87%"><tr><td> 64<p>Open a new stream to parse LZW-compressed font files. This is mainly used to support the compressed ‘*.pcf.Z’ fonts that come with XFree86.</p> 65</td></tr></table><br> 66<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td> 67<p></p> 68<table cellpadding=3 border=0> 69<tr valign=top><td><b>stream</b></td><td> 70<p>The target embedding stream.</p> 71</td></tr> 72<tr valign=top><td><b>source</b></td><td> 73<p>The source stream.</p> 74</td></tr> 75</table> 76</td></tr></table> 77<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td> 78<p>FreeType error code. 0 means success.</p> 79</td></tr></table> 80<table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td> 81<p>The source stream must be opened <i>before</i> calling this function.</p> 82<p>Calling the internal function ‘FT_Stream_Close’ on the new stream will <b>not</b> call ‘FT_Stream_Close’ on the source stream. None of the stream objects will be released to the heap.</p> 83<p>The stream implementation is very basic and resets the decompression process each time seeking backwards is needed within the stream</p> 84<p>In certain builds of the library, LZW compression recognition is automatically handled when calling <a href="ft2-base_interface.html#FT_New_Face">FT_New_Face</a> or <a href="ft2-base_interface.html#FT_Open_Face">FT_Open_Face</a>. 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> 85<p>This function may return ‘FT_Err_Unimplemented_Feature’ if your build of FreeType was not compiled with LZW support.</p> 86</td></tr></table> 87</td></tr></table> 88<hr width="75%"> 89<table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td> 90<td width="100%"></td> 91<td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table> 92 93</body> 94</html>