frei0r-plugins-doc 1.6.1-2 / usr / share / frei0r / html / frei0r_8h.html

This file is indexed.

/usr/share/frei0r/html/frei0r_8h.html is in frei0r-plugins-doc 1.6.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>frei0r: frei0r.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">frei0r
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('frei0r_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">frei0r.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This file defines the frei0r api, version 1.2.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;inttypes.h&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for frei0r.h:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="frei0r_8h__incl.png" border="0" usemap="#frei0r_8h" alt=""/></div>
<map name="frei0r_8h" id="frei0r_8h">
</map>
</div>
</div>
<p><a href="frei0r_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__plugin__info.html">f0r_plugin_info</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__color.html">f0r_param_color</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__position.html">f0r_param_position</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structf0r__param__info.html">f0r_param_info</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:afcd0fc5b95d850413af3bdfb1445ce21"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#afcd0fc5b95d850413af3bdfb1445ce21">FREI0R_MAJOR_VERSION</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:afcd0fc5b95d850413af3bdfb1445ce21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e54a139a7cec212f6c1822793a4ef83"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a1e54a139a7cec212f6c1822793a4ef83">FREI0R_MINOR_VERSION</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:a1e54a139a7cec212f6c1822793a4ef83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga021dbc62936693bbe11851a3742b83cc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#ga021dbc62936693bbe11851a3742b83cc">F0R_PLUGIN_TYPE_FILTER</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ga021dbc62936693bbe11851a3742b83cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad190458c6a082108471acf06622a7461"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#gad190458c6a082108471acf06622a7461">F0R_PLUGIN_TYPE_SOURCE</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:gad190458c6a082108471acf06622a7461"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1896fc1cdaf7a505de359b3d07aba70"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#gae1896fc1cdaf7a505de359b3d07aba70">F0R_PLUGIN_TYPE_MIXER2</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:gae1896fc1cdaf7a505de359b3d07aba70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a6629bc9fd08cf104749ad9d0922501"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#ga4a6629bc9fd08cf104749ad9d0922501">F0R_PLUGIN_TYPE_MIXER3</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:ga4a6629bc9fd08cf104749ad9d0922501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ff9ca3b84e5057b0b7aeee176d6d3a3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga4ff9ca3b84e5057b0b7aeee176d6d3a3">F0R_COLOR_MODEL_BGRA8888</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ga4ff9ca3b84e5057b0b7aeee176d6d3a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga68d6ca25df33b7759dfb2c2f6b44a229"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga68d6ca25df33b7759dfb2c2f6b44a229">F0R_COLOR_MODEL_RGBA8888</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ga68d6ca25df33b7759dfb2c2f6b44a229"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42c9b2342651a04a3045b980cf31cf97"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html#ga42c9b2342651a04a3045b980cf31cf97">F0R_COLOR_MODEL_PACKED32</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ga42c9b2342651a04a3045b980cf31cf97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54c75dadceec79650fd657a8169e9e65"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga54c75dadceec79650fd657a8169e9e65">F0R_PARAM_BOOL</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ga54c75dadceec79650fd657a8169e9e65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac82c5dc961327356885a4a0ea513e550"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#gac82c5dc961327356885a4a0ea513e550">F0R_PARAM_DOUBLE</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:gac82c5dc961327356885a4a0ea513e550"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78782f633dbf887c9496996f47b57091"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga78782f633dbf887c9496996f47b57091">F0R_PARAM_COLOR</a>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ga78782f633dbf887c9496996f47b57091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga86d6e746595a6358b90b0d73f9b76c59"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga86d6e746595a6358b90b0d73f9b76c59">F0R_PARAM_POSITION</a>&#160;&#160;&#160;3</td></tr>
<tr class="separator:ga86d6e746595a6358b90b0d73f9b76c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac686a9c6d5a1b3d7c0beb51d7f64f960"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#gac686a9c6d5a1b3d7c0beb51d7f64f960">F0R_PARAM_STRING</a>&#160;&#160;&#160;4</td></tr>
<tr class="separator:gac686a9c6d5a1b3d7c0beb51d7f64f960"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7beb0755906a8a96b3af5285ae11036c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structf0r__plugin__info.html">f0r_plugin_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a7beb0755906a8a96b3af5285ae11036c">f0r_plugin_info_t</a></td></tr>
<tr class="separator:a7beb0755906a8a96b3af5285ae11036c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga863edbb51211153c1a5bc89128b2eedb"><td class="memItemLeft" align="right" valign="top">typedef double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga863edbb51211153c1a5bc89128b2eedb">f0r_param_bool</a></td></tr>
<tr class="separator:ga863edbb51211153c1a5bc89128b2eedb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05eba906a358ba2e64a0bd55e8a287c9"><td class="memItemLeft" align="right" valign="top">typedef double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga05eba906a358ba2e64a0bd55e8a287c9">f0r_param_double</a></td></tr>
<tr class="separator:ga05eba906a358ba2e64a0bd55e8a287c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga535ba3bc18763f2e82840e2a095dd0a9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structf0r__param__color.html">f0r_param_color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga535ba3bc18763f2e82840e2a095dd0a9">f0r_param_color_t</a></td></tr>
<tr class="separator:ga535ba3bc18763f2e82840e2a095dd0a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaafb6c83aa00cfce5556e8d8cd14bdf7"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structf0r__param__position.html">f0r_param_position</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#gaaafb6c83aa00cfce5556e8d8cd14bdf7">f0r_param_position_t</a></td></tr>
<tr class="separator:gaaafb6c83aa00cfce5556e8d8cd14bdf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8c277b75c2d22fa9f0120bb9786cca98"><td class="memItemLeft" align="right" valign="top">typedef char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_a_r_a_m___t_y_p_e.html#ga8c277b75c2d22fa9f0120bb9786cca98">f0r_param_string</a></td></tr>
<tr class="separator:ga8c277b75c2d22fa9f0120bb9786cca98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73d753d06abe741965ef87e3553c399a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structf0r__param__info.html">f0r_param_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a73d753d06abe741965ef87e3553c399a">f0r_param_info_t</a></td></tr>
<tr class="separator:a73d753d06abe741965ef87e3553c399a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf4b514489e1a1399f23919d467fa7f2"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a></td></tr>
<tr class="separator:aaf4b514489e1a1399f23919d467fa7f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b52f1c6691d7d8796d002df2454f5bb"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a></td></tr>
<tr class="separator:a2b52f1c6691d7d8796d002df2454f5bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a78b1e4451bf40bb8f80fdae871f2e750"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a78b1e4451bf40bb8f80fdae871f2e750">f0r_init</a> ()</td></tr>
<tr class="separator:a78b1e4451bf40bb8f80fdae871f2e750"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0485f00015a2b09b8733df004f62db69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a0485f00015a2b09b8733df004f62db69">f0r_deinit</a> ()</td></tr>
<tr class="separator:a0485f00015a2b09b8733df004f62db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d451ee1940d8bfeb33311db569321f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a8d451ee1940d8bfeb33311db569321f4">f0r_get_plugin_info</a> (<a class="el" href="frei0r_8h.html#a7beb0755906a8a96b3af5285ae11036c">f0r_plugin_info_t</a> *info)</td></tr>
<tr class="separator:a8d451ee1940d8bfeb33311db569321f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a503bb60dcd8c29e8a715ab0e1a4033d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a503bb60dcd8c29e8a715ab0e1a4033d6">f0r_get_param_info</a> (<a class="el" href="frei0r_8h.html#a73d753d06abe741965ef87e3553c399a">f0r_param_info_t</a> *info, int param_index)</td></tr>
<tr class="separator:a503bb60dcd8c29e8a715ab0e1a4033d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7765bbd77add97b318c09e2aba0724b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#ac7765bbd77add97b318c09e2aba0724b">f0r_construct</a> (unsigned int width, unsigned int height)</td></tr>
<tr class="separator:ac7765bbd77add97b318c09e2aba0724b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31acce9390816a464c2d24458d9b76c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a31acce9390816a464c2d24458d9b76c6">f0r_destruct</a> (<a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> instance)</td></tr>
<tr class="separator:a31acce9390816a464c2d24458d9b76c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6942176959bf76d97719d844799997d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#ab6942176959bf76d97719d844799997d">f0r_set_param_value</a> (<a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> instance, <a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a> param, int param_index)</td></tr>
<tr class="separator:ab6942176959bf76d97719d844799997d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f0db6a26747279bf507413ebee2a599"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a7f0db6a26747279bf507413ebee2a599">f0r_get_param_value</a> (<a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> instance, <a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a> param, int param_index)</td></tr>
<tr class="separator:a7f0db6a26747279bf507413ebee2a599"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ddea8bcbfd15affc084f669c0140857"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a7ddea8bcbfd15affc084f669c0140857">f0r_update</a> (<a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> instance, double time, const uint32_t *inframe, uint32_t *outframe)</td></tr>
<tr class="separator:a7ddea8bcbfd15affc084f669c0140857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c0f4d80066aeedc695732c6f929183d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="frei0r_8h.html#a5c0f4d80066aeedc695732c6f929183d">f0r_update2</a> (<a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> instance, double time, const uint32_t *inframe1, const uint32_t *inframe2, const uint32_t *inframe3, uint32_t *outframe)</td></tr>
<tr class="separator:a5c0f4d80066aeedc695732c6f929183d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the frei0r api, version 1.2. </p>
<p>A conforming plugin must implement and export all functions declared in this header.</p>
<p>A conforming application must accept only those plugins which use allowed values for the described fields. </p>

<p class="definition">Definition in file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="afcd0fc5b95d850413af3bdfb1445ce21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcd0fc5b95d850413af3bdfb1445ce21">&#9670;&nbsp;</a></span>FREI0R_MAJOR_VERSION</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FREI0R_MAJOR_VERSION&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The frei0r API major version </p>

<p class="definition">Definition at line <a class="el" href="frei0r_8h_source.html#l00217">217</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>

</div>
</div>
<a id="a1e54a139a7cec212f6c1822793a4ef83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e54a139a7cec212f6c1822793a4ef83">&#9670;&nbsp;</a></span>FREI0R_MINOR_VERSION</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FREI0R_MINOR_VERSION&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The frei0r API minor version </p>

<p class="definition">Definition at line <a class="el" href="frei0r_8h_source.html#l00222">222</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aaf4b514489e1a1399f23919d467fa7f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf4b514489e1a1399f23919d467fa7f2">&#9670;&nbsp;</a></span>f0r_instance_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void* <a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Transparent instance pointer of the frei0r effect. </p>

<p class="definition">Definition at line <a class="el" href="frei0r_8h_source.html#l00470">470</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>

</div>
</div>
<a id="a73d753d06abe741965ef87e3553c399a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73d753d06abe741965ef87e3553c399a">&#9670;&nbsp;</a></span>f0r_param_info_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structf0r__param__info.html">f0r_param_info</a>  <a class="el" href="frei0r_8h.html#a73d753d06abe741965ef87e3553c399a">f0r_param_info_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Similar to f0r_plugin_info_t, this structure is filled by the plugin for every parameter.</p>
<p>All strings are unicode, 0-terminated, and the encoding is utf-8. </p>

</div>
</div>
<a id="a2b52f1c6691d7d8796d002df2454f5bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b52f1c6691d7d8796d002df2454f5bb">&#9670;&nbsp;</a></span>f0r_param_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void* <a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Transparent parameter handle. </p>

<p class="definition">Definition at line <a class="el" href="frei0r_8h_source.html#l00502">502</a> of file <a class="el" href="frei0r_8h_source.html">frei0r.h</a>.</p>

</div>
</div>
<a id="a7beb0755906a8a96b3af5285ae11036c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7beb0755906a8a96b3af5285ae11036c">&#9670;&nbsp;</a></span>f0r_plugin_info_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structf0r__plugin__info.html">f0r_plugin_info</a>  <a class="el" href="frei0r_8h.html#a7beb0755906a8a96b3af5285ae11036c">f0r_plugin_info_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The f0r_plugin_info_t structure is filled in by the plugin to tell the application about its name, type, number of parameters, and version.</p>
<p>An application should ignore (i.e. not use) frei0r effects that have unknown values in the plugin_type or color_model field. It should also ignore effects with a too high frei0r_version.</p>
<p>This is necessary to be able to extend the frei0r spec (e.g. by adding new color models or plugin types) in a way that does not result in crashes when loading effects that make use of these extensions into an older application.</p>
<p>All strings are unicode, 0-terminated, and the encoding is utf-8. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac7765bbd77add97b318c09e2aba0724b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7765bbd77add97b318c09e2aba0724b">&#9670;&nbsp;</a></span>f0r_construct()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a> f0r_construct </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>width</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>height</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor for effect instances. The plugin returns a pointer to its internal instance structure.</p>
<p>The resolution must be an integer multiple of 8, must be greater than 0 and be at most 2048 in both dimensions. The plugin must set default values for all parameters in this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">width</td><td>The x-resolution of the processed video frames </td></tr>
    <tr><td class="paramname">height</td><td>The y-resolution of the processed video frames </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on failure or a pointer != 0 on success</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a31acce9390816a464c2d24458d9b76c6">f0r_destruct</a> </dd></dl>

</div>
</div>
<a id="a0485f00015a2b09b8733df004f62db69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0485f00015a2b09b8733df004f62db69">&#9670;&nbsp;</a></span>f0r_deinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_deinit </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>f0r_deinit is called once when the plugin is unloaded by the application. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a78b1e4451bf40bb8f80fdae871f2e750">f0r_init</a> </dd></dl>

</div>
</div>
<a id="a31acce9390816a464c2d24458d9b76c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31acce9390816a464c2d24458d9b76c6">&#9670;&nbsp;</a></span>f0r_destruct()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_destruct </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td>
          <td class="paramname"><em>instance</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroys an effect instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>The pointer to the plugins internal instance structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#ac7765bbd77add97b318c09e2aba0724b">f0r_construct</a> </dd></dl>

</div>
</div>
<a id="a503bb60dcd8c29e8a715ab0e1a4033d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a503bb60dcd8c29e8a715ab0e1a4033d6">&#9670;&nbsp;</a></span>f0r_get_param_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_get_param_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#a73d753d06abe741965ef87e3553c399a">f0r_param_info_t</a> *&#160;</td>
          <td class="paramname"><em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>param_index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>f0r_get_param_info is called by the application to query the type of each parameter.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">info</td><td>is allocated by the application and filled by the plugin </td></tr>
    <tr><td class="paramname">param_index</td><td>the index of the parameter to be queried (from 0 to num_params-1) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7f0db6a26747279bf507413ebee2a599"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f0db6a26747279bf507413ebee2a599">&#9670;&nbsp;</a></span>f0r_get_param_value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_get_param_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td>
          <td class="paramname"><em>instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a>&#160;</td>
          <td class="paramname"><em>param</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>param_index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function allows the application to query the parameter values of an effect instance.</p>
<p>If the parameter type is of F0R_PARAM_STRING, then the caller should supply a pointer to f0r_param_string (char**). The plugin sets the pointer to the address of its copy of the parameter value. Therefore, the caller should not free the result. If the caller needs to modify the value, it should make a copy of it and modify before calling <a class="el" href="frei0r_8h.html#ab6942176959bf76d97719d844799997d">f0r_set_param_value()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>the effect instance </td></tr>
    <tr><td class="paramname">param</td><td>pointer to the parameter value </td></tr>
    <tr><td class="paramname">param_index</td><td>index of the parameter</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#ab6942176959bf76d97719d844799997d">f0r_set_param_value</a> </dd></dl>

</div>
</div>
<a id="a8d451ee1940d8bfeb33311db569321f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d451ee1940d8bfeb33311db569321f4">&#9670;&nbsp;</a></span>f0r_get_plugin_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_get_plugin_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#a7beb0755906a8a96b3af5285ae11036c">f0r_plugin_info_t</a> *&#160;</td>
          <td class="paramname"><em>info</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Is called once after init. The plugin has to fill in the values in info.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">info</td><td>Pointer to an info struct allocated by the application. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a78b1e4451bf40bb8f80fdae871f2e750"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78b1e4451bf40bb8f80fdae871f2e750">&#9670;&nbsp;</a></span>f0r_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int f0r_init </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p><a class="el" href="frei0r_8h.html#a78b1e4451bf40bb8f80fdae871f2e750">f0r_init()</a> is called once when the plugin is loaded by the application. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a0485f00015a2b09b8733df004f62db69">f0r_deinit</a> </dd></dl>

</div>
</div>
<a id="ab6942176959bf76d97719d844799997d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6942176959bf76d97719d844799997d">&#9670;&nbsp;</a></span>f0r_set_param_value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_set_param_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td>
          <td class="paramname"><em>instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#a2b52f1c6691d7d8796d002df2454f5bb">f0r_param_t</a>&#160;</td>
          <td class="paramname"><em>param</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>param_index</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function allows the application to set the parameter values of an effect instance. Validity of the parameter pointer is handled by the application thus the data must be copied by the effect.</p>
<p>If the parameter type is of F0R_PARAM_STRING, then the caller should supply a pointer to f0r_param_string (char**). The plugin must copy copy the string and not assume it exists beyond the lifetime of the call. The reason a double pointer is requested when only a single is really needed is simply for API consistency.</p>
<p>Furthermore, if an update event/signal is needed in a host application to notice when parameters have changed, this should be implemented inside its own update() call. The host application would presumably need to store the current value as well to see if it changes; to make this thread safe, it should store a copy of the current value in a struct which uses instance as a key.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>the effect instance </td></tr>
    <tr><td class="paramname">param</td><td>pointer to the parameter value </td></tr>
    <tr><td class="paramname">param_index</td><td>index of the parameter</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a7f0db6a26747279bf507413ebee2a599">f0r_get_param_value</a> </dd></dl>

</div>
</div>
<a id="a7ddea8bcbfd15affc084f669c0140857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ddea8bcbfd15affc084f669c0140857">&#9670;&nbsp;</a></span>f0r_update()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_update </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td>
          <td class="paramname"><em>instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>time</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t *&#160;</td>
          <td class="paramname"><em>inframe</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>outframe</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This is where the core effect processing happens. The application calls it after it has set the necessary parameter values. inframe and outframe must be aligned to an integer multiple of 16 bytes in memory.</p>
<p>This funcition should not alter the parameters of the effect in any way (<a class="el" href="frei0r_8h.html#a7f0db6a26747279bf507413ebee2a599">f0r_get_param_value</a> should return the same values after a call to <a class="el" href="frei0r_8h.html#a7ddea8bcbfd15affc084f669c0140857">f0r_update</a> as before the call).</p>
<p>The function is responsible to restore the fpu state (e.g. rounding mode) and mmx state if applicable before it returns to the caller.</p>
<p>The host mustn't call <a class="el" href="frei0r_8h.html#a7ddea8bcbfd15affc084f669c0140857">f0r_update</a> for effects of type <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#gae1896fc1cdaf7a505de359b3d07aba70">F0R_PLUGIN_TYPE_MIXER2</a> and <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#ga4a6629bc9fd08cf104749ad9d0922501">F0R_PLUGIN_TYPE_MIXER3</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>the effect instance </td></tr>
    <tr><td class="paramname">time</td><td>the application time in seconds but with subsecond resolution (e.g. milli-second resolution). The resolution should be at least the inter-frame period of the application. </td></tr>
    <tr><td class="paramname">inframe</td><td>the incoming video frame (can be zero for sources) </td></tr>
    <tr><td class="paramname">outframe</td><td>the resulting video frame</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a5c0f4d80066aeedc695732c6f929183d">f0r_update2</a> </dd></dl>

</div>
</div>
<a id="a5c0f4d80066aeedc695732c6f929183d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c0f4d80066aeedc695732c6f929183d">&#9670;&nbsp;</a></span>f0r_update2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void f0r_update2 </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="frei0r_8h.html#aaf4b514489e1a1399f23919d467fa7f2">f0r_instance_t</a>&#160;</td>
          <td class="paramname"><em>instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>time</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t *&#160;</td>
          <td class="paramname"><em>inframe1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t *&#160;</td>
          <td class="paramname"><em>inframe2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint32_t *&#160;</td>
          <td class="paramname"><em>inframe3</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>outframe</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>For effects of type <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#gad190458c6a082108471acf06622a7461">F0R_PLUGIN_TYPE_SOURCE</a> or <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#ga021dbc62936693bbe11851a3742b83cc">F0R_PLUGIN_TYPE_FILTER</a> this method is optional. The <a class="el" href="frei0r_8h.html#a7ddea8bcbfd15affc084f669c0140857">f0r_update</a> method must still be exported for these two effect types. If both are provided the behavior of them must be the same.</p>
<p>Effects of type <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#gae1896fc1cdaf7a505de359b3d07aba70">F0R_PLUGIN_TYPE_MIXER2</a> or <a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html#ga4a6629bc9fd08cf104749ad9d0922501">F0R_PLUGIN_TYPE_MIXER3</a> must provide the new <a class="el" href="frei0r_8h.html#a5c0f4d80066aeedc695732c6f929183d">f0r_update2</a> method.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>the effect instance </td></tr>
    <tr><td class="paramname">time</td><td>the application time in seconds but with subsecond resolution (e.g. milli-second resolution). The resolution should be at least the inter-frame period of the application. </td></tr>
    <tr><td class="paramname">inframe1</td><td>the first incoming video frame (can be zero for sources) </td></tr>
    <tr><td class="paramname">inframe2</td><td>the second incoming video frame (can be zero for sources and filters) </td></tr>
    <tr><td class="paramname">inframe3</td><td>the third incoming video frame (can be zero for sources, filters and mixer2) </td></tr>
    <tr><td class="paramname">outframe</td><td>the resulting video frame</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="frei0r_8h.html#a7ddea8bcbfd15affc084f669c0140857">f0r_update</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="frei0r_8h.html">frei0r.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.