git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-07 21:23:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__SwCanvas.html

204 lines
12 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: SwCanvas</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
&#160;<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">SwCanvas<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI (BETA version)</a> &raquo; <a class="el" href="group__ThorVGCapi__Canvas.html">Canvas</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A module for rendering the graphical elements using the software engine.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for SwCanvas:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__ThorVGCapi__SwCanvas.png" border="0" alt="" usemap="#group____ThorVGCapi____SwCanvas"/>
<map name="group____ThorVGCapi____SwCanvas" id="group____ThorVGCapi____SwCanvas">
<area shape="rect" id="node1" href="group__ThorVGCapi__Canvas.html" title="A module for managing and drawing graphical elements. " alt="" coords="5,5,72,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:ga0ad0467c444c00b79e58f171dce52433"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#ga0ad0467c444c00b79e58f171dce52433">tvg_swcanvas_create</a> ()</td></tr>
<tr class="memdesc:ga0ad0467c444c00b79e58f171dce52433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Canvas object. <a href="#ga0ad0467c444c00b79e58f171dce52433">More...</a><br /></td></tr>
<tr class="separator:ga0ad0467c444c00b79e58f171dce52433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d9dc2e0cb1ec92219d734bb6b61c8a5"><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__SwCanvas.html#ga5d9dc2e0cb1ec92219d734bb6b61c8a5">tvg_swcanvas_set_target</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, uint32_t *buffer, uint32_t stride, uint32_t w, uint32_t h, uint32_t cs)</td></tr>
<tr class="memdesc:ga5d9dc2e0cb1ec92219d734bb6b61c8a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the buffer used in the rasterization process and defines the used colorspace. <a href="#ga5d9dc2e0cb1ec92219d734bb6b61c8a5">More...</a><br /></td></tr>
<tr class="separator:ga5d9dc2e0cb1ec92219d734bb6b61c8a5"><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 rendering the graphical elements using the software engine. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0ad0467c444c00b79e58f171dce52433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ad0467c444c00b79e58f171dce52433">&#9670;&nbsp;</a></span>tvg_swcanvas_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a>* tvg_swcanvas_create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a Canvas object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas = NULL;</div><div class="line"></div><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga1b517176a56dde4e9ea9c8eb331660a9">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ga9502ec8d4433abfcf1f92cfb1aa36d78">TVG_ENGINE_SW</a>, 4);</div><div class="line">canvas = <a class="code" href="group__ThorVGCapi__SwCanvas.html#ga0ad0467c444c00b79e58f171dce52433">tvg_swcanvas_create</a>();</div><div class="line"></div><div class="line"><span class="comment">//set up the canvas buffer</span></div><div class="line">uint32_t *buffer = NULL;</div><div class="line">buffer = (uint32_t*) malloc(<span class="keyword">sizeof</span>(uint32_t) * 100 * 100);</div><div class="line"><span class="keywordflow">if</span> (!buffer) <span class="keywordflow">return</span>;</div><div class="line"></div><div class="line"><a class="code" href="group__ThorVGCapi__SwCanvas.html#ga5d9dc2e0cb1ec92219d734bb6b61c8a5">tvg_swcanvas_set_target</a>(canvas, buffer, 100, 100, 100, <a class="code" href="group__ThorVGCapi__Canvas.html#ga613ef63fe96cb341c95e7fee39bf660a">TVG_COLORSPACE_ARGB8888</a>);</div><div class="line"></div><div class="line"><span class="comment">//set up paints and add them into the canvas before drawing it</span></div><div class="line"></div><div class="line"><a class="code" href="group__ThorVGCapi__Canvas.html#ga0a3af123f8054dc6c182c70dc4907813">tvg_canvas_destroy</a>(canvas);</div><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga661d062ba6f2c98689b5b70e1cbf7a92">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ga9502ec8d4433abfcf1f92cfb1aa36d78">TVG_ENGINE_SW</a>);</div></div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new Tvg_Canvas object. </dd></dl>
</div>
</div>
<a id="ga5d9dc2e0cb1ec92219d734bb6b61c8a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d9dc2e0cb1ec92219d734bb6b61c8a5">&#9670;&nbsp;</a></span>tvg_swcanvas_set_target()</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_swcanvas_set_target </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *&#160;</td>
<td class="paramname"><em>canvas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>stride</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">uint32_t&#160;</td>
<td class="paramname"><em>cs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the buffer used in the rasterization process and defines the used colorspace. </p>
<p>For optimisation reasons TVG does not allocate memory for the output buffer on its own. The buffer of a desirable size should be allocated and owned by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">canvas</td><td>The Tvg_Canvas object managing the <code>buffer</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A pointer to the allocated memory block of the size <code>stride</code> x <code>h</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>The stride of the raster image - in most cases same value as <code>w</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>The width of the raster image. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>The height of the raster image. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>The colorspace value defining the way the 32-bits colors should be read/written.<ul>
<li>TVG_COLORSPACE_ABGR8888</li>
<li>TVG_COLORSPACE_ARGB8888</li>
</ul>
</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_MEMORY_CORRUPTION</td><td>Casting in the internal function implementation failed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENTS</td><td>An invalid buffer pointer passed or one of the <code>stride</code>, <code>w</code> or <code>h</code> being zero. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>The software engine is not supported.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#ga613ef63fe96cb341c95e7fee39bf660a" title="The 8-bit color channels are combined into 32-bit color in the order: alpha, red, green...">TVG_COLORSPACE_ARGB8888</a>, <a class="el" href="group__ThorVGCapi__Canvas.html#gaf725660036dd84e472025fb391bdc206" title="The 8-bit color channels are combined into 32-bit color in the order: alpha, blue, green, red. ">TVG_COLORSPACE_ABGR8888</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.13
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink