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__Picture.html
Hermet Park d522e37565 release: update the docs
2023-07-29 14:24:37 +09:00

439 lines
23 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: 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="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>
<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="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.10</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 -->
<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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__ThorVGCapi__Picture.html',''); initResizable(); });
/* @license-end */
</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">Picture<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 enabling to create and to load an image in one of the supported formats: svg, png, jpg and raw.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Picture:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Picture.png" border="0" usemap="#agroup____ThorVGCapi____Picture" alt=""/></div>
<map name="agroup____ThorVGCapi____Picture" id="agroup____ThorVGCapi____Picture">
<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 enabling to create and to load an image in one of the supported formats: svg,..." alt="" coords="160,5,227,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:gaf90992d1e0e0a2db14e693d038ac732d"><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__Picture.html#gaf90992d1e0e0a2db14e693d038ac732d">tvg_picture_new</a> ()</td></tr>
<tr class="memdesc:gaf90992d1e0e0a2db14e693d038ac732d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new picture object. <a href="group__ThorVGCapi__Picture.html#gaf90992d1e0e0a2db14e693d038ac732d">More...</a><br /></td></tr>
<tr class="separator:gaf90992d1e0e0a2db14e693d038ac732d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ddef61976baa7575ac5c5f69286eae6"><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__Picture.html#ga7ddef61976baa7575ac5c5f69286eae6">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:ga7ddef61976baa7575ac5c5f69286eae6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data directly from a file. <a href="group__ThorVGCapi__Picture.html#ga7ddef61976baa7575ac5c5f69286eae6">More...</a><br /></td></tr>
<tr class="separator:ga7ddef61976baa7575ac5c5f69286eae6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae8e02c89758ef1d31adf414ed33c0485"><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__Picture.html#gae8e02c89758ef1d31adf414ed33c0485">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:gae8e02c89758ef1d31adf414ed33c0485"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="group__ThorVGCapi__Picture.html#gae8e02c89758ef1d31adf414ed33c0485">More...</a><br /></td></tr>
<tr class="separator:gae8e02c89758ef1d31adf414ed33c0485"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23f114ec390b62e7057af05c084605f7"><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__Picture.html#ga23f114ec390b62e7057af05c084605f7">tvg_picture_load_data</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const char *data, uint32_t size, const char *mimetype, bool copy)</td></tr>
<tr class="memdesc:ga23f114ec390b62e7057af05c084605f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="group__ThorVGCapi__Picture.html#ga23f114ec390b62e7057af05c084605f7">More...</a><br /></td></tr>
<tr class="separator:ga23f114ec390b62e7057af05c084605f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafcc895de0a4040d15824d788d9b23d98"><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__Picture.html#gafcc895de0a4040d15824d788d9b23d98">tvg_picture_set_size</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float w, float h)</td></tr>
<tr class="memdesc:gafcc895de0a4040d15824d788d9b23d98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resizes the picture content to the given width and height. <a href="group__ThorVGCapi__Picture.html#gafcc895de0a4040d15824d788d9b23d98">More...</a><br /></td></tr>
<tr class="separator:gafcc895de0a4040d15824d788d9b23d98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3cb3080c20e0f8f564fe96fa0eecf99"><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__Picture.html#gae3cb3080c20e0f8f564fe96fa0eecf99">tvg_picture_get_size</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float *w, float *h)</td></tr>
<tr class="memdesc:gae3cb3080c20e0f8f564fe96fa0eecf99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the loaded picture. <a href="group__ThorVGCapi__Picture.html#gae3cb3080c20e0f8f564fe96fa0eecf99">More...</a><br /></td></tr>
<tr class="separator:gae3cb3080c20e0f8f564fe96fa0eecf99"><td class="memSeparator" colspan="2">&#160;</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, jpg and raw. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae3cb3080c20e0f8f564fe96fa0eecf99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae3cb3080c20e0f8f564fe96fa0eecf99">&#9670;&nbsp;</a></span>tvg_picture_get_size()</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_picture_get_size </td>
<td>(</td>
<td class="paramtype">const <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">float *&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the loaded picture. </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">[out]</td><td class="paramname">w</td><td>A width of the image in pixels. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">h</td><td>A height of the image in pixels.</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>
<a id="ga7ddef61976baa7575ac5c5f69286eae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ddef61976baa7575ac5c5f69286eae6">&#9670;&nbsp;</a></span>tvg_picture_load()</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_picture_load </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>&#160;</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="ga23f114ec390b62e7057af05c084605f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23f114ec390b62e7057af05c084605f7">&#9670;&nbsp;</a></span>tvg_picture_load_data()</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_picture_load_data </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>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>mimetype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>copy</em>&#160;</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. </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">data</td><td>A pointer to a memory location where the content of the picture file is stored. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size in bytes of the memory occupied by the <code>data</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mimetype</td><td>Mimetype or extension of data such as "jpg", "jpeg", "svg", "svg+xml", "png", etc. In case an empty string or an unknown type is provided, the loaders will be tried one by one. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>If <code>true</code> the data are copied into the engine local buffer, otherwise they are 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>In case a <code>nullptr</code> is passed as the argument or the <code>size</code> is zero or less. </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>
<dl class="section warning"><dt>Warning</dt><dd>: It's the user responsibility to release the <code>data</code> memory if the <code>copy</code> is <code>true</code>. </dd></dl>
</div>
</div>
<a id="gae8e02c89758ef1d31adf414ed33c0485"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8e02c89758ef1d31adf414ed33c0485">&#9670;&nbsp;</a></span>tvg_picture_load_raw()</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_picture_load_raw </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">uint32_t *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>copy</em>&#160;</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. </p>
<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 no data are provided or the <code>width</code> or <code>height</code> value is zero or less. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>A problem with memory allocation occurs. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>An error occurs at a later stage.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</div>
</div>
<a id="gaf90992d1e0e0a2db14e693d038ac732d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf90992d1e0e0a2db14e693d038ac732d">&#9670;&nbsp;</a></span>tvg_picture_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_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>
<a id="gafcc895de0a4040d15824d788d9b23d98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcc895de0a4040d15824d788d9b23d98">&#9670;&nbsp;</a></span>tvg_picture_set_size()</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_picture_set_size </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">float&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resizes the picture content to the given width and height. </p>
<p>The picture content is resized while keeping the default size aspect ratio. The scaling factor is established for each of dimensions and the smaller value is applied to both of them.</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">w</td><td>A new width of the image in pixels. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A new height of the image in pixels.</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>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>An internal error. </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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink