Request the canvas to draw the Paint objects.
+Requests the canvas to draw the Paint objects.
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().
| [in] | paint | A Paint object to be drawn. | |
ThorVG
- v0.5
+ v0.6
|
@@ -78,8 +78,11 @@ $(function() {
| colorStops(const ColorStop *colorStops, uint32_t cnt) noexcept | Fill | |
| colorStops(const ColorStop **colorStops) const noexcept | Fill | |
| duplicate() const noexcept | Fill | |
| spread(FillSpread s) noexcept | Fill | |
| spread() const noexcept | Fill | |
| identifier() const | Fill | inline |
| spread(FillSpread s) noexcept | Fill | |
| spread() const noexcept | Fill | |
| transform(const Matrix &m) noexcept | Fill | |
| transform() const noexcept | Fill |
An abstract class representing the gradient fill of the Shape object.
@@ -145,7 +154,7 @@ Public Member FunctionsGets the parameters of the colors of the gradient, their position and number.
| [in] | colorStops | A pointer to the memory location, where the array of the gradient's ColorStop is stored. |
| [out] | colorStops | A pointer to the memory location, where the array of the gradient's ColorStop is stored. |
Return a newly created Fill object with the properties copied from the original.
nullptr otherwise.
+
|
+ +inline | +
+
|
+ +noexcept | +
Gets the matrix of the affine transformation of the gradient fill.
+In case no transformation was applied, the identity matrix is returned.
+| The | augmented transformation matrix. |
@BETA_API
+ +Sets the matrix of the affine transformation for the gradient fill.
+The augmented matrix of the transformation is expected to be given.
+| [in] | m | The 3x3 augmented matrix. |
@BETA_API
+
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... | |
ThorVG
- v0.5
+ v0.6
|
diff --git a/docs/html/classtvg_1_1Initializer.html b/docs/html/classtvg_1_1Initializer.html
index d99d4181..2cfb790a 100644
--- a/docs/html/classtvg_1_1Initializer.html
+++ b/docs/html/classtvg_1_1Initializer.html
@@ -24,7 +24,7 @@
|
ThorVG
- v0.5
+ v0.6
|
diff --git a/docs/html/classtvg_1_1LinearGradient-members.html b/docs/html/classtvg_1_1LinearGradient-members.html
index 63a18f6d..3fa70180 100644
--- a/docs/html/classtvg_1_1LinearGradient-members.html
+++ b/docs/html/classtvg_1_1LinearGradient-members.html
@@ -24,7 +24,7 @@
|
ThorVG
- v0.5
+ v0.6
|
@@ -79,10 +79,14 @@ $(function() {
| colorStops(const ColorStop **colorStops) const noexcept | Fill | |
| duplicate() const noexcept | Fill | |
| gen() noexcept | LinearGradient | static |
| identifier() noexcept | LinearGradient | static |
| tvg::Fill::identifier() const | Fill | inline |
| linear(float x1, float y1, float x2, float y2) noexcept | LinearGradient | |
| linear(float *x1, float *y1, float *x2, float *y2) const noexcept | LinearGradient | |
| spread(FillSpread s) noexcept | Fill | |
| spread() const noexcept | Fill | |
| transform(const Matrix &m) noexcept | Fill | |
| transform() const noexcept | Fill | |
Public Member Functions | |
| Result | spread (FillSpread s) noexcept |
| Sets the FillSpread value, which specifies how to fill the area outside the gradient bounds. More... | |
| Result | transform (const Matrix &m) noexcept |
| Sets the matrix of the affine transformation for the gradient fill. More... | |
| uint32_t | colorStops (const ColorStop **colorStops) const noexcept |
| Gets the parameters of the colors of the gradient, their position and number. More... | |
| FillSpread | spread () const noexcept |
| Gets the FillSpread value of the fill. More... | |
| Matrix | transform () const noexcept |
| Gets the matrix of the affine transformation of the gradient fill. More... | |
| Fill * | duplicate () const noexcept |
| Creates a copy of the Fill object. More... | |
| uint32_t | identifier () const |
| Return the unique id value of the Fill instance. More... | |
Static Public Member Functions | |
| static std::unique_ptr< LinearGradient > | gen () noexcept |
| Creates a new LinearGradient object. More... | |
| static uint32_t | identifier () noexcept |
| Return the unique id value of this class. More... | |
A class representing the linear gradient fill of the Shape object.
@@ -150,6 +171,36 @@ Static Public Member FunctionsCreates a new LinearGradient object.
+
|
+ +staticnoexcept | +
Return the unique id value of this class.
+This method can be referred for identifying the LinearGradient class type.
+@BETA_API
+
An abstract class for managing graphical elements.
@@ -248,13 +251,14 @@ Public Member FunctionsGets the axis-aligned bounding box of the paint object.
+In case transform is true, all object's transformations are applied first, and then the bounding box is established. Otherwise, the bounding box is determined before any transformations.
| [out] | x | The x coordinate of the upper left corner of the object. |
| [out] | y | The y coordinate of the upper left corner of the object. |
| [out] | w | The width of the object. |
| [out] | h | The height of the object. |
| [in] | transformed | if true, apply the transformation of the paint. |
| [in] | transformed | If true, the paint's transformations are taken into account, otherwise they aren't. |
Creates a new object and sets its all properties as in the original object.
nullptr otherwise.
+
|
+ +inline | +
Return the unique id value of the paint instance.
+This method can be called for checking the current concrete instance type.
+@BETA_API
+A 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. +
A 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. More...
Static Public Member Functions | |
| static std::unique_ptr< Picture > | gen () noexcept |
| Creates a new Picture object. More... | |
| Creates a new Picture object. More... | |
| static uint32_t | identifier () noexcept |
| Return the unique id value of this class. More... | |
A 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.
+A 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.
+
|
+ +staticnoexcept | +
data memory if the copy is true | [in] | data | A pointer to a memory location where the content of the picture file is stored. |
| [in] | size | The size in bytes of the memory occupied by the data. |
| [in] | mimetype | Mimetype or extension of data such as "jpg", "jpeg", "svg", "svg+xml", "png", etc. If empty string or unknown, loaders will be tried one by one. |
| [in] | copy | Decides whether the data should be copied into the engine local buffer. |
| [in] | mimeType | 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. |
| [in] | copy | If true the data are copied into the engine local buffer, otherwise they are not. |
data memory if the copy is truedata memory if the copy is true.Resize the picture content with the given width and height.
-Resize the picture content 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.
+Resizes the picture content to the given width and height.
+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.
| [in] | w | A new width of the image in pixels. | |
ThorVG
- v0.5
+ v0.6
|
@@ -79,10 +79,14 @@ $(function() {
| colorStops(const ColorStop **colorStops) const noexcept | Fill | |
| duplicate() const noexcept | Fill | |
| gen() noexcept | RadialGradient | static |
| identifier() noexcept | RadialGradient | static |
| tvg::Fill::identifier() const | Fill | inline |
| radial(float cx, float cy, float radius) noexcept | RadialGradient | |
| radial(float *cx, float *cy, float *radius) const noexcept | RadialGradient | |
| spread(FillSpread s) noexcept | Fill | |
| spread() const noexcept | Fill | |
| transform(const Matrix &m) noexcept | Fill | |
| transform() const noexcept | Fill |
Public Member Functions | |
| Result | spread (FillSpread s) noexcept |
| Sets the FillSpread value, which specifies how to fill the area outside the gradient bounds. More... | |
| Result | transform (const Matrix &m) noexcept |
| Sets the matrix of the affine transformation for the gradient fill. More... | |
| uint32_t | colorStops (const ColorStop **colorStops) const noexcept |
| Gets the parameters of the colors of the gradient, their position and number. More... | |
| FillSpread | spread () const noexcept |
| Gets the FillSpread value of the fill. More... | |
| Matrix | transform () const noexcept |
| Gets the matrix of the affine transformation of the gradient fill. More... | |
| Fill * | duplicate () const noexcept |
| Creates a copy of the Fill object. More... | |
| uint32_t | identifier () const |
| Return the unique id value of the Fill instance. More... | |
Static Public Member Functions | |
| static std::unique_ptr< RadialGradient > | gen () noexcept |
| Creates a new RadialGradient object. More... | |
| static uint32_t | identifier () noexcept |
| Return the unique id value of this class. More... | |
A class representing the radial gradient fill of the Shape object.
@@ -149,6 +170,36 @@ Static Public Member FunctionsCreates a new RadialGradient object.
+
|
+ +staticnoexcept | +
Return the unique id value of this class.
+This method can be referred for identifying the RadialGradient class type.
+@BETA_API
+radius value is zero or less. A class for exporting a paint object into a specified file, from which to recover the paint data later.
-ThorVG provides a feature for exporting & importing paint data, the Saver has a role to export it to a file. Basically, this feature is useful when you need to save the composed scene or image from a paint object and recreate it later.
-The file format is decided by the extension name(i.e. "*.tvg") while the supported formats depend on the TVG packaging environment. If it doesn't support the file format, it will return the NonSuppport result by the save() method.
Once you export a paint to the file successfully, you can recreate it using the Picture class.
+ThorVG provides a feature for exporting & importing paint data. The Saver role is to export the paint data to a file. It's useful when you need to save the composed scene or image from a paint object and recreate it later.
+The file format is decided by the extension name(i.e. "*.tvg") while the supported formats depend on the TVG packaging environment. If it doesn't support the file format, the save() method returns the Result::NonSuppport result.
Once you export a paint to the file successfully, you can recreate it using the Picture class.
Exports the given paint data to the given path.
If the saver module supports any compression mechanism, it will optimize the data size. This might affect the encoding/decoding time slow down in cases, You can turn off the compression if your system whole focus on the speed.
+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.
| [in] | paint | The paint to be saved with all its associated properties. |
| [in] | path | A path to the file, in which the paint data is to be saved. |
| [in] | compress | Use data compression if it's available. |
| [in] | compress | If true then compress data if possible. |
| Result::Success | When succeed. |
| Result::NonSupport | When trying to save a file with an unknown extension nor non supported format. |
| Result::Unknown | Others. |
| Result::InsufficientCondition | If currently saving other resources. |
| Result::NonSupport | When trying to save a file with an unknown extension or in an unsupported format. |
| Result::MemoryCorruption | An internal error. |
| Result::Unknown | In case an empty paint is to be saved. |
Guarantees that the saving task is finished.
-The behavior of the saver will work 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 sync() after the save() in the proper delayed time. Otherwise, you can call sync() immediately.
-The behavior of the Saver 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 sync() after the save() in the proper delayed time. Otherwise, you can call sync() immediately.
+| Result::Success | when succeed. |
| Result::InsufficientCondition | otherwise. |
Public Member Functions | |
| CompositeMethod | composite (const Paint **target) const noexcept |
| Gets the composition target object and the composition method. More... | |
| uint32_t | identifier () const |
| Return the unique id value of the paint instance. More... | |
Static Public Member Functions | |
| static std::unique_ptr< Scene > | gen () noexcept |
| Creates a new Scene object. More... | |
| static uint32_t | identifier () noexcept |
| Return the unique id value of this class. More... | |
A class to composite children paints.
@@ -181,9 +196,7 @@ Static Public Member Functionsfree argument only when you know how it works, otherwise it's not recommended. free argument only when you know how it works, otherwise it's not recommended.Creates a new Scene object.
+
|
+ +staticnoexcept | +
Passes drawing elements to the Scene using Paint objects.
-Only pushed paints in the scene will be drawing targets. They are retained by the scene until you call Scene::clear(). If you know the number of the pushed objects in the advance, please call Scene::reserve().
+Only the paints pushed into the scene will be the drawn targets. The paints are retained by the scene until Scene::clear() is called. If you know the number of the pushed objects in advance, please call Scene::reserve().
| [in] | paint | A Paint object to be drawn. |
Public Member Functions | |
| CompositeMethod | composite (const Paint **target) const noexcept |
| Gets the composition target object and the composition method. More... | |
| uint32_t | identifier () const |
| Return the unique id value of the paint instance. More... | |
Static Public Member Functions | |
| static std::unique_ptr< Shape > | gen () noexcept |
| Creates a new Shape object. More... | |
| static uint32_t | identifier () noexcept |
| Return the unique id value of this class. More... | |
A class representing two-dimensional figures and their properties.
@@ -668,7 +683,7 @@ Static Public Member FunctionsSets the fill rule for the Shape object.
| [in] | r | The fill rule value. |
| [in] | r | The fill rule value. The default value is FillRule::Winding. |
Creates a new Shape object.
+
|
+ +staticnoexcept | +
| Result::Success | When succeed. |
| Result::FailedAllocation | An internal error with a memory allocation for an object to be dashed. |
| Result::InvalidArguments | In case that either dashPattern is nullptr or cnt is zero. |
| Result::InvalidArguments | In case dashPattern is nullptr and cnt > 0, cnt is zero, any of the dash pattern values is zero or less. |
nullptr to dashPattern and zero to cnt. nullptr to dashPattern and zero to cnt. cnt must be greater than 1 if the dash pattern is valid. This is the complete list of members for SwCanvas, including all inherited members.
| ABGR8888 enum value | SwCanvas | |
| ARGB8888 enum value | SwCanvas | |
| ABGR8888_STRAIGHT enum value | SwCanvas | |
| ARGB8888 enum value | SwCanvas | |
| ARGB8888_STRAIGHT enum value | SwCanvas | |
| clear(bool free=true) noexcept | Canvas | virtual |
| Colorspace enum name | SwCanvas | |
| Default enum value | SwCanvas | |
ThorVG
- v0.5
+ v0.6
|
@@ -89,11 +89,22 @@ Inheritance diagram for SwCanvas:
Public Types | |
| enum | Colorspace { ABGR8888 = 0, -ARGB8888 +ARGB8888, +ABGR8888_STRAIGHT, +ARGB8888_STRAIGHT } |
| Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color. More... | |
| 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... | |
| Result::Success | When succeed. |
| Result::InsufficientCondition | If the canvas has no paints. |
| Result::InsufficientCondition | If the canvas contains some paints already. |
| Result::NonSupport | In case the software engine is not supported. |
buffer during Canvas::draw() - Canvas::sync(). It should not be accessed while TVG is writing on it. buffer during Canvas::draw() - Canvas::sync(). It should not be accessed while TVG is writing on it. 
diff --git a/docs/html/modules.html b/docs/html/modules.html
index f95daf64..cd9b0af7 100644
--- a/docs/html/modules.html
+++ b/docs/html/modules.html
@@ -24,7 +24,7 @@