git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 05:33:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__Scene.html
JunsuChoi 8eb3517da8 infra Documentation: Introduce ThorVG documentation page. 
This is a documentation page based on doxygen.

CSS: https://jothepro.github.io/doxygen-awesome-css/
2021-05-25 14:21:09 +09:00

273 lines
15 KiB
HTML
Raw Blame History

<!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>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="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="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="docs_logo.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.1</span>
</div>
<div id="projectbrief">ThorVG is a platform-independent portable library for drawing vector-based scene and animation. It&#39;s an open-source software that is freely used by a variety of software platforms and applications. ThorVG provides neat and easy APIs, its library has no dependencies and keeps cheap and super compact size. It serves as the vector graphics engine for Tizen OS that powers many products.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_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('group__ThorVGCapi__Scene.html','');});
</script>
<div id="doc-content">
<!-- 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 (BETA version)</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">
<center><table><tr><td><img src="group__ThorVGCapi__Scene.png" border="0" alt="" usemap="#group____ThorVGCapi____Scene"/>
<map name="group____ThorVGCapi____Scene" id="group____ThorVGCapi____Scene">
<area shape="rect" id="node1" href="group__ThorVG__CAPI.html" title="ThorVG C language binding APIs. " alt="" coords="5,5,204,32"/>
</map>
</td></tr></table></center>
</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:ga7572898d23143d37faa85cc89ad1625e"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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#ga7572898d23143d37faa85cc89ad1625e">tvg_scene_new</a> ()</td></tr>
<tr class="memdesc:ga7572898d23143d37faa85cc89ad1625e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new scene object. <a href="#ga7572898d23143d37faa85cc89ad1625e">More...</a><br /></td></tr>
<tr class="separator:ga7572898d23143d37faa85cc89ad1625e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b712509a62cf5a3200ecbca53e773d3"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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#ga8b712509a62cf5a3200ecbca53e773d3">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:ga8b712509a62cf5a3200ecbca53e773d3"><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="#ga8b712509a62cf5a3200ecbca53e773d3">More...</a><br /></td></tr>
<tr class="separator:ga8b712509a62cf5a3200ecbca53e773d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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#ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf">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:ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the scene using Tvg_Paint objects. <a href="#ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf">More...</a><br /></td></tr>
<tr class="separator:ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00044cc1d187a83c196debd44eab0248"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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#ga00044cc1d187a83c196debd44eab0248">tvg_scene_clear</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *scene)</td></tr>
<tr class="memdesc:ga00044cc1d187a83c196debd44eab0248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the scene to be zero. (BETA version) <a href="#ga00044cc1d187a83c196debd44eab0248">More...</a><br /></td></tr>
<tr class="separator:ga00044cc1d187a83c196debd44eab0248"><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="ga00044cc1d187a83c196debd44eab0248"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00044cc1d187a83c196debd44eab0248">&#9670;&nbsp;</a></span>tvg_scene_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the total number of the paints pushed into the scene to be zero. (BETA version) </p>
<dl class="section warning"><dt>Warning</dt><dd>Please do not use it, this API is not official one. It could be modified in the next version. </dd></dl>
</div>
</div>
<a id="ga7572898d23143d37faa85cc89ad1625e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7572898d23143d37faa85cc89ad1625e">&#9670;&nbsp;</a></span>tvg_scene_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <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="ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga16cbf3d1bdd02ebfc5a93c5d03f2d6cf">&#9670;&nbsp;</a></span>tvg_scene_push()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <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 drawing targets. If you know the number of pushed objects in the advance, please call <a class="el" href="group__ThorVGCapi__Scene.html#ga8b712509a62cf5a3200ecbca53e773d3" 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>An invalid pointer to the <code>scene</code>. </td></tr>
<tr><td class="paramname">TVG_RESULT_MEMORY_CORRUPTION</td><td>An invalid pointer to the <code>paint</code>. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</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#ga8b712509a62cf5a3200ecbca53e773d3" 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="ga8b712509a62cf5a3200ecbca53e773d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b712509a62cf5a3200ecbca53e773d3">&#9670;&nbsp;</a></span>tvg_scene_reserve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <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_INVALID_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
</table>
</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="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>
Reference in a new issue View git blame Copy permalink