-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgiflib.html
128 lines (121 loc) · 4.92 KB
/
giflib.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> giflib - GIF reader </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'giflib'
var PROJECT = 'giflib'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> giflib </h1>
<h2> GIF reader </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/giflib" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/giflib/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/giflib/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/giflib/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-giflib" style="background-image: url('bg/giflib.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-giflib-requiregiflib"><code>local giflib = require'giflib'</code></h2>
<p>Lightweight ffi binding of the antique <a href="http://sourceforge.net/projects/giflib/">GIFLIB</a>.</p>
<h2 id="giflib.loadpath-t---gif"><code>giflib.load(path | t) -> gif</code></h2>
<p>Read and decode a GIF image.</p>
<ul>
<li><code>t</code> is a table specifying where to read the data from and other options:
<ul>
<li><code>path</code>: read data from a file given its filename</li>
<li><code>string:</code> read data from a string</li>
<li><code>cdata</code>, <code>size</code>: read data from a buffer of size <code>N</code></li>
<li><code>fileno</code>: read data from a low level file descriptor as returned by <code>C open()</code></li>
<li><code>opaque</code>: if <code>true</code>, prevents converting the gif transparent color to transparent black.</li>
</ul></li>
</ul>
<p>The returned <code>gif</code> object is a table with the fields:</p>
<ul>
<li><code>w</code>, <code>h</code>: the gif dimensions.</li>
<li><code>frames = {image1, ...}</code>: the list of gif frames, in order, where each frame is an image object with the fields:
<ul>
<li><code>format</code>, <code>stride</code>, <code>data</code>, <code>size</code>, <code>w</code>, <code>h</code>: image format, dimensions and pixel data.
<ul>
<li>the frames are always in top-down <code>bgra8</code> format; use <a href="bitmap.html">bitmap</a> to convert them to other formats.</li>
</ul></li>
<li><code>delay_ms</code>: gif frame delay in milliseconds, for animated gifs.</li>
<li><code>x</code>, <code>y</code>: frame position relative to the top-left corner of the virtual canvas into which to paint the frame. gif frames can have different sizes and different positions than (0,0) but this feature is almost never used.</li>
</ul></li>
</ul>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">[email protected] | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>