oak-team/oak-editor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
ecf2d9cba3f660818c5f8d22e104f75333eb2d0b
oak-editor/docs/html/renderfunctions_8h.html
T
itsmattkc ecf2d9cba3 documented config
2019-02-19 03:57:47 -08:00

183 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Olive: ui/renderfunctions.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">Olive
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_1788f8309b1a812dcb800a185471cf6c.html">ui</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">renderfunctions.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;QOpenGLContext&gt;</code><br />
<code>#include &lt;QVector&gt;</code><br />
<code>#include &lt;QOpenGLShaderProgram&gt;</code><br />
<code>#include &quot;<a class="el" href="sequence_8h_source.html">project/sequence.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="effect_8h_source.html">project/effect.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="viewer_8h_source.html">panels/viewer.h</a>&quot;</code><br />
</div>
<p><a href="renderfunctions_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>
Classes</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="struct_compose_sequence_params.html">ComposeSequenceParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_compose_sequence_params.html" title="The ComposeSequenceParams struct.">ComposeSequenceParams</a> struct. <a href="struct_compose_sequence_params.html#details">More...</a><br /></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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a478845e39064301011d72a81b2a10b57"><td class="memItemLeft" align="right" valign="top">GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57">compose_sequence</a> (<a class="el" href="struct_compose_sequence_params.html">ComposeSequenceParams</a> &amp;params)</td></tr>
<tr class="memdesc:a478845e39064301011d72a81b2a10b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compose a frame of a given sequence. <a href="#a478845e39064301011d72a81b2a10b57">More...</a><br /></td></tr>
<tr class="separator:a478845e39064301011d72a81b2a10b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79288c23c1ade122bc8da2eb0bfde9ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="renderfunctions_8h.html#a79288c23c1ade122bc8da2eb0bfde9ef">compose_audio</a> (<a class="el" href="class_viewer.html">Viewer</a> *viewer, <a class="el" href="clip_8h.html#a2a0d48184294d399b0adc41f6e1de6c7">SequencePtr</a> seq, int playback_speed)</td></tr>
<tr class="memdesc:a79288c23c1ade122bc8da2eb0bfde9ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience wrapper function for <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> to render audio. <a href="#a79288c23c1ade122bc8da2eb0bfde9ef">More...</a><br /></td></tr>
<tr class="separator:a79288c23c1ade122bc8da2eb0bfde9ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a79288c23c1ade122bc8da2eb0bfde9ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79288c23c1ade122bc8da2eb0bfde9ef">&#9670;&nbsp;</a></span>compose_audio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void compose_audio </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_viewer.html">Viewer</a> *&#160;</td>
<td class="paramname"><em>viewer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="clip_8h.html#a2a0d48184294d399b0adc41f6e1de6c7">SequencePtr</a>&#160;</td>
<td class="paramname"><em>seq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>playback_speed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience wrapper function for <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> to render audio. </p>
<p>Much of the functionality provided (and parameters required) by <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> is only useful/necessary for video rendering. For audio rendering, this function is easier to handle and will correctly set up <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> to render audio without the cumbersome effort of setting up a <a class="el" href="struct_compose_sequence_params.html" title="The ComposeSequenceParams struct.">ComposeSequenceParams</a> object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">viewer</td><td>The <a class="el" href="class_viewer.html">Viewer</a> object calling this function</td></tr>
<tr><td class="paramname">seq</td><td>The <a class="el" href="class_sequence.html">Sequence</a> whose audio to render.</td></tr>
<tr><td class="paramname">playback_speed</td><td>The current playback speed (controlled by Shuttle Left/Right) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a478845e39064301011d72a81b2a10b57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a478845e39064301011d72a81b2a10b57">&#9670;&nbsp;</a></span>compose_sequence()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLuint compose_sequence </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_compose_sequence_params.html">ComposeSequenceParams</a> &amp;&#160;</td>
<td class="paramname"><em>params</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compose a frame of a given sequence. </p>
<p>For any given <a class="el" href="class_sequence.html">Sequence</a>, this function will render the current frame indicated by <a class="el" href="class_sequence.html#acc99ebdac07f29be4938cc554eff0bab">Sequence::playhead</a>. Will automatically open and close clips (memory allocation and file handles) as necessary, communicate with the <a class="el" href="class_clip.html#aacbce12bf47dc02acd401405240ced08">Clip::cacher</a> objects to retrieve upcoming frames and store them in memory, run <a class="el" href="class_effect.html">Effect</a> processing functions, and finally composite all the currently active clips together into a final texture.</p>
<p>Will sometimes render a frame incomplete or inaccurately, e.g. if a video file hadn't finished opening by the time of the render or a clip's cacher didn't have the requested frame available at the time of the render. If so, the <code>texture_failed</code> variable of <code>params</code> will be set to <b>TRUE</b>. Check this after calling <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> and if it is <b>TRUE</b>, <a class="el" href="renderfunctions_8h.html#a478845e39064301011d72a81b2a10b57" title="Compose a frame of a given sequence.">compose_sequence()</a> should be called again later to attempt another render (unless the <a class="el" href="class_sequence.html">Sequence</a> is being played, in which case just play the next frame rather than redrawing an old frame).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">params</td><td>A struct of parameters to use while rendering.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the OpenGL texture resulting from the render. Will usually be equal to <a class="el" href="struct_compose_sequence_params.html#afab132e9800988cbc00c774ff68a7a80" title="The attachment to the framebuffer in main_buffer.">ComposeSequenceParams::main_attachment</a> unless it's rendering a nested sequence, in which case it'll be a reference to one of the textures referenced by <a class="el" href="class_clip.html#a93d0efbb1f9dd3dbbf82775a7c3ce9d7">Clip::fbo</a>. Can be used directly to draw the rendered frame. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink