git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 21:53:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__Scene.html
Hermet Park 2d0ef20ab1 doc: up-to-update
2023-05-10 14:35:42 +09:00

275 lines
16 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: Scene</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" />
<link href="doxygen-awesome.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="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Scene<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A module managing the multiple paints as one group paint.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Scene:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Scene.png" border="0" usemap="#agroup____ThorVGCapi____Scene" alt=""/></div>
<map name="agroup____ThorVGCapi____Scene" id="agroup____ThorVGCapi____Scene">
<area shape="rect" href="group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" title="A module managing the multiple paints as one group paint." alt="" coords="160,5,221,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga21f41993400bc0bfaad2314e584fc62d"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Scene.html#ga21f41993400bc0bfaad2314e584fc62d">tvg_scene_new</a> ()</td></tr>
<tr class="memdesc:ga21f41993400bc0bfaad2314e584fc62d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new scene object. <a href="group__ThorVGCapi__Scene.html#ga21f41993400bc0bfaad2314e584fc62d">More...</a><br /></td></tr>
<tr class="separator:ga21f41993400bc0bfaad2314e584fc62d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04748446be3c527b31f20bee995b25a5"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Scene.html#ga04748446be3c527b31f20bee995b25a5">tvg_scene_reserve</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *scene, uint32_t size)</td></tr>
<tr class="memdesc:ga04748446be3c527b31f20bee995b25a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the size of the container, where all the paints pushed into the scene are stored. <a href="group__ThorVGCapi__Scene.html#ga04748446be3c527b31f20bee995b25a5">More...</a><br /></td></tr>
<tr class="separator:ga04748446be3c527b31f20bee995b25a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb7b49fea2b5f93fe0787255e5552143"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Scene.html#gaeb7b49fea2b5f93fe0787255e5552143">tvg_scene_push</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *scene, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
<tr class="memdesc:gaeb7b49fea2b5f93fe0787255e5552143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the scene using Tvg_Paint objects. <a href="group__ThorVGCapi__Scene.html#gaeb7b49fea2b5f93fe0787255e5552143">More...</a><br /></td></tr>
<tr class="separator:gaeb7b49fea2b5f93fe0787255e5552143"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca0ceb2a0740d6a22bf78525d55416dd"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Scene.html#gaca0ceb2a0740d6a22bf78525d55416dd">tvg_scene_clear</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *scene, bool free)</td></tr>
<tr class="memdesc:gaca0ceb2a0740d6a22bf78525d55416dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears a Tvg_Scene objects from pushed paints. <a href="group__ThorVGCapi__Scene.html#gaca0ceb2a0740d6a22bf78525d55416dd">More...</a><br /></td></tr>
<tr class="separator:gaca0ceb2a0740d6a22bf78525d55416dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A module managing the multiple paints as one group paint. </p>
<p>As a group, scene can be transformed, translucent, composited with other target paints, its children will be affected by the scene world. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaca0ceb2a0740d6a22bf78525d55416dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca0ceb2a0740d6a22bf78525d55416dd">&#9670;&nbsp;</a></span>tvg_scene_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_scene_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td>
<td class="paramname"><em>scene</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>free</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears a Tvg_Scene objects from pushed paints. </p>
<p>Tvg_Paint objects stored in the scene are released if <code>free</code> is set to <code>true</code>, otherwise the memory is not deallocated and all paints should be released manually in order to avoid memory leaks.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scene</td><td>The Tvg_Scene object to be cleared. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">free</td><td>If <code>true</code> the memory occupied by paints is deallocated, otherwise it is not.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result enumeration. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TVG_RESULT_SUCCESS</td><td>Succeed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>An invalid Tvg_Canvas pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Please use the <code>free</code> argument only when you know how it works, otherwise it's not recommended. </dd></dl>
</div>
</div>
<a id="ga21f41993400bc0bfaad2314e584fc62d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21f41993400bc0bfaad2314e584fc62d">&#9670;&nbsp;</a></span>tvg_scene_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* tvg_scene_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new scene object. </p>
<p>A scene object is used to group many paints into one object, which can be manipulated using TVG APIs.</p>
<dl class="section return"><dt>Returns</dt><dd>A new scene object. </dd></dl>
</div>
</div>
<a id="gaeb7b49fea2b5f93fe0787255e5552143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb7b49fea2b5f93fe0787255e5552143">&#9670;&nbsp;</a></span>tvg_scene_push()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_scene_push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td>
<td class="paramname"><em>scene</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td>
<td class="paramname"><em>paint</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Passes drawing elements to the scene using Tvg_Paint objects. </p>
<p>Only the paints pushed into the scene will be the drawn targets. The paints are retained by the scene until the <a class="el" href="group__ThorVGCapi__Scene.html#gaca0ceb2a0740d6a22bf78525d55416dd" title="Clears a Tvg_Scene objects from pushed paints.">tvg_scene_clear()</a> is called. If you know the number of pushed objects in advance, please call <a class="el" href="group__ThorVGCapi__Scene.html#ga04748446be3c527b31f20bee995b25a5" title="Sets the size of the container, where all the paints pushed into the scene are stored.">tvg_scene_reserve()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scene</td><td>A Tvg_Paint pointer to the scene object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>A graphical object to be drawn.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result enumeration. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TVG_RESULT_SUCCESS</td><td>Succeed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>A <code>nullptr</code> passed as the argument. </td></tr>
<tr><td class="paramname">TVG_RESULT_MEMORY_CORRUPTION</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The rendering order of the paints is the same as the order as they were pushed. Consider sorting the paints before pushing them if you intend to use layering. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Scene.html#ga04748446be3c527b31f20bee995b25a5" title="Sets the size of the container, where all the paints pushed into the scene are stored.">tvg_scene_reserve()</a> </dd></dl>
</div>
</div>
<a id="ga04748446be3c527b31f20bee995b25a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04748446be3c527b31f20bee995b25a5">&#9670;&nbsp;</a></span>tvg_scene_reserve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_scene_reserve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td>
<td class="paramname"><em>scene</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size of the container, where all the paints pushed into the scene are stored. </p>
<p>If the number of objects pushed into the scene is known in advance, calling the function prevents multiple memory reallocation, thus improving the performance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scene</td><td>A Tvg_Paint pointer to the scene object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The number of objects for which the memory is to be reserved.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result enumeration. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TVG_RESULT_SUCCESS</td><td>Succeed. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with a memory allocation. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink