docs: updated to v0.11

In this update, we have chosen not to include CAPIs.
This decision was made due to the mixture of C++ and C languages
in a single documentation category, which resulted in a messy presentation.

Also, In this update, we have removed 'doxygen-awesome-css'
and introduced our own designated styles located in the 'style' folder.
After generating the Doxyfiles, we can overwrite the styles with these new ones.
This commit is contained in:
Hermet Park 2023-09-26 22:12:50 +09:00
parent ba84771cce
commit b0f6640bca
282 changed files with 3826 additions and 10234 deletions

View file

@ -38,7 +38,7 @@ PROJECT_NAME = ThorVG
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = v0.10 PROJECT_NUMBER = v0.11
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
@ -864,8 +864,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = ../inc \ INPUT = ../inc
./main-page.md
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1283,7 +1282,7 @@ HTML_STYLESHEET =
# list). For an example see the documentation. # list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css HTML_EXTRA_STYLESHEET =
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note # other source files which should be copied to the HTML output directory. Note
@ -1304,7 +1303,7 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220. # Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220 HTML_COLORSTYLE_HUE = 154
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A # in the HTML output. For a value of 0 the output will use grayscales only. A
@ -1312,7 +1311,7 @@ HTML_COLORSTYLE_HUE = 220
# Minimum value: 0, maximum value: 255, default value: 100. # Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_SAT = 0
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100 # luminance component of the colors in the HTML output. Values below 100
@ -1323,7 +1322,7 @@ HTML_COLORSTYLE_SAT = 100
# Minimum value: 40, maximum value: 240, default value: 80. # Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80 HTML_COLORSTYLE_GAMMA = 173
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this # page will contain the date and time when the page was generated. Setting this
@ -1582,7 +1581,7 @@ DISABLE_INDEX = NO
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_TREEVIEW = NO GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation. # doxygen will group on one line in the generated HTML documentation.

@ -1 +0,0 @@
Subproject commit 00a52f6c74065ffbd836cbd791ddfe8edf2836b8

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -109,9 +109,6 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
<tr id="row_0_15_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Animation.html" target="_self">Animation</a></td><td class="desc">Enables manipulation of animatable images </td></tr> <tr id="row_0_15_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Animation.html" target="_self">Animation</a></td><td class="desc">Enables manipulation of animatable images </td></tr>
<tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Saver.html" target="_self">Saver</a></td><td class="desc">A class for exporting a paint object into a specified file, from which to recover the paint data later </td></tr> <tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Saver.html" target="_self">Saver</a></td><td class="desc">A class for exporting a paint object into a specified file, from which to recover the paint data later </td></tr>
<tr id="row_0_17_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Accessor.html" target="_self">Accessor</a></td><td class="desc">The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> is a utility class to debug the <a class="el" href="classtvg_1_1Scene.html" title="A class to composite children paints.">Scene</a> structure by traversing the scene-tree </td></tr> <tr id="row_0_17_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtvg_1_1Accessor.html" target="_self">Accessor</a></td><td class="desc">The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> is a utility class to debug the <a class="el" href="classtvg_1_1Scene.html" title="A class to composite children paints.">Scene</a> structure by traversing the scene-tree </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTvg__Color__Stop.html" target="_self">Tvg_Color_Stop</a></td><td class="desc">A data structure storing the information about the color and its relative position inside the gradient bounds </td></tr>
<tr id="row_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTvg__Matrix.html" target="_self">Tvg_Matrix</a></td><td class="desc">A data structure representing a three-dimensional matrix </td></tr>
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTvg__Point.html" target="_self">Tvg_Point</a></td><td class="desc">A data structure representing a point in two-dimensional space </td></tr>
</table> </table>
</div><!-- directory --> </div><!-- directory -->
</div><!-- contents --> </div><!-- contents -->

View file

@ -19,8 +19,5 @@ var annotated_dup =
[ "Animation", "classtvg_1_1Animation.html", "classtvg_1_1Animation" ], [ "Animation", "classtvg_1_1Animation.html", "classtvg_1_1Animation" ],
[ "Saver", "classtvg_1_1Saver.html", "classtvg_1_1Saver" ], [ "Saver", "classtvg_1_1Saver.html", "classtvg_1_1Saver" ],
[ "Accessor", "classtvg_1_1Accessor.html", "classtvg_1_1Accessor" ] [ "Accessor", "classtvg_1_1Accessor.html", "classtvg_1_1Accessor" ]
] ], ] ]
[ "Tvg_Color_Stop", "structTvg__Color__Stop.html", "structTvg__Color__Stop" ],
[ "Tvg_Matrix", "structTvg__Matrix.html", null ],
[ "Tvg_Point", "structTvg__Point.html", null ]
]; ];

Binary file not shown.

Before

Width:  |  Height:  |  Size: 617 B

After

Width:  |  Height:  |  Size: 635 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 B

After

Width:  |  Height:  |  Size: 139 B

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -87,7 +87,7 @@ $(document).ready(function(){initNavTree('classes.html',''); initResizable(); })
<div class="title">Class Index</div> </div> <div class="title">Class Index</div> </div>
</div><!--header--> </div><!--header-->
<div class="contents"> <div class="contents">
<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_G">G</a>&#160;|&#160;<a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_V">V</a></div> <div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_G">G</a>&#160;|&#160;<a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_V">V</a></div>
<div class="classindex"> <div class="classindex">
<dl class="classindex even"> <dl class="classindex even">
<dt class="alphachar"><a name="letter_A">A</a></dt> <dt class="alphachar"><a name="letter_A">A</a></dt>
@ -120,9 +120,6 @@ $(document).ready(function(){initNavTree('classes.html',''); initResizable(); })
<dt class="alphachar"><a name="letter_S">S</a></dt> <dt class="alphachar"><a name="letter_S">S</a></dt>
<dd><a class="el" href="classtvg_1_1Saver.html">Saver</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1Scene.html">Scene</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1Shape.html">Shape</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a> (tvg)</dd></dl> <dd><a class="el" href="classtvg_1_1Saver.html">Saver</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1Scene.html">Scene</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1Shape.html">Shape</a> (tvg)</dd><dd><a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a> (tvg)</dd></dl>
<dl class="classindex even"> <dl class="classindex even">
<dt class="alphachar"><a name="letter_T">T</a></dt>
<dd><a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a></dd><dd><a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a></dd><dd><a class="el" href="structTvg__Point.html">Tvg_Point</a></dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_V">V</a></dt> <dt class="alphachar"><a name="letter_V">V</a></dt>
<dd><a class="el" href="structtvg_1_1Vertex.html">Vertex</a> (tvg)</dd></dl> <dd><a class="el" href="structtvg_1_1Vertex.html">Vertex</a> (tvg)</dd></dl>
</div> </div>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -116,7 +116,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr> <tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr>
<tr class="separator:a82c5ec1c1ba93cf7671642400074201e"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a82c5ec1c1ba93cf7671642400074201e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99cdb01cd893f4199b521b754d21aefd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr> <tr class="memitem:a99cdb01cd893f4199b521b754d21aefd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr>
<tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the <code>free</code> argument, the paints are freed or not. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr> <tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the internal canvas resources that used for the drawing. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr>
<tr class="separator:a99cdb01cd893f4199b521b754d21aefd"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a99cdb01cd893f4199b521b754d21aefd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr> <tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr>
<tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr> <tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr>
@ -158,7 +158,8 @@ Public Member Functions</h2></td></tr>
</table> </table>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the <code>free</code> argument, the paints are freed or not. </p> <p>Clear the internal canvas resources that used for the drawing. </p>
<p>This API sets the total number of paints pushed into the canvas to zero. Depending on the value of the <code>free</code> argument, the paints are either freed or retained. So if you need to update paint properties while maintaining the existing scene structure, you can set <code>free</code> = false.</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">free</td><td>If <code>true</code>, the memory occupied by paints is deallocated, otherwise it is not.</td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">free</td><td>If <code>true</code>, the memory occupied by paints is deallocated, otherwise it is not.</td></tr>
@ -166,7 +167,6 @@ Public Member Functions</h2></td></tr>
</dd> </dd>
</dl> </dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1" title="The value returned in case the request cannot be processed - e.g. asking for properties of an object,...">Result::InsufficientCondition</a> otherwise.</dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1" title="The value returned in case the request cannot be processed - e.g. asking for properties of an object,...">Result::InsufficientCondition</a> otherwise.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>If you don't free the paints they become dangled. They are supposed to be reused, otherwise you are responsible for their lives. Thus please use the <code>free</code> argument only when you know how it works, otherwise it's not recommended. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e" title="Passes drawing elements to the Canvas using Paint objects.">Canvas::push()</a> </dd> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e" title="Passes drawing elements to the Canvas using Paint objects.">Canvas::push()</a> </dd>
<dd> <dd>
<a class="el" href="classtvg_1_1Canvas.html#ace6c268f853a4c144076de89b7bbbe75" title="Returns the list of the paints that currently held by the Canvas.">Canvas::paints()</a> </dd></dl> <a class="el" href="classtvg_1_1Canvas.html#ace6c268f853a4c144076de89b7bbbe75" title="Returns the list of the paints that currently held by the Canvas.">Canvas::paints()</a> </dd></dl>
@ -259,7 +259,7 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. </p> <p>Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. </p>
<p>Only pushed paints in the canvas will be drawing targets. They are retained by the canvas until you call <a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd" title="Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the ...">Canvas::clear()</a>.</p> <p>Only pushed paints in the canvas will be drawing targets. They are retained by the canvas until you call <a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd" title="Clear the internal canvas resources that used for the drawing.">Canvas::clear()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>A <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> object to be drawn.</td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>A <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> object to be drawn.</td></tr>
@ -277,7 +277,7 @@ Public Member Functions</h2></td></tr>
<dl class="section note"><dt>Note</dt><dd>The rendering order of the paints is the same as the order as they were pushed into the canvas. Consider sorting the paints before pushing them if you intend to use layering. </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 into the canvas. 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="classtvg_1_1Canvas.html#ace6c268f853a4c144076de89b7bbbe75" title="Returns the list of the paints that currently held by the Canvas.">Canvas::paints()</a> </dd> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Canvas.html#ace6c268f853a4c144076de89b7bbbe75" title="Returns the list of the paints that currently held by the Canvas.">Canvas::paints()</a> </dd>
<dd> <dd>
<a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd" title="Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the ...">Canvas::clear()</a> </dd></dl> <a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd" title="Clear the internal canvas resources that used for the drawing.">Canvas::clear()</a> </dd></dl>
</div> </div>
</div> </div>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,15 +103,6 @@ Inheritance diagram for GlCanvas:</div>
<area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="12,5,83,32"/> <area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="12,5,83,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for GlCanvas:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1GlCanvas__coll__graph.png" border="0" usemap="#aGlCanvas_coll__map" alt="Collaboration graph"/></div>
<map name="aGlCanvas_coll__map" id="aGlCanvas_coll__map">
<area shape="rect" title="A class for the rendering graphic elements with a GL raster engine." alt="" coords="5,80,89,107"/>
<area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="12,5,83,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>
@ -129,7 +120,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr> <tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr>
<tr class="separator:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr> <tr class="memitem:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr>
<tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the <code>free</code> argument, the paints are freed or not. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr> <tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the internal canvas resources that used for the drawing. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr>
<tr class="separator:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr> <tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr>
<tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr> <tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr>

View file

@ -1,4 +0,0 @@
<map id="GlCanvas" name="GlCanvas">
<area shape="rect" id="node1" title="A class for the rendering graphic elements with a GL raster engine." alt="" coords="5,80,89,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="12,5,83,32"/>
</map>

View file

@ -1 +0,0 @@
0c8d5ae7fe91720ae0ceeec156eb3f5f

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,15 +103,6 @@ Inheritance diagram for LinearGradient:</div>
<area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/> <area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for LinearGradient:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1LinearGradient__coll__graph.png" border="0" usemap="#aLinearGradient_coll__map" alt="Collaboration graph"/></div>
<map name="aLinearGradient_coll__map" id="aLinearGradient_coll__map">
<area shape="rect" title="A class representing the linear gradient fill of the Shape object." alt="" coords="5,80,124,107"/>
<area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>

View file

@ -1,4 +0,0 @@
<map id="LinearGradient" name="LinearGradient">
<area shape="rect" id="node1" title="A class representing the linear gradient fill of the Shape object." alt="" coords="5,80,124,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map>

View file

@ -1 +0,0 @@
c3db0510d28e17e6d0f350e1e207e474

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -96,26 +96,25 @@ $(document).ready(function(){initNavTree('classtvg_1_1Picture.html',''); initRes
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a1b51b7344eac48d285c073bc488197d3">bounds</a>(float *x, float *y, float *w, float *h, bool transformed) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a1b51b7344eac48d285c073bc488197d3">bounds</a>(float *x, float *y, float *w, float *h, bool transformed) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2e2d077b820d1cfd6502a86e0221638b">composite</a>(std::unique_ptr&lt; Paint &gt; target, CompositeMethod method) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2e2d077b820d1cfd6502a86e0221638b">composite</a>(std::unique_ptr&lt; Paint &gt; target, CompositeMethod method) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#aefe4ade5b1b6bc13d518bd5f968af3ee">composite</a>(const Paint **target) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#aefe4ade5b1b6bc13d518bd5f968af3ee">composite</a>(const Paint **target) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">data</a>(uint32_t *w, uint32_t *h) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a71afac69fe1e7c352460be5878812635">duplicate</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a71afac69fe1e7c352460be5878812635">duplicate</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a68af11946af3c1c63a4e915cd0207811">gen</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a68af11946af3c1c63a4e915cd0207811">gen</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"><span class="mlabel">static</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a13df43a335dadaea01769a726dc9ddfd">identifier</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a13df43a335dadaea01769a726dc9ddfd">identifier</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"><span class="mlabel">static</span></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a37466e9eff2de62ff15c9df3d72b656d">tvg::Paint::identifier</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a37466e9eff2de62ff15c9df3d72b656d">tvg::Paint::identifier</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">load</a>(const std::string &amp;path) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">load</a>(const std::string &amp;path) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">load</a>(const char *data, uint32_t size, bool copy=false) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">load</a>(const char *data, uint32_t size, bool copy=false) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">load</a>(const char *data, uint32_t size, const std::string &amp;mimeType, bool copy=false) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">load</a>(const char *data, uint32_t size, const std::string &amp;mimeType, bool copy=false) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">load</a>(uint32_t *data, uint32_t w, uint32_t h, bool copy) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">load</a>(uint32_t *data, uint32_t w, uint32_t h, bool copy) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a761d19e78330e8ce73add01cbf1cd2e9">mesh</a>(const Polygon *triangles, uint32_t triangleCnt) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a761d19e78330e8ce73add01cbf1cd2e9">mesh</a>(const Polygon *triangles, uint32_t triangleCnt) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#ae4d1479dbae28f521da8e90f91a97caa">mesh</a>(const Polygon **triangles) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#ae4d1479dbae28f521da8e90f91a97caa">mesh</a>(const Polygon **triangles) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2f25b71fed3ae390eb8051c7ea65aebf">opacity</a>(uint8_t o) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2f25b71fed3ae390eb8051c7ea65aebf">opacity</a>(uint8_t o) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2ee7517b8bfad47e0f999ba3450e0e3e">opacity</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a2ee7517b8bfad47e0f999ba3450e0e3e">opacity</a>() const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a7841fa0c14643e09735d48042ead68f3">rotate</a>(float degree) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a7841fa0c14643e09735d48042ead68f3">rotate</a>(float degree) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a5c057876185525c5723215f95a3984f2">scale</a>(float factor) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#a5c057876185525c5723215f95a3984f2">scale</a>(float factor) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>(float w, float h) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>(float w, float h) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">size</a>(float *w, float *h) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">size</a>(float *w, float *h) const noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ac9f6ba428afe884bcc2861de0a2a96f4">transform</a>(const Matrix &amp;m) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ac9f6ba428afe884bcc2861de0a2a96f4">transform</a>(const Matrix &amp;m) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ad1e49b6eb81e87bd860f19e1b92c574b">transform</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ad1e49b6eb81e87bd860f19e1b92c574b">transform</a>() noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ae896f56bfa51c98a50eee3f2bb62e41e">translate</a>(float x, float y) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classtvg_1_1Paint.html#ae896f56bfa51c98a50eee3f2bb62e41e">translate</a>(float x, float y) noexcept</td><td class="entry"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td><td class="entry"></td></tr>
</table></div><!-- contents --> </table></div><!-- contents -->
</div><!-- doc-content --> </div><!-- doc-content -->
<!-- start footer part --> <!-- start footer part -->

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,25 +103,16 @@ Inheritance diagram for Picture:</div>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="11,5,66,32"/> <area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="11,5,66,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Picture:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1Picture__coll__graph.png" border="0" usemap="#aPicture_coll__map" alt="Collaboration graph"/></div>
<map name="aPicture_coll__map" id="aPicture_coll__map">
<area shape="rect" title="A class representing an image read in one of the supported formats: raw, svg, png,..." alt="" coords="5,80,72,107"/>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="11,5,66,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>
<tr class="memitem:aaf06be7d0b572c5ce35315cbddd7d318"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">load</a> (const std::string &amp;path) noexcept</td></tr> <tr class="memitem:aaf06be7d0b572c5ce35315cbddd7d318"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">load</a> (const std::string &amp;path) noexcept</td></tr>
<tr class="memdesc:aaf06be7d0b572c5ce35315cbddd7d318"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data directly from a file. <a href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">More...</a><br /></td></tr> <tr class="memdesc:aaf06be7d0b572c5ce35315cbddd7d318"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data directly from a file. <a href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318">More...</a><br /></td></tr>
<tr class="separator:aaf06be7d0b572c5ce35315cbddd7d318"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:aaf06be7d0b572c5ce35315cbddd7d318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e487c0b236a6eea853c5ccb7665cdce"><td class="memItemLeft" align="right" valign="top">TVG_DEPRECATED <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">load</a> (const char *<a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">data</a>, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>, bool copy=false) noexcept</td></tr> <tr class="memitem:a3e487c0b236a6eea853c5ccb7665cdce"><td class="memItemLeft" align="right" valign="top">TVG_DEPRECATED <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">load</a> (const char *data, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>, bool copy=false) noexcept</td></tr>
<tr class="memdesc:a3e487c0b236a6eea853c5ccb7665cdce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">More...</a><br /></td></tr> <tr class="memdesc:a3e487c0b236a6eea853c5ccb7665cdce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce">More...</a><br /></td></tr>
<tr class="separator:a3e487c0b236a6eea853c5ccb7665cdce"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a3e487c0b236a6eea853c5ccb7665cdce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95979a7c4ce51445c7ef9d6461c34767"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">load</a> (const char *<a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">data</a>, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>, const std::string &amp;mimeType, bool copy=false) noexcept</td></tr> <tr class="memitem:a95979a7c4ce51445c7ef9d6461c34767"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">load</a> (const char *data, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a>, const std::string &amp;mimeType, bool copy=false) noexcept</td></tr>
<tr class="memdesc:a95979a7c4ce51445c7ef9d6461c34767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">More...</a><br /></td></tr> <tr class="memdesc:a95979a7c4ce51445c7ef9d6461c34767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a picture data from a memory block of a given size. <a href="classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767">More...</a><br /></td></tr>
<tr class="separator:a95979a7c4ce51445c7ef9d6461c34767"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a95979a7c4ce51445c7ef9d6461c34767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a065e47b46c791ee4d93ed3252d581a40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a> (float w, float h) noexcept</td></tr> <tr class="memitem:a065e47b46c791ee4d93ed3252d581a40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40">size</a> (float w, float h) noexcept</td></tr>
@ -130,10 +121,7 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:af80639ef3460a5cf06278fdc03c13aad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">size</a> (float *w, float *h) const noexcept</td></tr> <tr class="memitem:af80639ef3460a5cf06278fdc03c13aad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">size</a> (float *w, float *h) const noexcept</td></tr>
<tr class="memdesc:af80639ef3460a5cf06278fdc03c13aad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the image. <a href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">More...</a><br /></td></tr> <tr class="memdesc:af80639ef3460a5cf06278fdc03c13aad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the image. <a href="classtvg_1_1Picture.html#af80639ef3460a5cf06278fdc03c13aad">More...</a><br /></td></tr>
<tr class="separator:af80639ef3460a5cf06278fdc03c13aad"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:af80639ef3460a5cf06278fdc03c13aad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21b1473525a4e1fccdc6b893bdfd4fbb"><td class="memItemLeft" align="right" valign="top">const uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">data</a> (uint32_t *w, uint32_t *h) const noexcept</td></tr> <tr class="memitem:a1fdf75092cebaa7cde48d6a7d4946368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">load</a> (uint32_t *data, uint32_t w, uint32_t h, bool copy) noexcept</td></tr>
<tr class="memdesc:a21b1473525a4e1fccdc6b893bdfd4fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pixels information of the picture. <a href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">More...</a><br /></td></tr>
<tr class="separator:a21b1473525a4e1fccdc6b893bdfd4fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fdf75092cebaa7cde48d6a7d4946368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">load</a> (uint32_t *<a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">data</a>, uint32_t w, uint32_t h, bool copy) noexcept</td></tr>
<tr class="memdesc:a1fdf75092cebaa7cde48d6a7d4946368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a raw data from a memory block with a given size. <a href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">More...</a><br /></td></tr> <tr class="memdesc:a1fdf75092cebaa7cde48d6a7d4946368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a raw data from a memory block with a given size. <a href="classtvg_1_1Picture.html#a1fdf75092cebaa7cde48d6a7d4946368">More...</a><br /></td></tr>
<tr class="separator:a1fdf75092cebaa7cde48d6a7d4946368"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a1fdf75092cebaa7cde48d6a7d4946368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a761d19e78330e8ce73add01cbf1cd2e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a761d19e78330e8ce73add01cbf1cd2e9">mesh</a> (const <a class="el" href="structtvg_1_1Polygon.html">Polygon</a> *triangles, uint32_t triangleCnt) noexcept</td></tr> <tr class="memitem:a761d19e78330e8ce73add01cbf1cd2e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html#a761d19e78330e8ce73add01cbf1cd2e9">mesh</a> (const <a class="el" href="structtvg_1_1Polygon.html">Polygon</a> *triangles, uint32_t triangleCnt) noexcept</td></tr>
@ -204,47 +192,6 @@ Static Public Member Functions</h2></td></tr>
<dd> <dd>
See <a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a> class if the picture data is animatable. </dd></dl> See <a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a> class if the picture data is animatable. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a21b1473525a4e1fccdc6b893bdfd4fbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21b1473525a4e1fccdc6b893bdfd4fbb">&#9670;&nbsp;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint32_t* data </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the pixels information of the picture. </p>
<dl class="section note"><dt>Note</dt><dd>The data must be pre-multiplied by the alpha channels.</dd></dl>
<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>
<p>@BETA_API </p>
</div>
</div>
<a id="a68af11946af3c1c63a4e915cd0207811"></a> <a id="a68af11946af3c1c63a4e915cd0207811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68af11946af3c1c63a4e915cd0207811">&#9670;&nbsp;</a></span>gen()</h2> <h2 class="memtitle"><span class="permalink"><a href="#a68af11946af3c1c63a4e915cd0207811">&#9670;&nbsp;</a></span>gen()</h2>
@ -361,7 +308,7 @@ See <a class="el" href="classtvg_1_1Animation.html" title="The Animation class e
</dd> </dd>
</dl> </dl>
<dl class="section warning"><dt>Warning</dt><dd>: you have responsibility to release the <code>data</code> memory if the <code>copy</code> is true </dd></dl> <dl class="section warning"><dt>Warning</dt><dd>: you have responsibility to release the <code>data</code> memory if the <code>copy</code> is true </dd></dl>
<dl class="section see"><dt>See also</dt><dd>Result <a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318" title="Loads a picture data directly from a file.">load</a>(const char* <a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb" title="Gets the pixels information of the picture.">data</a>, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40" title="Resizes the picture content to the given width and height.">size</a>, const std::string&amp; mimeType, bool copy = false) noexcept </dd></dl> <dl class="section see"><dt>See also</dt><dd>Result <a class="el" href="classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318" title="Loads a picture data directly from a file.">load</a>(const char* data, uint32_t <a class="el" href="classtvg_1_1Picture.html#a065e47b46c791ee4d93ed3252d581a40" title="Resizes the picture content to the given width and height.">size</a>, const std::string&amp; mimeType, bool copy = false) noexcept </dd></dl>
</div> </div>
</div> </div>
@ -416,7 +363,7 @@ See <a class="el" href="classtvg_1_1Animation.html" title="The Animation class e
<table class="params"> <table class="params">
<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">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">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">mimeType</td><td>Mimetype or extension of data such as "jpg", "jpeg", "lottie", "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> <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> </table>
</dd> </dd>
@ -431,6 +378,7 @@ See <a class="el" href="classtvg_1_1Animation.html" title="The Animation class e
</dd> </dd>
</dl> </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> <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>
<dl class="section note"><dt>Note</dt><dd>If you are unsure about the MIME type, you can provide an empty value like <code>""</code>, and thorvg will attempt to figure it out. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.5 </dd></dl> <dl class="section since"><dt>Since</dt><dd>0.5 </dd></dl>
</div> </div>

View file

@ -1,6 +1,5 @@
var classtvg_1_1Picture = var classtvg_1_1Picture =
[ [
[ "data", "classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb", null ],
[ "load", "classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce", null ], [ "load", "classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce", null ],
[ "load", "classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767", null ], [ "load", "classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767", null ],
[ "load", "classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318", null ], [ "load", "classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318", null ],

View file

@ -1,4 +0,0 @@
<map id="Picture" name="Picture">
<area shape="rect" id="node1" title="A class representing an image read in one of the supported formats: raw, svg, png,..." alt="" coords="5,80,72,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="11,5,66,32"/>
</map>

View file

@ -1 +0,0 @@
000954cb73ed26fd2a3f6cc39d922ef1

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.8 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,15 +103,6 @@ Inheritance diagram for RadialGradient:</div>
<area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/> <area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for RadialGradient:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1RadialGradient__coll__graph.png" border="0" usemap="#aRadialGradient_coll__map" alt="Collaboration graph"/></div>
<map name="aRadialGradient_coll__map" id="aRadialGradient_coll__map">
<area shape="rect" title="A class representing the radial gradient fill of the Shape object." alt="" coords="5,80,124,107"/>
<area shape="rect" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>

View file

@ -1,4 +0,0 @@
<map id="RadialGradient" name="RadialGradient">
<area shape="rect" id="node1" title="A class representing the radial gradient fill of the Shape object." alt="" coords="5,80,124,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="44,5,85,32"/>
</map>

View file

@ -1 +0,0 @@
7d9ed750e4461d9e03c1d214d789095e

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,15 +103,6 @@ Inheritance diagram for Scene:</div>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,63,32"/> <area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,63,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Scene:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1Scene__coll__graph.png" border="0" usemap="#aScene_coll__map" alt="Collaboration graph"/></div>
<map name="aScene_coll__map" id="aScene_coll__map">
<area shape="rect" title="A class to composite children paints." alt="" coords="5,80,67,107"/>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,63,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>

View file

@ -1,4 +0,0 @@
<map id="Scene" name="Scene">
<area shape="rect" id="node1" title="A class to composite children paints." alt="" coords="5,80,67,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,63,32"/>
</map>

View file

@ -1 +0,0 @@
e036cfb9024a5a214ab27e428762f2a6

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.7 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -103,15 +103,6 @@ Inheritance diagram for Shape:</div>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,64,32"/> <area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,64,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Shape:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1Shape__coll__graph.png" border="0" usemap="#aShape_coll__map" alt="Collaboration graph"/></div>
<map name="aShape_coll__map" id="aShape_coll__map">
<area shape="rect" title="A class representing two&#45;dimensional figures and their properties." alt="" coords="5,80,68,107"/>
<area shape="rect" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,64,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>
@ -1192,7 +1183,7 @@ ClipPath won't use the fill values. (see: enum class <a class="el" href="group__
</div><div class="memdoc"> </div><div class="memdoc">
<p>Resets the properties of the shape path. </p> <p>Resets the properties of the shape path. </p>
<p>The color, the fill and the stroke properties are retained.</p> <p>The transformation matrix, the color, the fill and the stroke properties are retained.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed.</dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The memory, where the path data is stored, is not deallocated at this stage for caching effect. </dd></dl> <dl class="section note"><dt>Note</dt><dd>The memory, where the path data is stored, is not deallocated at this stage for caching effect. </dd></dl>
@ -1665,7 +1656,7 @@ ClipPath won't use the fill values. (see: enum class <a class="el" href="group__
<p>Gets the stroke miterlimit. </p> <p>Gets the stroke miterlimit. </p>
<dl class="section return"><dt>Returns</dt><dd>The stroke miterlimit value when succeed, 4 if no stroke was set.</dd></dl> <dl class="section return"><dt>Returns</dt><dd>The stroke miterlimit value when succeed, 4 if no stroke was set.</dd></dl>
<p>@BETA_API </p> <dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
</div> </div>
</div> </div>
@ -1701,7 +1692,7 @@ ClipPath won't use the fill values. (see: enum class <a class="el" href="group__
</dd> </dd>
</dl> </dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29" title="The value returned in case of choosing unsupported options.">Result::NonSupport</a> unsupported value, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation.">Result::FailedAllocation</a> otherwise.</dd></dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29" title="The value returned in case of choosing unsupported options.">Result::NonSupport</a> unsupported value, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907" title="The value returned in case of unsuccessful memory allocation.">Result::FailedAllocation</a> otherwise.</dd></dl>
<p>@BETA_API </p> <dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
</div> </div>
</div> </div>

View file

@ -1,4 +0,0 @@
<map id="Shape" name="Shape">
<area shape="rect" id="node1" title="A class representing two&#45;dimensional figures and their properties." alt="" coords="5,80,68,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Paint.html" title="An abstract class for managing graphical elements." alt="" coords="9,5,64,32"/>
</map>

View file

@ -1 +0,0 @@
a9827c2c55561e89e0ec21823467757c

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -104,15 +104,6 @@ Inheritance diagram for SwCanvas:</div>
<area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="15,5,85,32"/> <area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="15,5,85,32"/>
</map> </map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SwCanvas:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1SwCanvas__coll__graph.png" border="0" usemap="#aSwCanvas_coll__map" alt="Collaboration graph"/></div>
<map name="aSwCanvas_coll__map" id="aSwCanvas_coll__map">
<area shape="rect" title="A class for the rendering graphical elements with a software raster engine." alt="" coords="5,80,95,107"/>
<area shape="rect" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="15,5,85,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr> Public Types</h2></td></tr>
@ -149,7 +140,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr> <tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements.">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> objects. <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr>
<tr class="separator:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr> <tr class="memitem:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr>
<tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the <code>free</code> argument, the paints are freed or not. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr> <tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the internal canvas resources that used for the drawing. <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr>
<tr class="separator:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr> <tr class="memitem:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint=nullptr) noexcept</td></tr>
<tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr> <tr class="memdesc:a89ac8a85a8c22723af9fb07c098472b3 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects. <a href="classtvg_1_1Canvas.html#a89ac8a85a8c22723af9fb07c098472b3">More...</a><br /></td></tr>

View file

@ -1,4 +0,0 @@
<map id="SwCanvas" name="SwCanvas">
<area shape="rect" id="node1" title="A class for the rendering graphical elements with a software raster engine." alt="" coords="5,80,95,107"/>
<area shape="rect" id="node2" href="$classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements." alt="" coords="15,5,85,32"/>
</map>

View file

@ -1 +0,0 @@
9ca8dd4d52313b63c924e59e71877bcd

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 129 B

After

Width:  |  Height:  |  Size: 127 B

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -92,9 +92,6 @@ $(document).ready(function(){initNavTree('dir_bfccd401955b95cf8c75461437045ac0.h
Files</h2></td></tr> Files</h2></td></tr>
<tr class="memitem:thorvg_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>thorvg.h</b> <a href="thorvg_8h_source.html">[code]</a></td></tr> <tr class="memitem:thorvg_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>thorvg.h</b> <a href="thorvg_8h_source.html">[code]</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:thorvg__capi_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><b>thorvg_capi.h</b> <a href="thorvg__capi_8h_source.html">[code]</a></td></tr>
<tr class="memdesc:thorvg__capi_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">The module provides C bindings for the ThorVG library. Please refer to src/examples/Capi.cpp to find the thorvg_capi usage examples. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table> </table>
</div><!-- contents --> </div><!-- contents -->
</div><!-- doc-content --> </div><!-- doc-content -->

Binary file not shown.

Before

Width:  |  Height:  |  Size: 742 B

After

Width:  |  Height:  |  Size: 714 B

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 514 B

After

Width:  |  Height:  |  Size: 540 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 610 B

After

Width:  |  Height:  |  Size: 561 B

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -88,7 +88,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_a"></a>- a -</h3><ul> <h3><a id="index_a"></a>- a -</h3><ul>
<li>a <li>a
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#af4007aacd75b22aee32dba9ea96082c0">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#af4007aacd75b22aee32dba9ea96082c0">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#af4007aacd75b22aee32dba9ea96082c0">Tvg_Color_Stop</a>
</li> </li>
<li>ABGR8888 <li>ABGR8888
: <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65adb1b146d65c52857a5a4af54e5006101">SwCanvas</a> : <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65adb1b146d65c52857a5a4af54e5006101">SwCanvas</a>
@ -120,7 +119,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_b"></a>- b -</h3><ul> <h3><a id="index_b"></a>- b -</h3><ul>
<li>b <li>b
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4313c9563516f94387762ab05763456b">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4313c9563516f94387762ab05763456b">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a4313c9563516f94387762ab05763456b">Tvg_Color_Stop</a>
</li> </li>
<li>blend() <li>blend()
: <a class="el" href="classtvg_1_1Paint.html#a7e1214a5dc2f3c19ddeedc5371c4e488">Paint</a> : <a class="el" href="classtvg_1_1Paint.html#a7e1214a5dc2f3c19ddeedc5371c4e488">Paint</a>
@ -158,9 +156,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_d"></a>- d -</h3><ul> <h3><a id="index_d"></a>- d -</h3><ul>
<li>data()
: <a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">Picture</a>
</li>
<li>Default <li>Default
: <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22ba79935518a3889663d8688b6b01fff051">SwCanvas</a> : <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22ba79935518a3889663d8688b6b01fff051">SwCanvas</a>
</li> </li>
@ -196,7 +191,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_g"></a>- g -</h3><ul> <h3><a id="index_g"></a>- g -</h3><ul>
<li>g <li>g
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Tvg_Color_Stop</a>
</li> </li>
<li>gen() <li>gen()
: <a class="el" href="classtvg_1_1Accessor.html#a948e9f4ff06cdc9c19bcc60c1458ecc2">Accessor</a> : <a class="el" href="classtvg_1_1Accessor.html#a948e9f4ff06cdc9c19bcc60c1458ecc2">Accessor</a>
@ -264,7 +258,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_o"></a>- o -</h3><ul> <h3><a id="index_o"></a>- o -</h3><ul>
<li>offset <li>offset
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Tvg_Color_Stop</a>
</li> </li>
<li>opacity() <li>opacity()
: <a class="el" href="classtvg_1_1Paint.html#a2f25b71fed3ae390eb8051c7ea65aebf">Paint</a> : <a class="el" href="classtvg_1_1Paint.html#a2f25b71fed3ae390eb8051c7ea65aebf">Paint</a>
@ -299,7 +292,6 @@ $(document).ready(function(){initNavTree('functions.html',''); initResizable();
<h3><a id="index_r"></a>- r -</h3><ul> <h3><a id="index_r"></a>- r -</h3><ul>
<li>r <li>r
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Tvg_Color_Stop</a>
</li> </li>
<li>radial() <li>radial()
: <a class="el" href="classtvg_1_1RadialGradient.html#a3688387d86ebd5003ee98d90f24a6030">RadialGradient</a> : <a class="el" href="classtvg_1_1RadialGradient.html#a3688387d86ebd5003ee98d90f24a6030">RadialGradient</a>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -135,9 +135,6 @@ $(document).ready(function(){initNavTree('functions_func.html',''); initResizabl
<h3><a id="index_d"></a>- d -</h3><ul> <h3><a id="index_d"></a>- d -</h3><ul>
<li>data()
: <a class="el" href="classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb">Picture</a>
</li>
<li>draw() <li>draw()
: <a class="el" href="classtvg_1_1Canvas.html#aabf9e5a14da3b4bfd5883c2b4459abd0">Canvas</a> : <a class="el" href="classtvg_1_1Canvas.html#aabf9e5a14da3b4bfd5883c2b4459abd0">Canvas</a>
</li> </li>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -86,23 +86,18 @@ $(document).ready(function(){initNavTree('functions_vars.html',''); initResizabl
&#160;<ul> &#160;<ul>
<li>a <li>a
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#af4007aacd75b22aee32dba9ea96082c0">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#af4007aacd75b22aee32dba9ea96082c0">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#af4007aacd75b22aee32dba9ea96082c0">Tvg_Color_Stop</a>
</li> </li>
<li>b <li>b
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4313c9563516f94387762ab05763456b">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4313c9563516f94387762ab05763456b">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a4313c9563516f94387762ab05763456b">Tvg_Color_Stop</a>
</li> </li>
<li>g <li>g
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a1673907d4d89d763bb7b94ec1eeb7b60">Tvg_Color_Stop</a>
</li> </li>
<li>offset <li>offset
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a3e60b3c561be982d7c8e23f14c01fd5b">Tvg_Color_Stop</a>
</li> </li>
<li>r <li>r
: <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Fill::ColorStop</a> : <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Fill::ColorStop</a>
, <a class="el" href="structTvg__Color__Stop.html#a4c5c6ceb8ed33456261fa907136e0c3a">Tvg_Color_Stop</a>
</li> </li>
</ul> </ul>
</div><!-- contents --> </div><!-- contents -->

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>

View file

@ -27,7 +27,7 @@
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td> <td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;"> <td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG <div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span> &#160;<span id="projectnumber">v0.11</span>
</div> </div>
</td> </td>
</tr> </tr>
@ -378,7 +378,7 @@ Functions</h2></td></tr>
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a4dae6fdfeb902e322a7bc9122c4e4cb4"></a>LumaMask&#160;</td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the compositing target's pixels. </p> <tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a4dae6fdfeb902e322a7bc9122c4e4cb4"></a>LumaMask&#160;</td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the compositing target's pixels. </p>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl> <dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</td></tr> </td></tr>
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a28f3dcc7d8cad65deff7d3a83031ef5a"></a>InvLumaMask&#160;</td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the complement to the compositing target's pixels. @BETA_API. </p> <tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a28f3dcc7d8cad65deff7d3a83031ef5a"></a>InvLumaMask&#160;</td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the complement to the compositing target's pixels. </p>
</td></tr> </td></tr>
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a8e1e296c3f01c21b1a3db79f0ce4fe9a"></a>AddMask&#160;</td><td class="fielddoc"><p>Combines the target and source objects pixels using target alpha. (T * TA) + (S * (255 - TA)) @BETA_API. </p> <tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a8e1e296c3f01c21b1a3db79f0ce4fe9a"></a>AddMask&#160;</td><td class="fielddoc"><p>Combines the target and source objects pixels using target alpha. (T * TA) + (S * (255 - TA)) @BETA_API. </p>
</td></tr> </td></tr>
@ -611,7 +611,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a &#39;Fill&#39; to type &#39;T&#39;.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a>' to type 'T'. </p> <p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a &#39;Fill&#39; to type &#39;T&#39;.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a>' to type 'T'. </p>
<p>@BETA_API </p> <dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
</div> </div>
</div> </div>
@ -632,7 +632,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a &#39;Fill&#39; to type &#39;T&#39;.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a>' to type 'T'. </p> <p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a &#39;Fill&#39; to type &#39;T&#39;.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a>' to type 'T'. </p>
<p>@BETA_API </p> <dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
</div> </div>
</div> </div>

View file

@ -90,7 +90,6 @@ var group__ThorVG =
[ "strokeWidth", "classtvg_1_1Shape.html#a1536ec32e91c29dd8300b0d4354773f9", null ] [ "strokeWidth", "classtvg_1_1Shape.html#a1536ec32e91c29dd8300b0d4354773f9", null ]
] ], ] ],
[ "Picture", "classtvg_1_1Picture.html", [ [ "Picture", "classtvg_1_1Picture.html", [
[ "data", "classtvg_1_1Picture.html#a21b1473525a4e1fccdc6b893bdfd4fbb", null ],
[ "load", "classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce", null ], [ "load", "classtvg_1_1Picture.html#a3e487c0b236a6eea853c5ccb7665cdce", null ],
[ "load", "classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767", null ], [ "load", "classtvg_1_1Picture.html#a95979a7c4ce51445c7ef9d6461c34767", null ],
[ "load", "classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318", null ], [ "load", "classtvg_1_1Picture.html#aaf06be7d0b572c5ce35315cbddd7d318", null ],

View file

@ -1,610 +0,0 @@
<!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: Canvas</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__Canvas.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="#groups">Modules</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Canvas<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 managing and drawing graphical elements.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Canvas:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Canvas.png" border="0" usemap="#agroup____ThorVGCapi____Canvas" alt=""/></div>
<map name="agroup____ThorVGCapi____Canvas" id="agroup____ThorVGCapi____Canvas">
<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 managing and drawing graphical elements." alt="" coords="160,5,231,31"/>
<area shape="rect" href="group__ThorVGCapi__SwCanvas.html" title="A module for rendering the graphical elements using the software engine." alt="" coords="279,5,368,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__ThorVGCapi__SwCanvas"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html">SwCanvas</a></td></tr>
<tr class="memdesc:group__ThorVGCapi__SwCanvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">A module for rendering the graphical elements using the software engine. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga15208125646162cd19a928708a335295"><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__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas)</td></tr>
<tr class="memdesc:ga15208125646162cd19a928708a335295"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas object itself. <a href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">More...</a><br /></td></tr>
<tr class="separator:ga15208125646162cd19a928708a335295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81ac2919a9e19634ffb9cb6c42d10a75"><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__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75">tvg_canvas_push</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
<tr class="memdesc:ga81ac2919a9e19634ffb9cb6c42d10a75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts a drawing element into the canvas using a Tvg_Paint object. <a href="group__ThorVGCapi__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75">More...</a><br /></td></tr>
<tr class="separator:ga81ac2919a9e19634ffb9cb6c42d10a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e83a76e3bdf1b06d42c87c2d8bf245e"><td class="memItemLeft" align="right" valign="top">TVG_DEPRECATED 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__Canvas.html#ga6e83a76e3bdf1b06d42c87c2d8bf245e">tvg_canvas_reserve</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, uint32_t n)</td></tr>
<tr class="memdesc:ga6e83a76e3bdf1b06d42c87c2d8bf245e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserves a memory block where the objects pushed into a canvas are stored. <a href="group__ThorVGCapi__Canvas.html#ga6e83a76e3bdf1b06d42c87c2d8bf245e">More...</a><br /></td></tr>
<tr class="separator:ga6e83a76e3bdf1b06d42c87c2d8bf245e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca4447f647446c29b90cc443aa84f032"><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__Canvas.html#gaca4447f647446c29b90cc443aa84f032">tvg_canvas_clear</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, bool free)</td></tr>
<tr class="memdesc:gaca4447f647446c29b90cc443aa84f032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in the canvas are released if <code>free</code> is set to <code>true</code>, otherwise the memory is not deallocated and all paints should be released manually in order to avoid memory leaks. <a href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032">More...</a><br /></td></tr>
<tr class="separator:gaca4447f647446c29b90cc443aa84f032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade13cc1e7b4f28a9dac93e44ef12709c"><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__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c">tvg_canvas_update</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas)</td></tr>
<tr class="memdesc:gade13cc1e7b4f28a9dac93e44ef12709c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates all paints in a canvas. <a href="group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c">More...</a><br /></td></tr>
<tr class="separator:gade13cc1e7b4f28a9dac93e44ef12709c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad6d3fa1de2b17799dbf6e822fff30d1c"><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__Canvas.html#gad6d3fa1de2b17799dbf6e822fff30d1c">tvg_canvas_update_paint</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
<tr class="memdesc:gad6d3fa1de2b17799dbf6e822fff30d1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the given Tvg_Paint object from the canvas before the rendering. <a href="group__ThorVGCapi__Canvas.html#gad6d3fa1de2b17799dbf6e822fff30d1c">More...</a><br /></td></tr>
<tr class="separator:gad6d3fa1de2b17799dbf6e822fff30d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb0f659e1dd0fd71287c3c7ccedca1d2"><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__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2">tvg_canvas_draw</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas)</td></tr>
<tr class="memdesc:gafb0f659e1dd0fd71287c3c7ccedca1d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requests the canvas to draw the Tvg_Paint objects. <a href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2">More...</a><br /></td></tr>
<tr class="separator:gafb0f659e1dd0fd71287c3c7ccedca1d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0b79fd5411b47faf7b185c2e01034ce"><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__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce">tvg_canvas_sync</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas)</td></tr>
<tr class="memdesc:gad0b79fd5411b47faf7b185c2e01034ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Guarantees that the drawing process is finished. <a href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce">More...</a><br /></td></tr>
<tr class="separator:gad0b79fd5411b47faf7b185c2e01034ce"><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 managing and drawing graphical elements. </p>
<p>A canvas is an entity responsible for drawing the target. It sets up the drawing engine and the buffer, which can be drawn on the screen. It also manages given Paint objects.</p>
<dl class="section note"><dt>Note</dt><dd>A Canvas behavior depends on the raster engine though the final content of the buffer is expected to be identical. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The Paint objects belonging to one Canvas can't be shared among multiple Canvases. </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaca4447f647446c29b90cc443aa84f032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca4447f647446c29b90cc443aa84f032">&#9670;&nbsp;</a></span>tvg_canvas_clear()</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_canvas_clear </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">bool&#160;</td>
<td class="paramname"><em>free</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in the canvas are released if <code>free</code> is set to <code>true</code>, otherwise the memory is not deallocated and all paints should be released manually in order to avoid memory leaks. </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 to be cleared. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">free</td><td>If <code>true</code> the memory occupied by paints is deallocated, otherwise it is 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>An invalid Tvg_Canvas pointer. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Please use the <code>free</code> argument only when you know how it works, otherwise it's not recommended.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295" title="Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...">tvg_canvas_destroy()</a> </dd></dl>
</div>
</div>
<a id="ga15208125646162cd19a928708a335295"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15208125646162cd19a928708a335295">&#9670;&nbsp;</a></span>tvg_canvas_destroy()</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_canvas_destroy </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas object itself. </p>
<div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas = NULL;</div>
<div class="line"><span class="keyword">static</span> uint32_t *buffer = NULL;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> _init() {</div>
<div class="line"> canvas = <a class="code" href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a>();</div>
<div class="line"> buffer = (uint32_t*) malloc(<span class="keyword">sizeof</span>(uint32_t) * 100 * 100);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a>(canvas, buffer, 100, 100, 100, <a class="code" href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a>);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">//a task called from main function in a loop</span></div>
<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> _job(<span class="keyword">const</span> <span class="keywordtype">int</span> cmd) {</div>
<div class="line"> <span class="comment">//define a valid rectangle shape</span></div>
<div class="line"> <span class="keywordflow">switch</span> (cmd) {</div>
<div class="line"> <span class="keywordflow">case</span> CMD_EXIT: <span class="keywordflow">return</span> 0;</div>
<div class="line"> <span class="keywordflow">case</span> CMD_ADD_RECT:</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75">tvg_canvas_push</a>(canvas, rect);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> CMD_DEL_RECT:</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">tvg_paint_del</a>(rect);</div>
<div class="line"> <span class="comment">//now to safely delete Tvg_Canvas, tvg_canvas_clear() API have to be used</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">default</span>:</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv) {</div>
<div class="line"> <span class="keywordtype">int</span> cmd = 0;</div>
<div class="line"> <span class="keywordtype">int</span> stop = 1;</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 4);</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">while</span> (stop) {</div>
<div class="line"> <span class="comment">//wait for a command e.g. from a console</span></div>
<div class="line"> stop = _job(cmd);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032">tvg_canvas_clear</a>(canvas, <span class="keyword">false</span>);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a>(canvas);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>);</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a>(canvas);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>)</div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_ga15208125646162cd19a928708a335295"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_destroy(Tvg_Canvas *canvas)</div><div class="ttdoc">Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_ga81ac2919a9e19634ffb9cb6c42d10a75"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75">tvg_canvas_push</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_push(Tvg_Canvas *canvas, Tvg_Paint *paint)</div><div class="ttdoc">Inserts a drawing element into the canvas using a Tvg_Paint object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_gaca4447f647446c29b90cc443aa84f032"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032">tvg_canvas_clear</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_clear(Tvg_Canvas *canvas, bool free)</div><div class="ttdoc">Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ga437d5601fe8dc17eb4788b7694000452"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_init(Tvg_Engine engine_method, unsigned threads)</div><div class="ttdoc">Initializes TVG engines.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_gaaee6b1a83765cfecd47d8f979a9a3211"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_term(Tvg_Engine engine_method)</div><div class="ttdoc">Terminates TVG engines.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a></div><div class="ttdeci">@ TVG_ENGINE_SW</div><div class="ttdoc">CPU rasterizer.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:106</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Paint_html_ga4d4d3afa5b161c44155f40790d869e83"><div class="ttname"><a href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">tvg_paint_del</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_paint_del(Tvg_Paint *paint)</div><div class="ttdoc">Releases the given Tvg_Paint object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ga1929b0e99eff5584ed03c36cdfa81065"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a></div><div class="ttdeci">TVG_API Tvg_Canvas * tvg_swcanvas_create()</div><div class="ttdoc">Creates a Canvas object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ga7bd619a80e4a2ba4bc012734387a2010"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_swcanvas_set_target(Tvg_Canvas *canvas, uint32_t *buffer, uint32_t stride, uint32_t w, uint32_t h, Tvg_Colorspace cs)</div><div class="ttdoc">Sets the buffer used in the rasterization process and defines the used colorspace.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a></div><div class="ttdeci">@ TVG_COLORSPACE_ARGB8888</div><div class="ttdoc">The 8-bit color channels are combined into 32-bit color in the order: alpha, red, green,...</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:372</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga5f10c1f3dabdc9287166611c7fe5fd8a"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a></div><div class="ttdeci">struct _Tvg_Canvas Tvg_Canvas</div><div class="ttdoc">A structure responsible for managing and drawing graphical elements.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:77</div></div>
</div><!-- fragment --><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 to be destroyed.</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 Tvg_Canvas object is passed.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If the paints from the canvas should not be released, the <a class="el" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a> with a <code>free</code> argument value set to <code>false</code> should be called. Please be aware that in such a case TVG is not responsible for the paints release anymore and it has to be done manually in order to avoid memory leaks.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83" title="Releases the given Tvg_Paint object.">tvg_paint_del()</a>, <a class="el" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a> </dd></dl>
</div>
</div>
<a id="gafb0f659e1dd0fd71287c3c7ccedca1d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb0f659e1dd0fd71287c3c7ccedca1d2">&#9670;&nbsp;</a></span>tvg_canvas_draw()</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_canvas_draw </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Requests the canvas to draw the Tvg_Paint objects. </p>
<p>All paints from the given canvas will be rasterized to the buffer.</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 containing elements 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 Tvg_Canvas pointer. </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>Drawing can be asynchronous based on the assigned thread number. To guarantee the drawing is done, call <a class="el" href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce" title="Guarantees that the drawing process is finished.">tvg_canvas_sync()</a> afterwards. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce" title="Guarantees that the drawing process is finished.">tvg_canvas_sync()</a> </dd></dl>
</div>
</div>
<a id="ga81ac2919a9e19634ffb9cb6c42d10a75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81ac2919a9e19634ffb9cb6c42d10a75">&#9670;&nbsp;</a></span>tvg_canvas_push()</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_canvas_push </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"><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>Inserts a drawing element into the canvas using a Tvg_Paint object. </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>paint</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be drawn.</td></tr>
</table>
</dd>
</dl>
<p>Only the paints pushed into the canvas will be drawing targets. They are retained by the canvas until you call <a class="el" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a>. If you know the number of the pushed objects in advance, please call <a class="el" href="group__ThorVGCapi__Canvas.html#ga6e83a76e3bdf1b06d42c87c2d8bf245e" title="Reserves a memory block where the objects pushed into a canvas are stored.">tvg_canvas_reserve()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result return values: </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. </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__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a> </dd></dl>
</div>
</div>
<a id="ga6e83a76e3bdf1b06d42c87c2d8bf245e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e83a76e3bdf1b06d42c87c2d8bf245e">&#9670;&nbsp;</a></span>tvg_canvas_reserve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_DEPRECATED TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_canvas_reserve </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>n</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserves a memory block where the objects pushed into a canvas are stored. </p>
<p>If the number of Tvg_Paints to be stored in a canvas is known in advance, calling this function reduces the multiple memory allocations thus improves the performance.</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#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 4);</div>
<div class="line">canvas = <a class="code" href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a>();</div>
<div class="line"> </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#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a>(canvas, buffer, 100, 100, 100, <a class="code" href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a>);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a>(canvas);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>)</div>
</div><!-- fragment --><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 reserved memory. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</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_Canvas pointer. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad0b79fd5411b47faf7b185c2e01034ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0b79fd5411b47faf7b185c2e01034ce">&#9670;&nbsp;</a></span>tvg_canvas_sync()</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_canvas_sync </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Guarantees that the drawing process is finished. </p>
<p>Since the canvas rendering can be performed asynchronously, it should be called after the <a class="el" href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2" title="Requests the canvas to draw the Tvg_Paint objects.">tvg_canvas_draw()</a>.</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 containing elements which were 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 Tvg_Canvas pointer. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2" title="Requests the canvas to draw the Tvg_Paint objects.">tvg_canvas_draw()</a> </dd></dl>
</div>
</div>
<a id="gade13cc1e7b4f28a9dac93e44ef12709c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade13cc1e7b4f28a9dac93e44ef12709c">&#9670;&nbsp;</a></span>tvg_canvas_update()</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_canvas_update </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates all paints in a canvas. </p>
<p>Should be called before drawing in order to prepare paints for the rendering.</p>
<div class="fragment"><div class="line"><span class="comment">//A frame drawing example. Thread safety and events implementation is skipped to show only TVG code.</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas = NULL;</div>
<div class="line"><span class="keyword">static</span> <a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *rect = NULL;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> _frame_render(<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c">tvg_canvas_update</a>(canvas);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2">tvg_canvas_draw</a>(canvas);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce">tvg_canvas_sync</a>(canvas);</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">//event handler from your code or third party library</span></div>
<div class="line"><span class="keywordtype">void</span> _event_handler(event *event_data) {</div>
<div class="line"> <span class="keywordflow">if</span> (!event_data) <span class="keywordflow">return</span> NULL;</div>
<div class="line"> <span class="keywordflow">switch</span>(event_data.type) {</div>
<div class="line"> <span class="keywordflow">case</span> EVENT_RECT_ADD:</div>
<div class="line"> <span class="keywordflow">if</span> (!rect) {</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Shape.html#ga08d388f8a75ac13c9a4e8717663b61ad">tvg_shape_append_rect</a>(rect, 10, 10, 50, 50, 0, 0);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Shape.html#ga984061de00f2d76714e354b165365bab">tvg_shape_set_stroke_width</a>(rect, 1.0f);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Shape.html#gacc948f2205c906ce4e17baad36a0ee3f">tvg_shape_set_stroke_color</a>(rect, 255, 0, 0, 255);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75">tvg_canvas_push</a>(canvas, rect);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> EVENT_RECT_MOVE:</div>
<div class="line"> <span class="keywordflow">if</span> (rect) <a class="code" href="group__ThorVGCapi__Paint.html#ga18f9577abca1cee26f297b76a7bf2ff0">tvg_paint_translate</a>(rect, 10.0, 10.0);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">default</span>:</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv) {</div>
<div class="line"> <span class="comment">//example handler from your code or third party lib</span></div>
<div class="line"> event_handler_add(handler, _event_handler);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">//create frame rendering process which calls _frame_render() function.</span></div>
<div class="line"> app_loop_begin(_frame_render);</div>
<div class="line"> app_loop_finish();</div>
<div class="line"> cleanup();</div>
<div class="line">}</div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_gad0b79fd5411b47faf7b185c2e01034ce"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce">tvg_canvas_sync</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_sync(Tvg_Canvas *canvas)</div><div class="ttdoc">Guarantees that the drawing process is finished.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_gade13cc1e7b4f28a9dac93e44ef12709c"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c">tvg_canvas_update</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_update(Tvg_Canvas *canvas)</div><div class="ttdoc">Updates all paints in a canvas.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_gafb0f659e1dd0fd71287c3c7ccedca1d2"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2">tvg_canvas_draw</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_draw(Tvg_Canvas *canvas)</div><div class="ttdoc">Requests the canvas to draw the Tvg_Paint objects.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Paint_html_ga18f9577abca1cee26f297b76a7bf2ff0"><div class="ttname"><a href="group__ThorVGCapi__Paint.html#ga18f9577abca1cee26f297b76a7bf2ff0">tvg_paint_translate</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_paint_translate(Tvg_Paint *paint, float x, float y)</div><div class="ttdoc">Moves the given Tvg_Paint in a two-dimensional space.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga08d388f8a75ac13c9a4e8717663b61ad"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga08d388f8a75ac13c9a4e8717663b61ad">tvg_shape_append_rect</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_append_rect(Tvg_Paint *paint, float x, float y, float w, float h, float rx, float ry)</div><div class="ttdoc">Appends a rectangle to the path.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga984061de00f2d76714e354b165365bab"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga984061de00f2d76714e354b165365bab">tvg_shape_set_stroke_width</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_set_stroke_width(Tvg_Paint *paint, float width)</div><div class="ttdoc">Sets the stroke width for all of the figures from the paint.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_gacc948f2205c906ce4e17baad36a0ee3f"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#gacc948f2205c906ce4e17baad36a0ee3f">tvg_shape_set_stroke_color</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_set_stroke_color(Tvg_Paint *paint, uint8_t r, uint8_t g, uint8_t b, uint8_t a)</div><div class="ttdoc">Sets the shape's stroke color.</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga98af7c3fe18afa8ad65ea6a6e097a292"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></div><div class="ttdeci">struct _Tvg_Paint Tvg_Paint</div><div class="ttdoc">A structure representing a graphical element.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:85</div></div>
</div><!-- fragment --><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 to be updated.</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_Canvas pointer. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#gad6d3fa1de2b17799dbf6e822fff30d1c" title="Updates the given Tvg_Paint object from the canvas before the rendering.">tvg_canvas_update_paint()</a> </dd></dl>
</div>
</div>
<a id="gad6d3fa1de2b17799dbf6e822fff30d1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6d3fa1de2b17799dbf6e822fff30d1c">&#9670;&nbsp;</a></span>tvg_canvas_update_paint()</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_canvas_update_paint </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"><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>Updates the given Tvg_Paint object from the canvas before the rendering. </p>
<p>If a client application using the TVG library does not update the entire canvas with <a class="el" href="group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c" title="Updates all paints in a canvas.">tvg_canvas_update()</a> in the frame rendering process, Tvg_Paint objects previously added to the canvas should be updated manually with this function.</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 to which the <code>paint</code> belongs. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be updated.</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.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c" title="Updates all paints in a canvas.">tvg_canvas_update()</a> </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>

View file

@ -1,12 +0,0 @@
var group__ThorVGCapi__Canvas =
[
[ "SwCanvas", "group__ThorVGCapi__SwCanvas.html", "group__ThorVGCapi__SwCanvas" ],
[ "tvg_canvas_clear", "group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032", null ],
[ "tvg_canvas_destroy", "group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295", null ],
[ "tvg_canvas_draw", "group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2", null ],
[ "tvg_canvas_push", "group__ThorVGCapi__Canvas.html#ga81ac2919a9e19634ffb9cb6c42d10a75", null ],
[ "tvg_canvas_reserve", "group__ThorVGCapi__Canvas.html#ga6e83a76e3bdf1b06d42c87c2d8bf245e", null ],
[ "tvg_canvas_sync", "group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce", null ],
[ "tvg_canvas_update", "group__ThorVGCapi__Canvas.html#gade13cc1e7b4f28a9dac93e44ef12709c", null ],
[ "tvg_canvas_update_paint", "group__ThorVGCapi__Canvas.html#gad6d3fa1de2b17799dbf6e822fff30d1c", null ]
];

View file

@ -1,5 +0,0 @@
<map id="Canvas" name="Canvas">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" title="A module for managing and drawing graphical elements." alt="" coords="160,5,231,31"/>
<area shape="rect" id="node3" href="$group__ThorVGCapi__SwCanvas.html" title="A module for rendering the graphical elements using the software engine." alt="" coords="279,5,368,31"/>
</map>

View file

@ -1 +0,0 @@
2e453c06c8f1182a1a0f31e1920ddb6b

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

View file

@ -1,897 +0,0 @@
<!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: Gradient</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__Gradient.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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Gradient<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 managing the gradient fill of objects.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Gradient:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Gradient.png" border="0" usemap="#agroup____ThorVGCapi____Gradient" alt=""/></div>
<map name="agroup____ThorVGCapi____Gradient" id="agroup____ThorVGCapi____Gradient">
<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 managing the gradient fill of objects." alt="" coords="160,5,239,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A data structure storing the information about the color and its relative position inside the gradient bounds. <a href="structTvg__Color__Stop.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga250bedd843e16e3df7a13a43aee9af16"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga250bedd843e16e3df7a13a43aee9af16">tvg_linear_gradient_new</a> ()</td></tr>
<tr class="memdesc:ga250bedd843e16e3df7a13a43aee9af16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new linear gradient object. <a href="group__ThorVGCapi__Gradient.html#ga250bedd843e16e3df7a13a43aee9af16">More...</a><br /></td></tr>
<tr class="separator:ga250bedd843e16e3df7a13a43aee9af16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3329d7a0b5aa394a3a8d900a45dc1996"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga3329d7a0b5aa394a3a8d900a45dc1996">tvg_radial_gradient_new</a> ()</td></tr>
<tr class="memdesc:ga3329d7a0b5aa394a3a8d900a45dc1996"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new radial gradient object. <a href="group__ThorVGCapi__Gradient.html#ga3329d7a0b5aa394a3a8d900a45dc1996">More...</a><br /></td></tr>
<tr class="separator:ga3329d7a0b5aa394a3a8d900a45dc1996"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bcaa032e59ada34d5b80eaa35fcc974"><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__Gradient.html#ga2bcaa032e59ada34d5b80eaa35fcc974">tvg_linear_gradient_set</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float x1, float y1, float x2, float y2)</td></tr>
<tr class="memdesc:ga2bcaa032e59ada34d5b80eaa35fcc974"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the linear gradient bounds. <a href="group__ThorVGCapi__Gradient.html#ga2bcaa032e59ada34d5b80eaa35fcc974">More...</a><br /></td></tr>
<tr class="separator:ga2bcaa032e59ada34d5b80eaa35fcc974"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7fff85ee61e7e701474ec7686af9af5e"><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__Gradient.html#ga7fff85ee61e7e701474ec7686af9af5e">tvg_linear_gradient_get</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float *x1, float *y1, float *x2, float *y2)</td></tr>
<tr class="memdesc:ga7fff85ee61e7e701474ec7686af9af5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the linear gradient bounds. <a href="group__ThorVGCapi__Gradient.html#ga7fff85ee61e7e701474ec7686af9af5e">More...</a><br /></td></tr>
<tr class="separator:ga7fff85ee61e7e701474ec7686af9af5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf84fb90f1d9ce917b44f6b178e86f394"><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__Gradient.html#gaf84fb90f1d9ce917b44f6b178e86f394">tvg_radial_gradient_set</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float cx, float cy, float radius)</td></tr>
<tr class="memdesc:gaf84fb90f1d9ce917b44f6b178e86f394"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the radial gradient bounds. <a href="group__ThorVGCapi__Gradient.html#gaf84fb90f1d9ce917b44f6b178e86f394">More...</a><br /></td></tr>
<tr class="separator:gaf84fb90f1d9ce917b44f6b178e86f394"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57fc9b59e6c1c9af8e8020ade3df4c74"><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__Gradient.html#ga57fc9b59e6c1c9af8e8020ade3df4c74">tvg_radial_gradient_get</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float *cx, float *cy, float *radius)</td></tr>
<tr class="memdesc:ga57fc9b59e6c1c9af8e8020ade3df4c74"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function gets radial gradient center point ant radius. <a href="group__ThorVGCapi__Gradient.html#ga57fc9b59e6c1c9af8e8020ade3df4c74">More...</a><br /></td></tr>
<tr class="separator:ga57fc9b59e6c1c9af8e8020ade3df4c74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9424f4880bc4122a7f56635ca7f25889"><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__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889">tvg_gradient_set_color_stops</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> *color_stop, uint32_t cnt)</td></tr>
<tr class="memdesc:ga9424f4880bc4122a7f56635ca7f25889"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the parameters of the colors of the gradient and their position. <a href="group__ThorVGCapi__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889">More...</a><br /></td></tr>
<tr class="separator:ga9424f4880bc4122a7f56635ca7f25889"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46854f8a3c3e065720a18b3df7207db9"><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__Gradient.html#ga46854f8a3c3e065720a18b3df7207db9">tvg_gradient_get_color_stops</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> **color_stop, uint32_t *cnt)</td></tr>
<tr class="memdesc:ga46854f8a3c3e065720a18b3df7207db9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the parameters of the colors of the gradient, their position and number. <a href="group__ThorVGCapi__Gradient.html#ga46854f8a3c3e065720a18b3df7207db9">More...</a><br /></td></tr>
<tr class="separator:ga46854f8a3c3e065720a18b3df7207db9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5407c91928413ab2e0c07f21fc9126d1"><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__Gradient.html#ga5407c91928413ab2e0c07f21fc9126d1">tvg_gradient_set_spread</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> spread)</td></tr>
<tr class="memdesc:ga5407c91928413ab2e0c07f21fc9126d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds. <a href="group__ThorVGCapi__Gradient.html#ga5407c91928413ab2e0c07f21fc9126d1">More...</a><br /></td></tr>
<tr class="separator:ga5407c91928413ab2e0c07f21fc9126d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31925c3e2611bd246c9dd49dca86465e"><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__Gradient.html#ga31925c3e2611bd246c9dd49dca86465e">tvg_gradient_get_spread</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> *spread)</td></tr>
<tr class="memdesc:ga31925c3e2611bd246c9dd49dca86465e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the FillSpread value of the gradient object. <a href="group__ThorVGCapi__Gradient.html#ga31925c3e2611bd246c9dd49dca86465e">More...</a><br /></td></tr>
<tr class="separator:ga31925c3e2611bd246c9dd49dca86465e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a84e32416b05d118a779b04b7383d20"><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__Gradient.html#ga2a84e32416b05d118a779b04b7383d20">tvg_gradient_set_transform</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:ga2a84e32416b05d118a779b04b7383d20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the matrix of the affine transformation for the gradient object. <a href="group__ThorVGCapi__Gradient.html#ga2a84e32416b05d118a779b04b7383d20">More...</a><br /></td></tr>
<tr class="separator:ga2a84e32416b05d118a779b04b7383d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf0e1346b565ac80a728fd846971fb03f"><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__Gradient.html#gaf0e1346b565ac80a728fd846971fb03f">tvg_gradient_get_transform</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:gaf0e1346b565ac80a728fd846971fb03f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the matrix of the affine transformation of the gradient object. <a href="group__ThorVGCapi__Gradient.html#gaf0e1346b565ac80a728fd846971fb03f">More...</a><br /></td></tr>
<tr class="separator:gaf0e1346b565ac80a728fd846971fb03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1390cbddb9593f75584d8da7b2d447a4"><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__Gradient.html#ga1390cbddb9593f75584d8da7b2d447a4">tvg_gradient_get_identifier</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, <a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a> *identifier)</td></tr>
<tr class="memdesc:ga1390cbddb9593f75584d8da7b2d447a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the unique id value of the gradient instance indicating the instance type. <a href="group__ThorVGCapi__Gradient.html#ga1390cbddb9593f75584d8da7b2d447a4">More...</a><br /></td></tr>
<tr class="separator:ga1390cbddb9593f75584d8da7b2d447a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12eacb79ee372dc28c07c28cb9053546"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga12eacb79ee372dc28c07c28cb9053546">tvg_gradient_duplicate</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad)</td></tr>
<tr class="memdesc:ga12eacb79ee372dc28c07c28cb9053546"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the given Tvg_Gradient object. <a href="group__ThorVGCapi__Gradient.html#ga12eacb79ee372dc28c07c28cb9053546">More...</a><br /></td></tr>
<tr class="separator:ga12eacb79ee372dc28c07c28cb9053546"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga35017dd0afb4c7cbf7efe6f46e6d05f4"><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__Gradient.html#ga35017dd0afb4c7cbf7efe6f46e6d05f4">tvg_gradient_del</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad)</td></tr>
<tr class="memdesc:ga35017dd0afb4c7cbf7efe6f46e6d05f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the given gradient object. <a href="group__ThorVGCapi__Gradient.html#ga35017dd0afb4c7cbf7efe6f46e6d05f4">More...</a><br /></td></tr>
<tr class="separator:ga35017dd0afb4c7cbf7efe6f46e6d05f4"><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 gradient fill of objects. </p>
<p>The module enables to set and to get the gradient colors and their arrangement inside the gradient bounds, to specify the gradient bounds and the gradient behavior in case the area defined by the gradient bounds is smaller than the area to be filled. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga35017dd0afb4c7cbf7efe6f46e6d05f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35017dd0afb4c7cbf7efe6f46e6d05f4">&#9670;&nbsp;</a></span>tvg_gradient_del()</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_gradient_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the given gradient object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The gradient 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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga12eacb79ee372dc28c07c28cb9053546"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12eacb79ee372dc28c07c28cb9053546">&#9670;&nbsp;</a></span>tvg_gradient_duplicate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_gradient_duplicate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Duplicates the given Tvg_Gradient object. </p>
<p>Creates a new object and sets its all properties as in the original object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object to be copied.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A copied Tvg_Gradient object if succeed, <code>nullptr</code> otherwise. </dd></dl>
</div>
</div>
<a id="ga46854f8a3c3e065720a18b3df7207db9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46854f8a3c3e065720a18b3df7207db9">&#9670;&nbsp;</a></span>tvg_gradient_get_color_stops()</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_gradient_get_color_stops </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> **&#160;</td>
<td class="paramname"><em>color_stop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>cnt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the parameters of the colors of the gradient, their position and number. </p>
<p>The function does not allocate any memory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the color information. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">color_stop</td><td>An array of <a class="el" href="structTvg__Color__Stop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">Tvg_Color_Stop</a> data structure. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cnt</td><td>The size of the <code>color_stop</code> array equal to the colors number used in the gradient.</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>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1390cbddb9593f75584d8da7b2d447a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1390cbddb9593f75584d8da7b2d447a4">&#9670;&nbsp;</a></span>tvg_gradient_get_identifier()</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_gradient_get_identifier </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a> *&#160;</td>
<td class="paramname"><em>identifier</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the unique id value of the gradient instance indicating the instance type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the identifier value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">identifier</td><td>The unique identifier of the gradient instance type.</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.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</div>
</div>
<a id="ga31925c3e2611bd246c9dd49dca86465e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31925c3e2611bd246c9dd49dca86465e">&#9670;&nbsp;</a></span>tvg_gradient_get_spread()</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_gradient_get_spread </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> *&#160;</td>
<td class="paramname"><em>spread</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the FillSpread value of the gradient object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">spread</td><td>The FillSpread value.</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>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf0e1346b565ac80a728fd846971fb03f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0e1346b565ac80a728fd846971fb03f">&#9670;&nbsp;</a></span>tvg_gradient_get_transform()</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_gradient_get_transform </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the matrix of the affine transformation of the gradient object. </p>
<p>In case no transformation was applied, the identity matrix is set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the transformation matrix. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</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> is passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9424f4880bc4122a7f56635ca7f25889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9424f4880bc4122a7f56635ca7f25889">&#9670;&nbsp;</a></span>tvg_gradient_set_color_stops()</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_gradient_set_color_stops </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> *&#160;</td>
<td class="paramname"><em>color_stop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>cnt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the parameters of the colors of the gradient and their position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which the color information is to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">color_stop</td><td>An array of <a class="el" href="structTvg__Color__Stop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">Tvg_Color_Stop</a> data structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>The size of the <code>color_stop</code> array equal to the colors number used in the gradient.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5407c91928413ab2e0c07f21fc9126d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5407c91928413ab2e0c07f21fc9126d1">&#9670;&nbsp;</a></span>tvg_gradient_set_spread()</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_gradient_set_spread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a>&#160;</td>
<td class="paramname"><em>spread</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">spread</td><td>The FillSpread value.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga2a84e32416b05d118a779b04b7383d20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2a84e32416b05d118a779b04b7383d20">&#9670;&nbsp;</a></span>tvg_gradient_set_transform()</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_gradient_set_transform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the matrix of the affine transformation for the gradient object. </p>
<p>The augmented matrix of the transformation is expected to be given.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object to be transformed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</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> is passed as the argument. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with a memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga7fff85ee61e7e701474ec7686af9af5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fff85ee61e7e701474ec7686af9af5e">&#9670;&nbsp;</a></span>tvg_linear_gradient_get()</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_linear_gradient_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>y2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the linear gradient bounds. </p>
<p>The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>), respectively. Both lines are perpendicular to the line linking (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">x1</td><td>The horizontal coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">y1</td><td>The vertical coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">x2</td><td>The horizontal coordinate of the second point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">y2</td><td>The vertical coordinate of the second point used to determine the gradient bounds.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga250bedd843e16e3df7a13a43aee9af16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga250bedd843e16e3df7a13a43aee9af16">&#9670;&nbsp;</a></span>tvg_linear_gradient_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#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_linear_gradient_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new linear gradient object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* shape = <a class="code" href="group__ThorVGCapi__Shape.html#gaab3a6e911389e34f0ab01705958f555e">tvg_shape_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#ga08d388f8a75ac13c9a4e8717663b61ad">tvg_shape_append_rect</a>(shape, 700, 700, 100, 100, 20, 20);</div>
<div class="line"><a class="code" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* grad = <a class="code" href="group__ThorVGCapi__Gradient.html#ga250bedd843e16e3df7a13a43aee9af16">tvg_linear_gradient_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga2bcaa032e59ada34d5b80eaa35fcc974">tvg_linear_gradient_set</a>(grad, 700, 700, 800, 800);</div>
<div class="line"><a class="code" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> color_stops[2] =</div>
<div class="line">{</div>
<div class="line"> {0.0, 0, 0, 0, 255},</div>
<div class="line"> {1.0, 0, 255, 0, 255},</div>
<div class="line">};</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889">tvg_gradient_set_color_stops</a>(grad, color_stops, 2);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#ga454b875a06e720e8a23e6051d51c613f">tvg_shape_set_linear_gradient</a>(shape, grad);</div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga250bedd843e16e3df7a13a43aee9af16"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga250bedd843e16e3df7a13a43aee9af16">tvg_linear_gradient_new</a></div><div class="ttdeci">TVG_API Tvg_Gradient * tvg_linear_gradient_new()</div><div class="ttdoc">Creates a new linear gradient object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga2bcaa032e59ada34d5b80eaa35fcc974"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga2bcaa032e59ada34d5b80eaa35fcc974">tvg_linear_gradient_set</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_linear_gradient_set(Tvg_Gradient *grad, float x1, float y1, float x2, float y2)</div><div class="ttdoc">Sets the linear gradient bounds.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga9424f4880bc4122a7f56635ca7f25889"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889">tvg_gradient_set_color_stops</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_gradient_set_color_stops(Tvg_Gradient *grad, const Tvg_Color_Stop *color_stop, uint32_t cnt)</div><div class="ttdoc">Sets the parameters of the colors of the gradient and their position.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga08d388f8a75ac13c9a4e8717663b61ad"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga08d388f8a75ac13c9a4e8717663b61ad">tvg_shape_append_rect</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_append_rect(Tvg_Paint *paint, float x, float y, float w, float h, float rx, float ry)</div><div class="ttdoc">Appends a rectangle to the path.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga454b875a06e720e8a23e6051d51c613f"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga454b875a06e720e8a23e6051d51c613f">tvg_shape_set_linear_gradient</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_set_linear_gradient(Tvg_Paint *paint, Tvg_Gradient *grad)</div><div class="ttdoc">Sets the linear gradient fill for all of the figures from the path.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_gaab3a6e911389e34f0ab01705958f555e"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#gaab3a6e911389e34f0ab01705958f555e">tvg_shape_new</a></div><div class="ttdeci">TVG_API Tvg_Paint * tvg_shape_new()</div><div class="ttdoc">Creates a new shape object.</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga98af7c3fe18afa8ad65ea6a6e097a292"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></div><div class="ttdeci">struct _Tvg_Paint Tvg_Paint</div><div class="ttdoc">A structure representing a graphical element.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:85</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_gafc8e0d01812127260d0753eceb056181"><div class="ttname"><a href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a></div><div class="ttdeci">struct _Tvg_Gradient Tvg_Gradient</div><div class="ttdoc">A structure representing a gradient fill of a Tvg_Paint object.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:91</div></div>
<div class="ttc" id="astructTvg__Color__Stop_html"><div class="ttname"><a href="structTvg__Color__Stop.html">Tvg_Color_Stop</a></div><div class="ttdoc">A data structure storing the information about the color and its relative position inside the gradien...</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:225</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new linear gradient object. </dd></dl>
</div>
</div>
<a id="ga2bcaa032e59ada34d5b80eaa35fcc974"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bcaa032e59ada34d5b80eaa35fcc974">&#9670;&nbsp;</a></span>tvg_linear_gradient_set()</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_linear_gradient_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the linear gradient bounds. </p>
<p>The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>), respectively. Both lines are perpendicular to the line linking (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x1</td><td>The horizontal coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y1</td><td>The vertical coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x2</td><td>The horizontal coordinate of the second point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y2</td><td>The vertical coordinate of the second point used to determine the gradient bounds.</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_Gradient pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>In case the first and the second points are equal, an object filled with such a gradient fill is not rendered. </dd></dl>
</div>
</div>
<a id="ga57fc9b59e6c1c9af8e8020ade3df4c74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57fc9b59e6c1c9af8e8020ade3df4c74">&#9670;&nbsp;</a></span>tvg_radial_gradient_get()</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_radial_gradient_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>cx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>cy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>radius</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The function gets radial gradient center point ant radius. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cx</td><td>The horizontal coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cy</td><td>The vertical coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">radius</td><td>The radius of the bounding circle.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3329d7a0b5aa394a3a8d900a45dc1996"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3329d7a0b5aa394a3a8d900a45dc1996">&#9670;&nbsp;</a></span>tvg_radial_gradient_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#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_radial_gradient_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new radial gradient object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* shape = <a class="code" href="group__ThorVGCapi__Shape.html#gaab3a6e911389e34f0ab01705958f555e">tvg_shape_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#ga08d388f8a75ac13c9a4e8717663b61ad">tvg_shape_append_rect</a>(shape, 700, 700, 100, 100, 20, 20);</div>
<div class="line"><a class="code" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* grad = <a class="code" href="group__ThorVGCapi__Gradient.html#ga3329d7a0b5aa394a3a8d900a45dc1996">tvg_radial_gradient_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#gaf84fb90f1d9ce917b44f6b178e86f394">tvg_radial_gradient_set</a>(grad, 550, 550, 50);</div>
<div class="line"><a class="code" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> color_stops[2] =</div>
<div class="line">{</div>
<div class="line"> {0.0, 0, 0, 0, 255},</div>
<div class="line"> {1.0, 0, 255, 0, 255},</div>
<div class="line">};</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889">tvg_gradient_set_color_stops</a>(grad, color_stops, 2);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#gaa6f4d767d0e8a5b7a33a0829c943df06">tvg_shape_set_radial_gradient</a>(shape, grad);</div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga3329d7a0b5aa394a3a8d900a45dc1996"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga3329d7a0b5aa394a3a8d900a45dc1996">tvg_radial_gradient_new</a></div><div class="ttdeci">TVG_API Tvg_Gradient * tvg_radial_gradient_new()</div><div class="ttdoc">Creates a new radial gradient object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_gaf84fb90f1d9ce917b44f6b178e86f394"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#gaf84fb90f1d9ce917b44f6b178e86f394">tvg_radial_gradient_set</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_radial_gradient_set(Tvg_Gradient *grad, float cx, float cy, float radius)</div><div class="ttdoc">Sets the radial gradient bounds.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_gaa6f4d767d0e8a5b7a33a0829c943df06"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#gaa6f4d767d0e8a5b7a33a0829c943df06">tvg_shape_set_radial_gradient</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_shape_set_radial_gradient(Tvg_Paint *paint, Tvg_Gradient *grad)</div><div class="ttdoc">Sets the radial gradient fill for all of the figures from the path.</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new radial gradient object. </dd></dl>
</div>
</div>
<a id="gaf84fb90f1d9ce917b44f6b178e86f394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf84fb90f1d9ce917b44f6b178e86f394">&#9670;&nbsp;</a></span>tvg_radial_gradient_set()</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_radial_gradient_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>cx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>cy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>radius</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the radial gradient bounds. </p>
<p>The radial gradient bounds are defined as a circle centered in a given point (<code>cx</code>, <code>cy</code>) of a given radius.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cx</td><td>The horizontal coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cy</td><td>The vertical coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">radius</td><td>The radius of the bounding circle.</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_Gradient pointer or the <code>radius</code> value less than zero. </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>

View file

@ -1,25 +0,0 @@
var group__ThorVGCapi__Gradient =
[
[ "Tvg_Color_Stop", "structTvg__Color__Stop.html", [
[ "a", "structTvg__Color__Stop.html#af4007aacd75b22aee32dba9ea96082c0", null ],
[ "b", "structTvg__Color__Stop.html#a4313c9563516f94387762ab05763456b", null ],
[ "g", "structTvg__Color__Stop.html#a1673907d4d89d763bb7b94ec1eeb7b60", null ],
[ "offset", "structTvg__Color__Stop.html#a3e60b3c561be982d7c8e23f14c01fd5b", null ],
[ "r", "structTvg__Color__Stop.html#a4c5c6ceb8ed33456261fa907136e0c3a", null ]
] ],
[ "tvg_gradient_del", "group__ThorVGCapi__Gradient.html#ga35017dd0afb4c7cbf7efe6f46e6d05f4", null ],
[ "tvg_gradient_duplicate", "group__ThorVGCapi__Gradient.html#ga12eacb79ee372dc28c07c28cb9053546", null ],
[ "tvg_gradient_get_color_stops", "group__ThorVGCapi__Gradient.html#ga46854f8a3c3e065720a18b3df7207db9", null ],
[ "tvg_gradient_get_identifier", "group__ThorVGCapi__Gradient.html#ga1390cbddb9593f75584d8da7b2d447a4", null ],
[ "tvg_gradient_get_spread", "group__ThorVGCapi__Gradient.html#ga31925c3e2611bd246c9dd49dca86465e", null ],
[ "tvg_gradient_get_transform", "group__ThorVGCapi__Gradient.html#gaf0e1346b565ac80a728fd846971fb03f", null ],
[ "tvg_gradient_set_color_stops", "group__ThorVGCapi__Gradient.html#ga9424f4880bc4122a7f56635ca7f25889", null ],
[ "tvg_gradient_set_spread", "group__ThorVGCapi__Gradient.html#ga5407c91928413ab2e0c07f21fc9126d1", null ],
[ "tvg_gradient_set_transform", "group__ThorVGCapi__Gradient.html#ga2a84e32416b05d118a779b04b7383d20", null ],
[ "tvg_linear_gradient_get", "group__ThorVGCapi__Gradient.html#ga7fff85ee61e7e701474ec7686af9af5e", null ],
[ "tvg_linear_gradient_new", "group__ThorVGCapi__Gradient.html#ga250bedd843e16e3df7a13a43aee9af16", null ],
[ "tvg_linear_gradient_set", "group__ThorVGCapi__Gradient.html#ga2bcaa032e59ada34d5b80eaa35fcc974", null ],
[ "tvg_radial_gradient_get", "group__ThorVGCapi__Gradient.html#ga57fc9b59e6c1c9af8e8020ade3df4c74", null ],
[ "tvg_radial_gradient_new", "group__ThorVGCapi__Gradient.html#ga3329d7a0b5aa394a3a8d900a45dc1996", null ],
[ "tvg_radial_gradient_set", "group__ThorVGCapi__Gradient.html#gaf84fb90f1d9ce917b44f6b178e86f394", null ]
];

View file

@ -1,4 +0,0 @@
<map id="Gradient" name="Gradient">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" title="A module managing the gradient fill of objects." alt="" coords="160,5,239,31"/>
</map>

View file

@ -1 +0,0 @@
5ed575f53580b9f1f946616c4ddd91ad

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.6 KiB

View file

@ -1,267 +0,0 @@
<!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: Initializer</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__Initializer.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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Initializer<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 initialization and termination of the TVG engines.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Initializer:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Initializer.png" border="0" usemap="#agroup____ThorVGCapi____Initializer" alt=""/></div>
<map name="agroup____ThorVGCapi____Initializer" id="agroup____ThorVGCapi____Initializer">
<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 initialization and termination of the TVG engines." alt="" coords="160,5,243,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaa61c2088915fc211ac91ffafaf45f695"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> { <a class="el" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a> = (1 &lt;&lt; 1)
, <a class="el" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a512e634431a51f22e388d7b87828cac1">TVG_ENGINE_GL</a> = (1 &lt;&lt; 2)
}</td></tr>
<tr class="memdesc:gaa61c2088915fc211ac91ffafaf45f695"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise operation is allowed. <a href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">More...</a><br /></td></tr>
<tr class="separator:gaa61c2088915fc211ac91ffafaf45f695"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga437d5601fe8dc17eb4788b7694000452"><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__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a> (<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> engine_method, unsigned threads)</td></tr>
<tr class="memdesc:ga437d5601fe8dc17eb4788b7694000452"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes TVG engines. <a href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">More...</a><br /></td></tr>
<tr class="separator:ga437d5601fe8dc17eb4788b7694000452"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaee6b1a83765cfecd47d8f979a9a3211"><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__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a> (<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> engine_method)</td></tr>
<tr class="memdesc:gaaee6b1a83765cfecd47d8f979a9a3211"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates TVG engines. <a href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">More...</a><br /></td></tr>
<tr class="separator:gaaee6b1a83765cfecd47d8f979a9a3211"><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 initialization and termination of the TVG engines. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaa61c2088915fc211ac91ffafaf45f695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa61c2088915fc211ac91ffafaf45f695">&#9670;&nbsp;</a></span>Tvg_Engine</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise operation is allowed. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96"></a>TVG_ENGINE_SW&#160;</td><td class="fielddoc"><p>CPU rasterizer. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa61c2088915fc211ac91ffafaf45f695a512e634431a51f22e388d7b87828cac1"></a>TVG_ENGINE_GL&#160;</td><td class="fielddoc"><p>OpenGL rasterizer. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga437d5601fe8dc17eb4788b7694000452"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga437d5601fe8dc17eb4788b7694000452">&#9670;&nbsp;</a></span>tvg_engine_init()</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_engine_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a>&#160;</td>
<td class="paramname"><em>engine_method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>threads</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes TVG engines. </p>
<p>TVG requires the running-engine environment. TVG runs its own task-scheduler for parallelizing rendering tasks efficiently. You can indicate the number of threads, the count of which is designated <code>threads</code>. In the initialization step, TVG will generate/spawn the threads as set by <code>threads</code> count.</p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 0); <span class="comment">//Initialize software renderer and use the main thread only</span></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ga437d5601fe8dc17eb4788b7694000452"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_init(Tvg_Engine engine_method, unsigned threads)</div><div class="ttdoc">Initializes TVG engines.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a></div><div class="ttdeci">@ TVG_ENGINE_SW</div><div class="ttdoc">CPU rasterizer.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:106</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">engine_method</td><td>The engine types to initialize. This is relative to the Canvas types, in which it will be used. For multiple backends bitwise operation is allowed.<ul>
<li>TVG_ENGINE_SW: CPU rasterizer</li>
<li>TVG_ENGINE_GL: OpenGL rasterizer (not supported yet) </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">threads</td><td>The number of additional threads used to perform rendering. Zero indicates only the main thread is to be used.</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_FAILED_ALLOCATION</td><td>An internal error possibly with memory allocation. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>Unknown engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>Unsupported engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>Other error.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The Initializer keeps track of the number of times it was called. Threads count is fixed at the first init() call. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211" title="Terminates TVG engines.">tvg_engine_term()</a> </dd>
<dd>
<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695" title="Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise o...">Tvg_Engine</a> </dd></dl>
</div>
</div>
<a id="gaaee6b1a83765cfecd47d8f979a9a3211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaee6b1a83765cfecd47d8f979a9a3211">&#9670;&nbsp;</a></span>tvg_engine_term()</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_engine_term </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a>&#160;</td>
<td class="paramname"><em>engine_method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates TVG engines. </p>
<p>It should be called in case of termination of the TVG client with the same engine types as were passed when <a class="el" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452" title="Initializes TVG engines.">tvg_engine_init()</a> was called.</p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 0);</div>
<div class="line"><span class="comment">//define canvas and shapes, update shapes, general rendering calls</span></div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>);</div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_gaaee6b1a83765cfecd47d8f979a9a3211"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_term(Tvg_Engine engine_method)</div><div class="ttdoc">Terminates TVG engines.</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine_method</td><td>The engine types to terminate. This is relative to the Canvas types, in which it will be used. For multiple backends bitwise operation is allowed<ul>
<li>TVG_ENGINE_SW: CPU rasterizer</li>
<li>TVG_ENGINE_GL: OpenGL rasterizer (not supported yet)</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_INSUFFICIENT_CONDITION</td><td>Nothing to be terminated. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>Unknown engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>Unsupported engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452" title="Initializes TVG engines.">tvg_engine_init()</a> </dd>
<dd>
<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695" title="Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise o...">Tvg_Engine</a> </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>

View file

@ -1,9 +0,0 @@
var group__ThorVGCapi__Initializer =
[
[ "Tvg_Engine", "group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695", [
[ "TVG_ENGINE_SW", "group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96", null ],
[ "TVG_ENGINE_GL", "group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a512e634431a51f22e388d7b87828cac1", null ]
] ],
[ "tvg_engine_init", "group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452", null ],
[ "tvg_engine_term", "group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211", null ]
];

View file

@ -1,4 +0,0 @@
<map id="Initializer" name="Initializer">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" title="A module enabling initialization and termination of the TVG engines." alt="" coords="160,5,243,31"/>
</map>

View file

@ -1 +0,0 @@
a876f294b034ffcd3ac1c3151851ce1c

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

View file

@ -1,885 +0,0 @@
<!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: Paint</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__Paint.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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Paint<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 managing graphical elements. It enables duplication, transformation and composition.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Paint:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Paint.png" border="0" usemap="#agroup____ThorVGCapi____Paint" alt=""/></div>
<map name="agroup____ThorVGCapi____Paint" id="agroup____ThorVGCapi____Paint">
<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 managing graphical elements. It enables duplication, transformation and composition." alt="" coords="160,5,215,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> { <br />
&#160;&#160;<a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa9122090fc6c074e22fa0964effa1b375">TVG_COMPOSITE_METHOD_NONE</a> = 0
, <a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa517f996a4e50e88727607b959ce52852">TVG_COMPOSITE_METHOD_CLIP_PATH</a>
, <a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aae536c237d654d73f306f2d346fc3c86a">TVG_COMPOSITE_METHOD_ALPHA_MASK</a>
, <a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aaf5b9626da41b4a50070f97139062c759">TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK</a>
, <br />
&#160;&#160;<a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa0780ffcaadd9a4396a8c2342a05f2d79">TVG_COMPOSITE_METHOD_LUMA_MASK</a>
<br />
}</td></tr>
<tr class="memdesc:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration indicating the method used in the composition of two objects - the target and the source. <a href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">More...</a><br /></td></tr>
<tr class="separator:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga906459e9a724fa6d89d18c5dedeb619f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a> { <br />
&#160;&#160;<a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa4835d63e75912ad680a068f82616e311">TVG_IDENTIFIER_UNDEF</a> = 0
, <a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa105de16ee2517a216f2bc7ed6a5e7b69">TVG_IDENTIFIER_SHAPE</a>
, <a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa77977fb5cff9194b55ecb96492fe8f3e">TVG_IDENTIFIER_SCENE</a>
, <a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa3ddbd748d2bf2936b6151ba50879a1e8">TVG_IDENTIFIER_PICTURE</a>
, <br />
&#160;&#160;<a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa933f17c80ac7b0c474965a2175b19293">TVG_IDENTIFIER_LINEAR_GRAD</a>
, <a class="el" href="group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa73a9ed807395d0f3ac0d7218a37c225f">TVG_IDENTIFIER_RADIAL_GRAD</a>
<br />
}</td></tr>
<tr class="memdesc:ga906459e9a724fa6d89d18c5dedeb619f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration indicating the ThorVG class type. <a href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">More...</a><br /></td></tr>
<tr class="separator:ga906459e9a724fa6d89d18c5dedeb619f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4d4d3afa5b161c44155f40790d869e83"><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__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">tvg_paint_del</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
<tr class="memdesc:ga4d4d3afa5b161c44155f40790d869e83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the given Tvg_Paint object. <a href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">More...</a><br /></td></tr>
<tr class="separator:ga4d4d3afa5b161c44155f40790d869e83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafddf34275dd9318f5f32ecdc8000417b"><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__Paint.html#gafddf34275dd9318f5f32ecdc8000417b">tvg_paint_scale</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float factor)</td></tr>
<tr class="memdesc:gafddf34275dd9318f5f32ecdc8000417b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scales the given Tvg_Paint object by the given factor. <a href="group__ThorVGCapi__Paint.html#gafddf34275dd9318f5f32ecdc8000417b">More...</a><br /></td></tr>
<tr class="separator:gafddf34275dd9318f5f32ecdc8000417b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac7bdf6ece56b99da5253a3484a6c5cb"><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__Paint.html#gaac7bdf6ece56b99da5253a3484a6c5cb">tvg_paint_rotate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float degree)</td></tr>
<tr class="memdesc:gaac7bdf6ece56b99da5253a3484a6c5cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates the given Tvg_Paint by the given angle. <a href="group__ThorVGCapi__Paint.html#gaac7bdf6ece56b99da5253a3484a6c5cb">More...</a><br /></td></tr>
<tr class="separator:gaac7bdf6ece56b99da5253a3484a6c5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18f9577abca1cee26f297b76a7bf2ff0"><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__Paint.html#ga18f9577abca1cee26f297b76a7bf2ff0">tvg_paint_translate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float x, float y)</td></tr>
<tr class="memdesc:ga18f9577abca1cee26f297b76a7bf2ff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the given Tvg_Paint in a two-dimensional space. <a href="group__ThorVGCapi__Paint.html#ga18f9577abca1cee26f297b76a7bf2ff0">More...</a><br /></td></tr>
<tr class="separator:ga18f9577abca1cee26f297b76a7bf2ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d6ccb84503d750540926dc6a408acd1"><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__Paint.html#ga2d6ccb84503d750540926dc6a408acd1">tvg_paint_set_transform</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:ga2d6ccb84503d750540926dc6a408acd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transforms the given Tvg_Paint using the augmented transformation matrix. <a href="group__ThorVGCapi__Paint.html#ga2d6ccb84503d750540926dc6a408acd1">More...</a><br /></td></tr>
<tr class="separator:ga2d6ccb84503d750540926dc6a408acd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac94393c4eae0115031990211cb499b71"><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__Paint.html#gac94393c4eae0115031990211cb499b71">tvg_paint_get_transform</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:gac94393c4eae0115031990211cb499b71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the matrix of the affine transformation of the given Tvg_Paint object. <a href="group__ThorVGCapi__Paint.html#gac94393c4eae0115031990211cb499b71">More...</a><br /></td></tr>
<tr class="separator:gac94393c4eae0115031990211cb499b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga605cab45412d5ef63d3f5917df3f8cc4"><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__Paint.html#ga605cab45412d5ef63d3f5917df3f8cc4">tvg_paint_set_opacity</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, uint8_t opacity)</td></tr>
<tr class="memdesc:ga605cab45412d5ef63d3f5917df3f8cc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the opacity of the given Tvg_Paint. <a href="group__ThorVGCapi__Paint.html#ga605cab45412d5ef63d3f5917df3f8cc4">More...</a><br /></td></tr>
<tr class="separator:ga605cab45412d5ef63d3f5917df3f8cc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55f53aa0bef3ef826c2be87b18c0e559"><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__Paint.html#ga55f53aa0bef3ef826c2be87b18c0e559">tvg_paint_get_opacity</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, uint8_t *opacity)</td></tr>
<tr class="memdesc:ga55f53aa0bef3ef826c2be87b18c0e559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the opacity of the given Tvg_Paint. <a href="group__ThorVGCapi__Paint.html#ga55f53aa0bef3ef826c2be87b18c0e559">More...</a><br /></td></tr>
<tr class="separator:ga55f53aa0bef3ef826c2be87b18c0e559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b1ce06f883dd5c3b5b926d1084f6b0f"><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__Paint.html#ga7b1ce06f883dd5c3b5b926d1084f6b0f">tvg_paint_duplicate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
<tr class="memdesc:ga7b1ce06f883dd5c3b5b926d1084f6b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the given Tvg_Paint object. <a href="group__ThorVGCapi__Paint.html#ga7b1ce06f883dd5c3b5b926d1084f6b0f">More...</a><br /></td></tr>
<tr class="separator:ga7b1ce06f883dd5c3b5b926d1084f6b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07b227466a584264e2a89f37c710b737"><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__Paint.html#ga07b227466a584264e2a89f37c710b737">tvg_paint_get_bounds</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float *x, float *y, float *w, float *h, bool transformed)</td></tr>
<tr class="memdesc:ga07b227466a584264e2a89f37c710b737"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the axis-aligned bounding box of the Tvg_Paint object. <a href="group__ThorVGCapi__Paint.html#ga07b227466a584264e2a89f37c710b737">More...</a><br /></td></tr>
<tr class="separator:ga07b227466a584264e2a89f37c710b737"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga484f01c2fe271602fdab3219207ccfb2"><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__Paint.html#ga484f01c2fe271602fdab3219207ccfb2">tvg_paint_set_composite_method</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *target, <a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> method)</td></tr>
<tr class="memdesc:ga484f01c2fe271602fdab3219207ccfb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the composition target object and the composition method. <a href="group__ThorVGCapi__Paint.html#ga484f01c2fe271602fdab3219207ccfb2">More...</a><br /></td></tr>
<tr class="separator:ga484f01c2fe271602fdab3219207ccfb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga49588e675af84f5722686249ece91245"><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__Paint.html#ga49588e675af84f5722686249ece91245">tvg_paint_get_composite_method</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> **target, <a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> *method)</td></tr>
<tr class="memdesc:ga49588e675af84f5722686249ece91245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the composition target object and the composition method. <a href="group__ThorVGCapi__Paint.html#ga49588e675af84f5722686249ece91245">More...</a><br /></td></tr>
<tr class="separator:ga49588e675af84f5722686249ece91245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b914e27aba456a6dbb7811506e6d70d"><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__Paint.html#ga7b914e27aba456a6dbb7811506e6d70d">tvg_paint_get_identifier</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, <a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a> *identifier)</td></tr>
<tr class="memdesc:ga7b914e27aba456a6dbb7811506e6d70d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the unique id value of the paint instance indicating the instance type. <a href="group__ThorVGCapi__Paint.html#ga7b914e27aba456a6dbb7811506e6d70d">More...</a><br /></td></tr>
<tr class="separator:ga7b914e27aba456a6dbb7811506e6d70d"><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 managing graphical elements. It enables duplication, transformation and composition. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga1ec9193ca6959f9d91a80cc61cd0df3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1ec9193ca6959f9d91a80cc61cd0df3a">&#9670;&nbsp;</a></span>Tvg_Composite_Method</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration indicating the method used in the composition of two objects - the target and the source. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aa9122090fc6c074e22fa0964effa1b375"></a>TVG_COMPOSITE_METHOD_NONE&#160;</td><td class="fielddoc"><p>No composition is applied. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aa517f996a4e50e88727607b959ce52852"></a>TVG_COMPOSITE_METHOD_CLIP_PATH&#160;</td><td class="fielddoc"><p>The intersection of the source and the target is determined and only the resulting pixels from the source are rendered. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aae536c237d654d73f306f2d346fc3c86a"></a>TVG_COMPOSITE_METHOD_ALPHA_MASK&#160;</td><td class="fielddoc"><p>The pixels of the source and the target are alpha blended. As a result, only the part of the source, which intersects with the target is visible. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aaf5b9626da41b4a50070f97139062c759"></a>TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK&#160;</td><td class="fielddoc"><p>The pixels of the source and the complement to the target's pixels are alpha blended. As a result, only the part of the source which is not covered by the target is visible. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aa0780ffcaadd9a4396a8c2342a05f2d79"></a>TVG_COMPOSITE_METHOD_LUMA_MASK&#160;</td><td class="fielddoc"><p>The source pixels are converted to grayscale (luma value) and alpha blended with the target. As a result, only the part of the source which intersects with the target is visible. </p>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</td></tr>
</table>
</div>
</div>
<a id="ga906459e9a724fa6d89d18c5dedeb619f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga906459e9a724fa6d89d18c5dedeb619f">&#9670;&nbsp;</a></span>Tvg_Identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration indicating the ThorVG class type. </p>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa4835d63e75912ad680a068f82616e311"></a>TVG_IDENTIFIER_UNDEF&#160;</td><td class="fielddoc"><p>Undefined type. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa105de16ee2517a216f2bc7ed6a5e7b69"></a>TVG_IDENTIFIER_SHAPE&#160;</td><td class="fielddoc"><p>A shape type paint. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa77977fb5cff9194b55ecb96492fe8f3e"></a>TVG_IDENTIFIER_SCENE&#160;</td><td class="fielddoc"><p>A scene type paint. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa3ddbd748d2bf2936b6151ba50879a1e8"></a>TVG_IDENTIFIER_PICTURE&#160;</td><td class="fielddoc"><p>A picture type paint. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa933f17c80ac7b0c474965a2175b19293"></a>TVG_IDENTIFIER_LINEAR_GRAD&#160;</td><td class="fielddoc"><p>A linear gradient type. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga906459e9a724fa6d89d18c5dedeb619fa73a9ed807395d0f3ac0d7218a37c225f"></a>TVG_IDENTIFIER_RADIAL_GRAD&#160;</td><td class="fielddoc"><p>A radial gradient type. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga4d4d3afa5b161c44155f40790d869e83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d4d3afa5b161c44155f40790d869e83">&#9670;&nbsp;</a></span>tvg_paint_del()</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_paint_del </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the given Tvg_Paint object. </p>
<div class="fragment"><div class="line"><span class="comment">//example of cleanup function</span></div>
<div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *rect = NULL; <span class="comment">//rectangle shape added in other function</span></div>
<div class="line"> </div>
<div class="line"><span class="comment">//rectangle delete API</span></div>
<div class="line"><span class="keywordtype">int</span> rectangle_delete(<span class="keywordtype">void</span>) {</div>
<div class="line"> <span class="keywordflow">if</span> (rect) <a class="code" href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">tvg_paint_del</a>(rect);</div>
<div class="line"> rect = NULL;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> cleanup(<span class="keywordtype">void</span>) {</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032">tvg_canvas_clear</a>(canvas, <span class="keyword">false</span>);</div>
<div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a>(canvas);</div>
<div class="line"> canvas = NULL;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_ga15208125646162cd19a928708a335295"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_destroy(Tvg_Canvas *canvas)</div><div class="ttdoc">Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_gaca4447f647446c29b90cc443aa84f032"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032">tvg_canvas_clear</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_clear(Tvg_Canvas *canvas, bool free)</div><div class="ttdoc">Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Paint_html_ga4d4d3afa5b161c44155f40790d869e83"><div class="ttname"><a href="group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83">tvg_paint_del</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_paint_del(Tvg_Paint *paint)</div><div class="ttdoc">Releases the given Tvg_Paint object.</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga98af7c3fe18afa8ad65ea6a6e097a292"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></div><div class="ttdeci">struct _Tvg_Paint Tvg_Paint</div><div class="ttdoc">A structure representing a graphical element.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:85</div></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be released.</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>
<dl class="section warning"><dt>Warning</dt><dd>If this function is used, <a class="el" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a> with the <code>free</code> argument value set to <code>false</code> should be used in order to avoid unexpected behaviours.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#gaca4447f647446c29b90cc443aa84f032" title="Sets the total number of the paints pushed into the canvas to be zero. Tvg_Paint objects stored in th...">tvg_canvas_clear()</a>, <a class="el" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295" title="Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...">tvg_canvas_destroy()</a> </dd></dl>
</div>
</div>
<a id="ga7b1ce06f883dd5c3b5b926d1084f6b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b1ce06f883dd5c3b5b926d1084f6b0f">&#9670;&nbsp;</a></span>tvg_paint_duplicate()</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_paint_duplicate </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Duplicates the given Tvg_Paint object. </p>
<p>Creates a new object and sets its all properties as in the original object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be copied.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A copied Tvg_Paint object if succeed, <code>nullptr</code> otherwise. </dd></dl>
</div>
</div>
<a id="ga07b227466a584264e2a89f37c710b737"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga07b227466a584264e2a89f37c710b737">&#9670;&nbsp;</a></span>tvg_paint_get_bounds()</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_paint_get_bounds </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>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>y</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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>transformed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the axis-aligned bounding box of the Tvg_Paint object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">x</td><td>The x coordinate of the upper left corner of the object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">y</td><td>The y coordinate of the upper left corner of the object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">w</td><td>The width of the object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">h</td><td>The height of the object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">transformed</td><td>If <code>true</code>, the transformation of the paint is taken into account, otherwise it isn't.</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>Other errors.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The bounding box doesn't indicate the actual drawing region. It's the smallest rectangle that encloses the object. </dd></dl>
</div>
</div>
<a id="ga49588e675af84f5722686249ece91245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49588e675af84f5722686249ece91245">&#9670;&nbsp;</a></span>tvg_paint_get_composite_method()</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_paint_get_composite_method </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">const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> **&#160;</td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> *&#160;</td>
<td class="paramname"><em>method</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the composition target object and the composition method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The source object of the composition. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">target</td><td>The target object of the composition. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">method</td><td>The method used to composite the source object with the target.</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> is passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga7b914e27aba456a6dbb7811506e6d70d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b914e27aba456a6dbb7811506e6d70d">&#9670;&nbsp;</a></span>tvg_paint_get_identifier()</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_paint_get_identifier </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"><a class="el" href="group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f">Tvg_Identifier</a> *&#160;</td>
<td class="paramname"><em>identifier</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the unique id value of the paint instance indicating the instance type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the identifier value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">identifier</td><td>The unique identifier of the paint instance type.</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.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</div>
</div>
<a id="ga55f53aa0bef3ef826c2be87b18c0e559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga55f53aa0bef3ef826c2be87b18c0e559">&#9670;&nbsp;</a></span>tvg_paint_get_opacity()</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_paint_get_opacity </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">uint8_t *&#160;</td>
<td class="paramname"><em>opacity</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the opacity of the given Tvg_Paint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the opacity value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">opacity</td><td>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.</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. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac94393c4eae0115031990211cb499b71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac94393c4eae0115031990211cb499b71">&#9670;&nbsp;</a></span>tvg_paint_get_transform()</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_paint_get_transform </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"><a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the matrix of the affine transformation of the given Tvg_Paint object. </p>
<p>In case no transformation was applied, the identity matrix is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the transformation matrix. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</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> is passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaac7bdf6ece56b99da5253a3484a6c5cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac7bdf6ece56b99da5253a3484a6c5cb">&#9670;&nbsp;</a></span>tvg_paint_rotate()</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_paint_rotate </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>degree</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotates the given Tvg_Paint by the given angle. </p>
<p>The angle in measured clockwise from the horizontal axis. The rotational axis passes through the point on the object with zero coordinates.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be rotated. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">degree</td><td>The value of the rotation angle in degrees.</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_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafddf34275dd9318f5f32ecdc8000417b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafddf34275dd9318f5f32ecdc8000417b">&#9670;&nbsp;</a></span>tvg_paint_scale()</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_paint_scale </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>factor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scales the given Tvg_Paint object by the given factor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be scaled. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">factor</td><td>The value of the scaling factor. The default value is 1.</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_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga484f01c2fe271602fdab3219207ccfb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga484f01c2fe271602fdab3219207ccfb2">&#9670;&nbsp;</a></span>tvg_paint_set_composite_method()</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_paint_set_composite_method </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"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *&#160;</td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a>&#160;</td>
<td class="paramname"><em>method</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the composition target object and the composition method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The source object of the composition. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>The target object of the composition. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">method</td><td>The method used to composite the source object with the target.</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 <code>paint</code> or <code>target</code> object or the <code>method</code> equal to TVG_COMPOSITE_METHOD_NONE. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga605cab45412d5ef63d3f5917df3f8cc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga605cab45412d5ef63d3f5917df3f8cc4">&#9670;&nbsp;</a></span>tvg_paint_set_opacity()</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_paint_set_opacity </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">uint8_t&#160;</td>
<td class="paramname"><em>opacity</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the opacity of the given Tvg_Paint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which the opacity value is to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">opacity</td><td>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.</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>
<dl class="section note"><dt>Note</dt><dd>Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible. </dd></dl>
</div>
</div>
<a id="ga2d6ccb84503d750540926dc6a408acd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d6ccb84503d750540926dc6a408acd1">&#9670;&nbsp;</a></span>tvg_paint_set_transform()</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_paint_set_transform </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 <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms the given Tvg_Paint using the augmented transformation matrix. </p>
<p>The augmented matrix of the transformation is expected to be given.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be transformed. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</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> is passed as the argument. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga18f9577abca1cee26f297b76a7bf2ff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18f9577abca1cee26f297b76a7bf2ff0">&#9670;&nbsp;</a></span>tvg_paint_translate()</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_paint_translate </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>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves the given Tvg_Paint in a two-dimensional space. </p>
<p>The origin of the coordinate system is in the upper left corner of the canvas. The horizontal and vertical axes point to the right and down, respectively.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be shifted. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The value of the horizontal shift. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The value of the vertical shift.</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_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </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>

View file

@ -1,31 +0,0 @@
var group__ThorVGCapi__Paint =
[
[ "Tvg_Composite_Method", "group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a", [
[ "TVG_COMPOSITE_METHOD_NONE", "group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa9122090fc6c074e22fa0964effa1b375", null ],
[ "TVG_COMPOSITE_METHOD_CLIP_PATH", "group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa517f996a4e50e88727607b959ce52852", null ],
[ "TVG_COMPOSITE_METHOD_ALPHA_MASK", "group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aae536c237d654d73f306f2d346fc3c86a", null ],
[ "TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK", "group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aaf5b9626da41b4a50070f97139062c759", null ],
[ "TVG_COMPOSITE_METHOD_LUMA_MASK", "group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa0780ffcaadd9a4396a8c2342a05f2d79", null ]
] ],
[ "Tvg_Identifier", "group__ThorVGCapi__Paint.html#ga906459e9a724fa6d89d18c5dedeb619f", [
[ "TVG_IDENTIFIER_UNDEF", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa4835d63e75912ad680a068f82616e311", null ],
[ "TVG_IDENTIFIER_SHAPE", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa105de16ee2517a216f2bc7ed6a5e7b69", null ],
[ "TVG_IDENTIFIER_SCENE", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa77977fb5cff9194b55ecb96492fe8f3e", null ],
[ "TVG_IDENTIFIER_PICTURE", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa3ddbd748d2bf2936b6151ba50879a1e8", null ],
[ "TVG_IDENTIFIER_LINEAR_GRAD", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa933f17c80ac7b0c474965a2175b19293", null ],
[ "TVG_IDENTIFIER_RADIAL_GRAD", "group__ThorVGCapi__Paint.html#gga906459e9a724fa6d89d18c5dedeb619fa73a9ed807395d0f3ac0d7218a37c225f", null ]
] ],
[ "tvg_paint_del", "group__ThorVGCapi__Paint.html#ga4d4d3afa5b161c44155f40790d869e83", null ],
[ "tvg_paint_duplicate", "group__ThorVGCapi__Paint.html#ga7b1ce06f883dd5c3b5b926d1084f6b0f", null ],
[ "tvg_paint_get_bounds", "group__ThorVGCapi__Paint.html#ga07b227466a584264e2a89f37c710b737", null ],
[ "tvg_paint_get_composite_method", "group__ThorVGCapi__Paint.html#ga49588e675af84f5722686249ece91245", null ],
[ "tvg_paint_get_identifier", "group__ThorVGCapi__Paint.html#ga7b914e27aba456a6dbb7811506e6d70d", null ],
[ "tvg_paint_get_opacity", "group__ThorVGCapi__Paint.html#ga55f53aa0bef3ef826c2be87b18c0e559", null ],
[ "tvg_paint_get_transform", "group__ThorVGCapi__Paint.html#gac94393c4eae0115031990211cb499b71", null ],
[ "tvg_paint_rotate", "group__ThorVGCapi__Paint.html#gaac7bdf6ece56b99da5253a3484a6c5cb", null ],
[ "tvg_paint_scale", "group__ThorVGCapi__Paint.html#gafddf34275dd9318f5f32ecdc8000417b", null ],
[ "tvg_paint_set_composite_method", "group__ThorVGCapi__Paint.html#ga484f01c2fe271602fdab3219207ccfb2", null ],
[ "tvg_paint_set_opacity", "group__ThorVGCapi__Paint.html#ga605cab45412d5ef63d3f5917df3f8cc4", null ],
[ "tvg_paint_set_transform", "group__ThorVGCapi__Paint.html#ga2d6ccb84503d750540926dc6a408acd1", null ],
[ "tvg_paint_translate", "group__ThorVGCapi__Paint.html#ga18f9577abca1cee26f297b76a7bf2ff0", null ]
];

View file

@ -1,4 +0,0 @@
<map id="Paint" name="Paint">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" title="A module for managing graphical elements. It enables duplication, transformation and composition." alt="" coords="160,5,215,31"/>
</map>

View file

@ -1 +0,0 @@
d092f8ef507280d8786e14a192d9463a

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

View file

@ -1,439 +0,0 @@
<!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>

View file

@ -1,9 +0,0 @@
var group__ThorVGCapi__Picture =
[
[ "tvg_picture_get_size", "group__ThorVGCapi__Picture.html#gae3cb3080c20e0f8f564fe96fa0eecf99", null ],
[ "tvg_picture_load", "group__ThorVGCapi__Picture.html#ga7ddef61976baa7575ac5c5f69286eae6", null ],
[ "tvg_picture_load_data", "group__ThorVGCapi__Picture.html#ga23f114ec390b62e7057af05c084605f7", null ],
[ "tvg_picture_load_raw", "group__ThorVGCapi__Picture.html#gae8e02c89758ef1d31adf414ed33c0485", null ],
[ "tvg_picture_new", "group__ThorVGCapi__Picture.html#gaf90992d1e0e0a2db14e693d038ac732d", null ],
[ "tvg_picture_set_size", "group__ThorVGCapi__Picture.html#gafcc895de0a4040d15824d788d9b23d98", null ]
];

View file

@ -1,4 +0,0 @@
<map id="Picture" name="Picture">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" 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>

View file

@ -1 +0,0 @@
f09123103b2bf98dfd86cfeed319f431

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

View file

@ -1,291 +0,0 @@
<!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: 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="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__Saver.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">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="#agroup____ThorVGCapi____Saver" alt=""/></div>
<map name="agroup____ThorVGCapi____Saver" id="agroup____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:gaf05776a1d634de3c42c46834349acf3c"><td class="memItemLeft" align="right" valign="top">TVG_API <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#gaf05776a1d634de3c42c46834349acf3c">tvg_saver_new</a> ()</td></tr>
<tr class="memdesc:gaf05776a1d634de3c42c46834349acf3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new Tvg_Saver object. <a href="group__ThorVGCapi__Saver.html#gaf05776a1d634de3c42c46834349acf3c">More...</a><br /></td></tr>
<tr class="separator:gaf05776a1d634de3c42c46834349acf3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga644ed42cae989135ed5728d2f207040e"><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__Saver.html#ga644ed42cae989135ed5728d2f207040e">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:ga644ed42cae989135ed5728d2f207040e"><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#ga644ed42cae989135ed5728d2f207040e">More...</a><br /></td></tr>
<tr class="separator:ga644ed42cae989135ed5728d2f207040e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga618fd46958594c06ff03337a5decbc19"><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__Saver.html#ga618fd46958594c06ff03337a5decbc19">tvg_saver_sync</a> (<a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *saver)</td></tr>
<tr class="memdesc:ga618fd46958594c06ff03337a5decbc19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Guarantees that the saving task is finished. <a href="group__ThorVGCapi__Saver.html#ga618fd46958594c06ff03337a5decbc19">More...</a><br /></td></tr>
<tr class="separator:ga618fd46958594c06ff03337a5decbc19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa48e65602ecf4fd8a237be73d964a2c9"><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__Saver.html#gaa48e65602ecf4fd8a237be73d964a2c9">tvg_saver_del</a> (<a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a> *saver)</td></tr>
<tr class="memdesc:gaa48e65602ecf4fd8a237be73d964a2c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the given Tvg_Saver object. <a href="group__ThorVGCapi__Saver.html#gaa48e65602ecf4fd8a237be73d964a2c9">More...</a><br /></td></tr>
<tr class="separator:gaa48e65602ecf4fd8a237be73d964a2c9"><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="gaa48e65602ecf4fd8a237be73d964a2c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa48e65602ecf4fd8a237be73d964a2c9">&#9670;&nbsp;</a></span>tvg_saver_del()</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_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="gaf05776a1d634de3c42c46834349acf3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf05776a1d634de3c42c46834349acf3c">&#9670;&nbsp;</a></span>tvg_saver_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#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="ga644ed42cae989135ed5728d2f207040e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga644ed42cae989135ed5728d2f207040e">&#9670;&nbsp;</a></span>tvg_saver_save()</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_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#ga618fd46958594c06ff03337a5decbc19" 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#ga618fd46958594c06ff03337a5decbc19" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> </dd></dl>
</div>
</div>
<a id="ga618fd46958594c06ff03337a5decbc19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga618fd46958594c06ff03337a5decbc19">&#9670;&nbsp;</a></span>tvg_saver_sync()</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_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#ga618fd46958594c06ff03337a5decbc19" title="Guarantees that the saving task is finished.">tvg_saver_sync()</a> after the <a class="el" href="group__ThorVGCapi__Saver.html#ga644ed42cae989135ed5728d2f207040e" 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#ga618fd46958594c06ff03337a5decbc19" 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#ga644ed42cae989135ed5728d2f207040e" title="Exports the given paint data to the given path.">tvg_saver_save()</a> </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>

View file

@ -1,7 +0,0 @@
var group__ThorVGCapi__Saver =
[
[ "tvg_saver_del", "group__ThorVGCapi__Saver.html#gaa48e65602ecf4fd8a237be73d964a2c9", null ],
[ "tvg_saver_new", "group__ThorVGCapi__Saver.html#gaf05776a1d634de3c42c46834349acf3c", null ],
[ "tvg_saver_save", "group__ThorVGCapi__Saver.html#ga644ed42cae989135ed5728d2f207040e", null ],
[ "tvg_saver_sync", "group__ThorVGCapi__Saver.html#ga618fd46958594c06ff03337a5decbc19", null ]
];

View file

@ -1,4 +0,0 @@
<map id="Saver" name="Saver">
<area shape="rect" id="node1" href="$group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" id="node2" title="A module for exporting a paint object into a specified file." alt="" coords="160,5,219,31"/>
</map>

View file

@ -1 +0,0 @@
30a05053b021da4601ed8cb15d65431f

Some files were not shown because too many files have changed in this diff Show more