mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-08 13:43:43 +00:00
274 lines
13 KiB
HTML
274 lines
13 KiB
HTML
<!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: Picture</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.svg"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ThorVG
|
|
 <span id="projectnumber">v0.1</span>
|
|
</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 -->
|
|
<!-- 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">Picture<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 enabling to create and to load an image in one of the supported formats: svg, png and raw.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Picture:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group__ThorVGCapi__Picture.png" border="0" alt="" usemap="#group____ThorVGCapi____Picture"/>
|
|
<map name="group____ThorVGCapi____Picture" id="group____ThorVGCapi____Picture">
|
|
<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:gaeb31f27827d96269a3c4d251a45215b6"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Picture.html#gaeb31f27827d96269a3c4d251a45215b6">tvg_picture_new</a> ()</td></tr>
|
|
<tr class="memdesc:gaeb31f27827d96269a3c4d251a45215b6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new picture object. <a href="#gaeb31f27827d96269a3c4d251a45215b6">More...</a><br /></td></tr>
|
|
<tr class="separator:gaeb31f27827d96269a3c4d251a45215b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa101b96db706db4edd10a65da628a1ef"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Picture.html#gaa101b96db706db4edd10a65da628a1ef">tvg_picture_load</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const char *path)</td></tr>
|
|
<tr class="memdesc:gaa101b96db706db4edd10a65da628a1ef"><td class="mdescLeft"> </td><td class="mdescRight">Loads a picture data directly from a file. <a href="#gaa101b96db706db4edd10a65da628a1ef">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa101b96db706db4edd10a65da628a1ef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6c05096bb5d5074bff0fdbbb13a587f8"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Picture.html#ga6c05096bb5d5074bff0fdbbb13a587f8">tvg_picture_load_raw</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, uint32_t *data, uint32_t w, uint32_t h, bool copy)</td></tr>
|
|
<tr class="memdesc:ga6c05096bb5d5074bff0fdbbb13a587f8"><td class="mdescLeft"> </td><td class="mdescRight">Loads a picture data from a memory block of a given size. (BETA version) <a href="#ga6c05096bb5d5074bff0fdbbb13a587f8">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6c05096bb5d5074bff0fdbbb13a587f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4a3950f95a05cbc29e869d7d5071aeb9"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Picture.html#ga4a3950f95a05cbc29e869d7d5071aeb9">tvg_picture_get_viewbox</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float *x, float *y, float *w, float *h)</td></tr>
|
|
<tr class="memdesc:ga4a3950f95a05cbc29e869d7d5071aeb9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the position and the size of the loaded picture. (BETA version) <a href="#ga4a3950f95a05cbc29e869d7d5071aeb9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4a3950f95a05cbc29e869d7d5071aeb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>A module enabling to create and to load an image in one of the supported formats: svg, png and raw. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga4a3950f95a05cbc29e869d7d5071aeb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4a3950f95a05cbc29e869d7d5071aeb9">◆ </a></span>tvg_picture_get_viewbox()</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_picture_get_viewbox </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>h</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the position and the size of the loaded picture. (BETA version) </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Please do not use it, this API is not official one. It can be modified in the next version. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa101b96db706db4edd10a65da628a1ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa101b96db706db4edd10a65da628a1ef">◆ </a></span>tvg_picture_load()</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_picture_load </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>path</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads a picture data directly from a file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>A Tvg_Paint pointer to the picture object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The absolute path to the image file.</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 or an empty <code>path</code>. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>A file with an unknown extension. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>An error at a later stage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6c05096bb5d5074bff0fdbbb13a587f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6c05096bb5d5074bff0fdbbb13a587f8">◆ </a></span>tvg_picture_load_raw()</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_picture_load_raw </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>copy</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads a picture data from a memory block of a given size. (BETA version) </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Please do not use it, this API is not official one. It can be modified in the next version. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaeb31f27827d96269a3c4d251a45215b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaeb31f27827d96269a3c4d251a45215b6">◆ </a></span>tvg_picture_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_picture_new </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new picture object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A new picture object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|