From f85a9eb136dba5f1bd16f35c7fcbea6b2ebb8da3 Mon Sep 17 00:00:00 2001 From: Hermet Park Date: Tue, 2 Nov 2021 20:59:20 +0900 Subject: [PATCH] doc: up to date v0.6.0 --- docs/Doxyfile | 4 +- docs/html/annotated.html | 4 +- docs/html/classes.html | 2 +- docs/html/classtvg_1_1Canvas-members.html | 2 +- docs/html/classtvg_1_1Canvas.html | 12 +- docs/html/classtvg_1_1Fill-members.html | 9 +- docs/html/classtvg_1_1Fill.html | 115 ++- docs/html/classtvg_1_1GlCanvas-members.html | 2 +- docs/html/classtvg_1_1GlCanvas.html | 13 +- .../html/classtvg_1_1Initializer-members.html | 2 +- docs/html/classtvg_1_1Initializer.html | 2 +- .../classtvg_1_1LinearGradient-members.html | 6 +- docs/html/classtvg_1_1LinearGradient.html | 56 +- docs/html/classtvg_1_1Paint-members.html | 17 +- docs/html/classtvg_1_1Paint.html | 40 +- .../classtvg_1_1Paint__inherit__graph.map | 2 +- .../classtvg_1_1Paint__inherit__graph.md5 | 2 +- docs/html/classtvg_1_1Picture-members.html | 4 +- docs/html/classtvg_1_1Picture.html | 73 +- .../classtvg_1_1Picture__inherit__graph.map | 2 +- .../classtvg_1_1Picture__inherit__graph.md5 | 2 +- .../classtvg_1_1RadialGradient-members.html | 6 +- docs/html/classtvg_1_1RadialGradient.html | 55 +- docs/html/classtvg_1_1Saver-members.html | 2 +- docs/html/classtvg_1_1Saver.html | 34 +- docs/html/classtvg_1_1Scene-members.html | 4 +- docs/html/classtvg_1_1Scene.html | 55 +- docs/html/classtvg_1_1Shape-members.html | 4 +- docs/html/classtvg_1_1Shape.html | 55 +- docs/html/classtvg_1_1SwCanvas-members.html | 6 +- docs/html/classtvg_1_1SwCanvas.html | 29 +- .../dir_bfccd401955b95cf8c75461437045ac0.html | 2 +- docs/html/functions.html | 20 +- docs/html/functions_enum.html | 2 +- docs/html/functions_eval.html | 8 +- docs/html/functions_func.html | 14 +- docs/html/functions_vars.html | 2 +- docs/html/graph_legend.html | 2 +- docs/html/group__ThorVG.html | 4 +- docs/html/hierarchy.html | 4 +- docs/html/index.html | 2 +- docs/html/inherit_graph_5.map | 2 +- docs/html/inherit_graph_5.md5 | 2 +- docs/html/inherits.html | 4 +- docs/html/modules.html | 2 +- docs/html/search/all_0.js | 14 +- docs/html/search/all_1.js | 8 +- docs/html/search/all_10.js | 4 +- docs/html/search/all_11.js | 2 +- docs/html/search/all_12.js | 2 +- docs/html/search/all_2.js | 22 +- docs/html/search/all_3.js | 8 +- docs/html/search/all_4.js | 2 +- docs/html/search/all_5.js | 10 +- docs/html/search/all_6.js | 8 +- docs/html/search/all_7.js | 13 +- docs/html/search/all_8.js | 8 +- docs/html/search/all_9.js | 12 +- docs/html/search/all_a.js | 4 +- docs/html/search/all_b.js | 4 +- docs/html/search/all_c.js | 16 +- docs/html/search/all_d.js | 20 +- docs/html/search/all_e.js | 40 +- docs/html/search/all_f.js | 12 +- docs/html/search/classes_0.js | 4 +- docs/html/search/classes_1.js | 2 +- docs/html/search/classes_2.js | 2 +- docs/html/search/classes_3.js | 2 +- docs/html/search/classes_4.js | 2 +- docs/html/search/classes_5.js | 2 +- docs/html/search/classes_6.js | 6 +- docs/html/search/classes_7.js | 2 +- docs/html/search/classes_8.js | 8 +- docs/html/search/enums_0.js | 6 +- docs/html/search/enums_1.js | 4 +- docs/html/search/enums_2.js | 2 +- docs/html/search/enums_3.js | 2 +- docs/html/search/enums_4.js | 2 +- docs/html/search/enums_5.js | 4 +- docs/html/search/enumvalues_0.js | 8 +- docs/html/search/enumvalues_1.js | 4 +- docs/html/search/enumvalues_2.js | 6 +- docs/html/search/enumvalues_3.js | 2 +- docs/html/search/enumvalues_4.js | 2 +- docs/html/search/enumvalues_5.js | 2 +- docs/html/search/enumvalues_6.js | 2 +- docs/html/search/enumvalues_7.js | 8 +- docs/html/search/enumvalues_8.js | 2 +- docs/html/search/enumvalues_9.js | 6 +- docs/html/search/enumvalues_a.js | 4 +- docs/html/search/enumvalues_b.js | 2 +- docs/html/search/enumvalues_c.js | 6 +- docs/html/search/enumvalues_d.js | 8 +- docs/html/search/enumvalues_e.js | 2 +- docs/html/search/enumvalues_f.js | 2 +- docs/html/search/functions_0.js | 8 +- docs/html/search/functions_1.js | 2 +- docs/html/search/functions_2.js | 10 +- docs/html/search/functions_3.js | 6 +- docs/html/search/functions_4.js | 6 +- docs/html/search/functions_5.js | 2 +- docs/html/search/functions_6.js | 3 +- docs/html/search/functions_7.js | 6 +- docs/html/search/functions_8.js | 4 +- docs/html/search/functions_9.js | 2 +- docs/html/search/functions_a.js | 6 +- docs/html/search/functions_b.js | 8 +- docs/html/search/functions_c.js | 24 +- docs/html/search/functions_d.js | 8 +- docs/html/search/functions_e.js | 2 +- docs/html/search/functions_f.js | 2 +- docs/html/search/groups_0.js | 2 +- docs/html/search/pages_0.js | 2 +- docs/html/search/variables_0.js | 2 +- docs/html/search/variables_1.js | 2 +- docs/html/search/variables_2.js | 2 +- docs/html/search/variables_3.js | 2 +- docs/html/search/variables_4.js | 2 +- docs/html/small_logo.svg | 2 +- ...tructtvg_1_1Fill_1_1ColorStop-members.html | 2 +- docs/html/structtvg_1_1Fill_1_1ColorStop.html | 2 +- docs/html/structtvg_1_1Matrix-members.html | 2 +- docs/html/structtvg_1_1Matrix.html | 2 +- docs/html/structtvg_1_1Point-members.html | 2 +- docs/html/structtvg_1_1Point.html | 2 +- docs/html/thorvg_8h_source.html | 837 +++++++++--------- 126 files changed, 1234 insertions(+), 746 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 02a3f664..9f2892a5 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = ThorVG # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = v0.5 +PROJECT_NUMBER = v0.6 # 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 @@ -51,7 +51,7 @@ PROJECT_BRIEF = # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = small_logo.svg +PROJECT_LOGO = /home/hermet/Projects/thorvg/docs/small_logo.svg # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/docs/html/annotated.html b/docs/html/annotated.html index f0f40097..882c6344 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -24,7 +24,7 @@ Logo
ThorVG -  v0.5 +  v0.6
@@ -79,7 +79,7 @@ $(function() {  CLinearGradientA class representing the linear gradient fill of the Shape object  CMatrixA data structure representing a three-dimensional matrix  CPaintAn abstract class for managing graphical elements - CPictureA class representing an image read in one of the supported formats: raw, svg, png and etc. Besides the methods inherited from the Paint, it provides methods to load & draw images on the canvas + CPictureA class representing an image read in one of the supported formats: raw, svg, png, jpg and etc. Besides the methods inherited from the Paint, it provides methods to load & draw images on the canvas  CPointA data structure representing a point in two-dimensional space  CRadialGradientA class representing the radial gradient fill of the Shape object  CSaverA class for exporting a paint object into a specified file, from which to recover the paint data later diff --git a/docs/html/classes.html b/docs/html/classes.html index 210e5534..9587c321 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -24,7 +24,7 @@ Logo
ThorVG -  v0.5 +  v0.6
diff --git a/docs/html/classtvg_1_1Canvas-members.html b/docs/html/classtvg_1_1Canvas-members.html index 7d453c01..25459dc4 100644 --- a/docs/html/classtvg_1_1Canvas-members.html +++ b/docs/html/classtvg_1_1Canvas-members.html @@ -24,7 +24,7 @@ Logo
ThorVG -  v0.5 +  v0.6
diff --git a/docs/html/classtvg_1_1Canvas.html b/docs/html/classtvg_1_1Canvas.html index 0c521fc8..81f68c60 100644 --- a/docs/html/classtvg_1_1Canvas.html +++ b/docs/html/classtvg_1_1Canvas.html @@ -24,7 +24,7 @@ Logo
ThorVG -  v0.5 +  v0.6
@@ -104,7 +104,7 @@ Public Member Functions  Request the canvas to update the paint objects. More...
  virtual Result draw () noexcept - Request the canvas to draw the Paint objects. More...
+ Requests the canvas to draw the Paint objects. More...
  virtual Result sync () noexcept  Guarantees that drawing task is finished. More...
@@ -175,7 +175,7 @@ Public Member Functions
-

Request the canvas to draw the Paint objects.

+

Requests the canvas to draw the Paint objects.

Returns
Result::Success when succeed, Result::InsufficientCondition otherwise.
Note
Drawing can be asynchronous if the assigned thread number is greater than zero. To guarantee the drawing is done, call sync() afterwards.
See also
Canvas::sync()
@@ -207,7 +207,7 @@ Public Member Functions

Passes drawing elements to the Canvas using Paint objects.

-

Only pushed paints in the canvas will be drawing targets. They are retained by the canvas until you call Canvas::clear(). If you know the number of the pushed objects in the advance, please call Canvas::reserve().

+

Only pushed paints in the canvas will be drawing targets. They are retained by the canvas until you call Canvas::clear(). If you know the number of the pushed objects in advance, please call Canvas::reserve().

Parameters
@@ -289,9 +289,9 @@ Public Member Functions

Guarantees that drawing task is finished.

-

The Canvas rendering can be performed asynchronously. To make sure that rendering is finished, the sync() must be called after the draw() regardless of threading.

+

The Canvas rendering can be performed asynchronously. To make sure that rendering is finished, the sync() must be called after the draw() regardless of threading.

Returns
Result::Success when succeed, Result::InsufficientCondition otherwise.
-
See also
Canvas::draw()
+
See also
Canvas::draw()
diff --git a/docs/html/classtvg_1_1Fill-members.html b/docs/html/classtvg_1_1Fill-members.html index d2c10e07..7a2ada75 100644 --- a/docs/html/classtvg_1_1Fill-members.html +++ b/docs/html/classtvg_1_1Fill-members.html @@ -24,7 +24,7 @@ @@ -78,8 +78,11 @@ $(function() { - - + + + + +
[in]paintA Paint object to be drawn.
ThorVG -  v0.5 +  v0.6
colorStops(const ColorStop *colorStops, uint32_t cnt) noexceptFill
colorStops(const ColorStop **colorStops) const noexceptFill
duplicate() const noexceptFill
spread(FillSpread s) noexceptFill
spread() const noexceptFill
identifier() constFillinline
spread(FillSpread s) noexceptFill
spread() const noexceptFill
transform(const Matrix &m) noexceptFill
transform() const noexceptFill