git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 13:43:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__Saver.html
Hermet Park 1336e611c4 doc: updated 
small icon wasn't visible. don't know why...
2022-04-07 23:56:02 +09:00

271 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: Saver</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.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
</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">Saver<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 for exporting a paint object into a specified file.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Saver:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Saver.png" border="0" usemap="#group____ThorVGCapi____Saver" alt=""/></div>
<map name="group____ThorVGCapi____Saver" id="group____ThorVGCapi____Saver">
<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 for exporting a paint object into a specified file." alt="" coords="160,5,219,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:ga6cb67e1b5775c480965e4465f1c9ca80"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Saver.html#ga6cb67e1b5775c480965e4465f1c9ca80">tvg_saver_new</a> ()</td></tr>
<tr class="memdesc:ga6cb67e1b5775c480965e4465f1c9ca80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new Tvg_Saver object. <a href="group__ThorVGCapi__Saver.html#ga6cb67e1b5775c480965e4465f1c9ca80">More...</a><br /></td></tr>
<tr class="separator:ga6cb67e1b5775c480965e4465f1c9ca80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga509981928d383dacc3a3655e161660d5"><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__Saver.html#ga509981928d383dacc3a3655e161660d5">tvg_saver_save</a> (<a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *saver, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const char *path, bool compress)</td></tr>
<tr class="memdesc:ga509981928d383dacc3a3655e161660d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exports the given <code>paint</code> data to the given <code>path</code>. <a href="group__ThorVGCapi__Saver.html#ga509981928d383dacc3a3655e161660d5">More...</a><br /></td></tr>
<tr class="separator:ga509981928d383dacc3a3655e161660d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee7c2b8f317f34d5d365b8cc4275dab6"><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__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6">tvg_saver_sync</a> (<a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *saver)</td></tr>
<tr class="memdesc:gaee7c2b8f317f34d5d365b8cc4275dab6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Guarantees that the saving task is finished. <a href="group__ThorVGCapi__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6">More...</a><br /></td></tr>
<tr class="separator:gaee7c2b8f317f34d5d365b8cc4275dab6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad9a7fbb599d78a5fdc81bb3bca10642c"><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__Saver.html#gad9a7fbb599d78a5fdc81bb3bca10642c">tvg_saver_del</a> (<a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *saver)</td></tr>
<tr class="memdesc:gad9a7fbb599d78a5fdc81bb3bca10642c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the given Tvg_Saver object. <a href="group__ThorVGCapi__Saver.html#gad9a7fbb599d78a5fdc81bb3bca10642c">More...</a><br /></td></tr>
<tr class="separator:gad9a7fbb599d78a5fdc81bb3bca10642c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A module for exporting a paint object into a specified file. </p>
<p>The module enables to save the composed scene and/or image from a paint object. Once it's successfully exported to a file, it can be recreated using the Picture module. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad9a7fbb599d78a5fdc81bb3bca10642c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9a7fbb599d78a5fdc81bb3bca10642c">&#9670;&nbsp;</a></span>tvg_saver_del()</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_saver_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *&#160;</td>
<td class="paramname"><em>saver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the given Tvg_Saver object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">saver</td><td>The Tvg_Saver object to be deleted.</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_Saver pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6cb67e1b5775c480965e4465f1c9ca80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6cb67e1b5775c480965e4465f1c9ca80">&#9670;&nbsp;</a></span>tvg_saver_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#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a>* tvg_saver_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new Tvg_Saver object. </p>
<dl class="section return"><dt>Returns</dt><dd>A new Tvg_Saver object. </dd></dl>
</div>
</div>
<a id="ga509981928d383dacc3a3655e161660d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga509981928d383dacc3a3655e161660d5">&#9670;&nbsp;</a></span>tvg_saver_save()</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_saver_save </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *&#160;</td>
<td class="paramname"><em>saver</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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>compress</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Exports the given <code>paint</code> data to the given <code>path</code>. </p>
<p>If the saver module supports any compression mechanism, it will optimize the data size. This might affect the encoding/decoding time in some cases. You can turn off the compression if you wish to optimize for speed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">saver</td><td>The Tvg_Saver object connected with the saving task. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The paint to be saved with all its associated properties. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>A path to the file, in which the paint data is to be saved. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">compress</td><td>If <code>true</code> then compress data if possible.</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_INSUFFICIENT_CONDITION</td><td>Currently saving other resources. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>Trying to save a file with an unknown extension or in an unsupported format. </td></tr>
<tr><td class="paramname">TVG_RESULT_MEMORY_CORRUPTION</td><td>An internal error. </td></tr>
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>An empty paint is to be saved.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call <a class="el" href="group__ThorVGCapi__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> afterwards. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> </dd></dl>
</div>
</div>
<a id="gaee7c2b8f317f34d5d365b8cc4275dab6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee7c2b8f317f34d5d365b8cc4275dab6">&#9670;&nbsp;</a></span>tvg_saver_sync()</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_saver_sync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *&#160;</td>
<td class="paramname"><em>saver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Guarantees that the saving task is finished. </p>
<p>The behavior of the Saver module works on a sync/async basis, depending on the threading setting of the Initializer. Thus, if you wish to have a benefit of it, you must call <a class="el" href="group__ThorVGCapi__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> after the <a class="el" href="group__ThorVGCapi__Saver.html#ga509981928d383dacc3a3655e161660d5" title="Exports the given paint data to the given path.">tvg_saver_save()</a> in the proper delayed time. Otherwise, you can call <a class="el" href="group__ThorVGCapi__Saver.html#gaee7c2b8f317f34d5d365b8cc4275dab6" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> immediately.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">saver</td><td>The Tvg_Saver object connected with the saving task.</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_INSUFFICIENT_CONDITION</td><td>No saving task is running.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The asynchronous tasking is dependent on the Saver module implementation. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Saver.html#ga509981928d383dacc3a3655e161660d5" title="Exports the given paint data to the given path.">tvg_saver_save()</a> </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.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink