Lines Matching full:to

5 * Please refer to src/examples/Capi.cpp to find the thorvg_capi usage examples.
7 * The thorvg_capi module allows to implement the ThorVG client and provides
99 * \brief A structure representing an object that enables to save a Tvg_Paint object into a file.
129 …///< The value returned in the event of a problem with the arguments given to the API - e.g. empty…
147 …TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK, ///< The pixels of the source and the complement to the t…
148 …TVG_COMPOSITE_METHOD_LUMA_MASK,          ///< The source pixels are converted to grayscale (luma v…
149 …VERSE_LUMA_MASK   ///< The source pixels are converted to grayscale (luma value) and complement to…
153 …* @brief Enumeration indicates the method used for blending paint. Please refer to the respective …
161 …TVG_BLEND_METHOD_MULTIPLY,          ///< Takes the RGB channel values from 0 to 255 of each pixel …
171 …//< Subtracts the bottom layer from the top layer or the other way around, to always get a non-neg…
200 …* ThorVG's drawing objects can return object type values, allowing you to identify the specific ty…
228 …* Not to be confused with the path commands from the svg path element (like M, L, Q, H and many ot…
229  * TVG interprets all of them and translates to the ones from the PathCommand values.
232 … the current sub-path and connects it with its initial point - corresponds to Z command in the svg…
233 … a new initial point of the sub-path and a new current point - corresponds to M command in the svg…
234 …< Draws a line from the current point to the given point and sets a new value of the current point…
235 …rom the current point to the given point using two given control points and sets a new value of th…
243 …nts of a sub-path by a rectangle, with the width equal to the stroke width and the length equal to…
244 …nded in both endpoints of a sub-path by a half circle, with a radius equal to the half of a stroke…
250  * \brief Enumeration specifying how to fill the area outside the gradient bounds.
255 …rsect. In case the extension goes beyond the limit, the join style is converted to the Bevel style.
260  * \brief Enumeration specifying how to fill the area outside the gradient bounds.
270 …* \brief Enumeration specifying the algorithm used to establish which parts of the shape are treat…
273 …TVG_FILL_RULE_WINDING = 0, ///< A line from the point to a location outside the shape is drawn. Th…
274 …TVG_FILL_RULE_EVEN_ODD     ///< A line from the point to a location outside the shape is drawn and…
314  * The elements e31 and e32 are set to 0, e33 is set to 1.
346 * \param[in] engine_method The engine types to initialize. This is relative to the Canvas types, in…
349 …hreads The number of additional threads used to perform rendering. Zero indicates only the main th…
373 * \param engine_method The engine types to terminate. This is relative to the Canvas types, in whic…
378 * \retval TVG_RESULT_INSUFFICIENT_CONDITION Nothing to be terminated.
412 …or depends on the raster engine though the final content of the buffer is expected to be identical.
413 * \warning The Paint objects belonging to one Canvas can't be shared among multiple Canvases.
435     TVG_MEMPOOL_POLICY_DEFAULT = 0, ///< Default behavior that ThorVG is designed to.
486 * \param[in] buffer A pointer to the allocated memory block of the size @p stride x @p h.
511 * which can be reused among the canvases in order to avoid memory overhead.
513 * Thus ThorVG suggests using a memory pool policy to satisfy user demands,
514 * if it needs to guarantee the thread-safety of the internal data access.
516 * \param[in] canvas The Tvg_Canvas object of which the Memory Pool behavior is to be specified.
560 *       //now to safely delete Tvg_Canvas, tvg_canvas_clear() API have to be used
587 * \param[in] canvas The Tvg_Canvas object to be destroyed.
590 * \retval TVG_RESULT_INVALID_ARGUMENT An invalid pointer to the Tvg_Canvas object is passed.
592 … not be released, the tvg_canvas_clear() with a @c free argument value set to @c false should be c…
593 …is not responsible for the paints release anymore and it has to be done manually in order to avoid…
604 * \param[in] paint The Tvg_Paint object to be drawn.
613 …as they were pushed. Consider sorting the paints before pushing them if you intend to use layering.
622 * If the number of Tvg_Paints to be stored in a canvas is known in advance, calling this function r…
642 * \param[in] n The number of objects for which the memory is to be reserved.
651 * \brief Sets the total number of the paints pushed into the canvas to be zero.
652 * Tvg_Paint objects stored in the canvas are released if @p free is set to @c true, otherwise the m…
653 * all paints should be released manually in order to avoid memory leaks.
655 * \param[in] canvas The Tvg_Canvas object to be cleared.
669 * Should be called before drawing in order to prepare paints for the rendering.
672 * //A frame drawing example. Thread safety and events implementation is skipped to show only TVG co…
714 * \param[in] canvas The Tvg_Canvas object to be updated.
728 * rendering process, Tvg_Paint objects previously added to the canvas should be updated manually wi…
730 * \param[in] canvas The Tvg_Canvas object to which the @p paint belongs.
731 * \param[in] paint The Tvg_Paint object to be updated.
742 * \brief Requests the canvas to draw the Tvg_Paint objects.
744 * All paints from the given canvas will be rasterized to the buffer.
746 * \param[in] canvas The Tvg_Canvas object containing elements to be drawn.
751 * \note Drawing can be asynchronous based on the assigned thread number. To guarantee the drawing i…
777 * The specified viewport is used to clip the rendering output to the boundaries of the rectangle.
787 * \warning It's not allowed to change the viewport during tvg_canvas_update() - tvg_canvas_sync() o…
789 * \note When resetting the target, the viewport will also be reset to the target size.
828 * \param[in] paint The Tvg_Paint object to be released.
833 …, tvg_canvas_clear() with the @c free argument value set to @c false should be used in order to av…
843 * \param[in] paint The Tvg_Paint object to be scaled.
861 * \param[in] paint The Tvg_Paint object to be rotated.
877 * The horizontal and vertical axes point to the right and down, respectively.
879 * \param[in] paint The Tvg_Paint object to be shifted.
895 * The augmented matrix of the transformation is expected to be given.
897 * \param[in] paint The Tvg_Paint object to be transformed.
911 * \param[in] paint The Tvg_Paint object of which to get the transformation matrix.
923 * \param[in] paint The Tvg_Paint object of which the opacity value is to be set.
929 …API may require multiple renderings using a composition. It is recommended to avoid changing the o…
937 * \param[in] paint The Tvg_Paint object of which to get the opacity value.
951 * \param[in] paint The Tvg_Paint object to be copied.
961 * \param[in] paint The Tvg_Paint object of which to get the bounds.
966 …the paint's transformations are taken into account in the scene it belongs to. Otherwise they aren…
971 * \note This is useful when you need to figure out the bounding box of the paint in the canvas spac…
973 * \note If @p transformed is @c true, the paint needs to be pushed into a canvas and updated before…
984 * \param[in] method The method used to composite the source object with the target.
987 …ID_ARGUMENT An invalid @p paint or @p target object or the @p method equal to TVG_COMPOSITE_METHOD…
997 * \param[out] method The method used to composite the source object with the target.
1008 * This function restricts the drawing area of the paint object to the specified shape's paths.
1025 * \param[in] paint The Tvg_Paint object of which to get the type value.
1045 …* The blending feature allows you to combine colors to create visually appealing effects, includin…
1049  * \param[in] paint The Tvg_Paint object of which to set the blend method.
1050  * \param[in] method The blending method to be set.
1071 * The stroke of a shape is an optional property in case the shape needs to be represented with/with…
1093 * \param[in] paint A Tvg_Paint pointer to the shape object.
1106 * The value of the current point is set to the given point.
1108 * \param[in] paint A Tvg_Paint pointer to the shape object.
1119 * \brief Adds a new point to the sub-path, which results in drawing a line from the current point t…
1121 * The value of the current point is set to the given end-point.
1123 * \param[in] paint A Tvg_Paint pointer to the shape object.
1130 * \note In case this is the first command in the path, it corresponds to the tvg_shape_move_to() ca…
1136 * \brief Adds new points to the sub-path, which results in drawing a cubic Bezier curve.
1138 …, @p y). Two control points (@p cx1, @p cy1) and (@p cx2, @p cy2) are used to determine the shape …
1139 * The value of the current point is set to the given end-point.
1141 * \param[in] paint A Tvg_Paint pointer to the shape object.
1158 * \brief Closes the current sub-path by drawing a line from the current point to the initial point …
1160 * The value of the current point is set to the initial point of the closed sub-path.
1162 * \param[in] paint A Tvg_Paint pointer to the shape object.
1173 * \brief Appends a rectangle to the path.
1175 * The rectangle with rounded corners can be achieved by setting non-zero values to @p rx and @p ry …
1182 * The value of the current point is set to (@p x + @p rx, @p y) - in case @p rx is greater
1183 * than @p w/2 the current point is set to (@p x + @p w/2, @p y)
1185 * \param[in] paint A Tvg_Paint pointer to the shape object.
1196 & \note For @p rx and @p ry greater than or equal to the half of @p w and the half of @p h, respect…
1202 * \brief Appends an ellipse to the path.
1208 * The value of the current point is set to (@p cx, @p cy - @p ry).
1210 * \param[in] paint A Tvg_Paint pointer to the shape object.
1223 * \brief Appends a circular arc to the path.
1226 * The current point value is set to the end-point of the arc in case @p pie is @c false, and to the…
1228 * \param[in] paint A Tvg_Paint pointer to the shape object.
1234 * \param[in] pie Specifies whether to draw radii from the arc's center to both of its end-point - d…
1239 * \note Setting @p sweep value greater than 360 degrees, is equivalent to calling tvg_shape_append_…
1245 * \brief Appends a given sub-path to the path.
1247 * The current point value is set to the last point from the sub-path.
1251 * \param[in] paint A Tvg_Paint pointer to the shape object.
1258 …ESULT_INVALID_ARGUMENT A @c nullptr passed as the argument or @p cmdCnt or @p ptsCnt equal to zero.
1266 * The function does not allocate any data, it operates on internal memory. There is no need to free…
1278 * \param[in] paint A Tvg_Paint pointer to the shape object.
1279 * \param[out] pts The pointer to the array of the two-dimensional points from the path.
1291 * The function does not allocate any data. There is no need to free the @p cmds array.
1303 * \param[in] paint A Tvg_Paint pointer to the shape object.
1304 * \param[out] cmds The pointer to the array of the commands from the path.
1316 * \param[in] paint A Tvg_Paint pointer to the shape object.
1328 * \param[in] paint A Tvg_Paint pointer to the shape object.
1340 * \param[in] paint A Tvg_Paint pointer to the shape object.
1357 * \param[in] paint A Tvg_Paint pointer to the shape object.
1373 * \param[in] paint A Tvg_Paint pointer to the shape object.
1388 * \param[in] paint A Tvg_Paint pointer to the shape object.
1405 * \param[in] paint A Tvg_Paint pointer to the shape object.
1417 * \param[in] paint A Tvg_Paint pointer to the shape object.
1424 * \note To reset the stroke dash pattern, pass @c nullptr to @p dashPattern and zero to @p cnt.
1434 * \param[in] paint A Tvg_Paint pointer to the shape object.
1447 * The cap style specifies the shape to be used at the end of the open stroked sub-paths.
1449 * \param[in] paint A Tvg_Paint pointer to the shape object.
1461 * \param[in] paint A Tvg_Paint pointer to the shape object.
1473 * \param[in] paint A Tvg_Paint pointer to the shape object.
1485 * \param[in] paint A Tvg_Paint pointer to the shape object.
1497 * \param[in] paint A Tvg_Paint pointer to the shape object.
1511 * \param[in] paint A Tvg_Paint pointer to the shape object.
1525 …d @p end exceed the 0-1 range, they are wrapped around in a manner similar to angle wrapping, effe…
1527 * \param[in] paint A Tvg_Paint pointer to the shape object.
1528 * \param[in] begin Specifies the start of the segment to display along the path.
1529 * \param[in] end Specifies the end of the segment to display along the path.
1530 …eous Determines how to trim multiple paths within a single shape. If set to @c true (default), tri…
1531 * Otherwise, all paths are treated as a single entity with a combined length equal to the sum of th…
1546 * \param[in] paint A Tvg_Paint pointer to the shape object.
1564 * \param[in] paint A Tvg_Paint pointer to the shape object.
1579 * \param[in] paint A Tvg_Paint pointer to the shape object.
1591 * \param[in] paint A Tvg_Paint pointer to the shape object.
1603 * \param[in] paint A Tvg_Paint pointer to the shape object.
1633 * \param[in] paint A Tvg_Paint pointer to the shape object.
1665 * \param[in] paint A Tvg_Paint pointer to the shape object.
1683 * \param[in] paint A Tvg_Paint pointer to the shape object.
1699 * The module enables to set and to get the gradient colors and their arrangement inside the gradien…
1700 * to specify the gradient bounds and the gradient behavior in case the area defined by the gradient…
1701 * is smaller than the area to be filled.
1757 * the given points (@p x1, @p y1) and (@p x2, @p y2), respectively. Both lines are perpendicular to…
1760 * \param[in] grad The Tvg_Gradient object of which bounds are to be set.
1761 * @param[in] x1 The horizontal coordinate of the first point used to determine the gradient bounds.
1762 * @param[in] y1 The vertical coordinate of the first point used to determine the gradient bounds.
1763 * @param[in] x2 The horizontal coordinate of the second point used to determine the gradient bounds.
1764 * @param[in] y2 The vertical coordinate of the second point used to determine the gradient bounds.
1779 * the given points (@p x1, @p y1) and (@p x2, @p y2), respectively. Both lines are perpendicular to…
1782 * \param[in] grad The Tvg_Gradient object of which to get the bounds.
1783 * \param[out] x1 The horizontal coordinate of the first point used to determine the gradient bounds.
1784 * \param[out] y1 The vertical coordinate of the first point used to determine the gradient bounds.
1785 * \param[out] x2 The horizontal coordinate of the second point used to determine the gradient bound…
1786 * \param[out] y2 The vertical coordinate of the second point used to determine the gradient bounds.
1799 * \param[in] grad The Tvg_Gradient object of which bounds are to be set.
1816 * \param[in] grad The Tvg_Gradient object of which bounds are to be set.
1830 * \param[in] grad The Tvg_Gradient object of which the color information is to be set.
1832 * \param[in] cnt The size of the @p color_stop array equal to the colors number used in the gradien…
1845 * \param[in] grad The Tvg_Gradient object of which to get the color information.
1847 * \param[out] cnt The size of the @p color_stop array equal to the colors number used in the gradie…
1856 * \brief Sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient …
1882 * The augmented matrix of the transformation is expected to be given.
1884 * \param[in] grad The Tvg_Gradient object to be transformed.
1898 * \param[in] grad The Tvg_Gradient object of which to get the transformation matrix.
1909 * \param[in] grad The Tvg_Gradient object of which to get the type value.
1931 * \param[in] grad The Tvg_Gradient object to be copied.
1941 * \param[in] grad The gradient object to be deleted.
1955 * \brief A module enabling to create and to load an image in one of the supported formats: svg, png…
1979 * \param[in] paint A Tvg_Paint pointer to the picture object.
1980 * \param[in] path The absolute path to the image file.
1996 * \param[in] paint A Tvg_Paint pointer to the picture object.
1997 * \param[in] data A pointer to a memory location where the content of the picture raw data is store…
2019 * \param[in] paint A Tvg_Paint pointer to the picture object.
2020 * \param[in] data A pointer to a memory location where the content of the picture file is stored. A…
2029 * \warning: It's the user responsibility to release the @p data memory if the @p copy is @c true.
2035 * \brief Resizes the picture content to the given width and height.
2038 * The scaling factor is established for each of dimensions and the smaller value is applied to both…
2040 * \param[in] paint A Tvg_Paint pointer to the picture object.
2053 * \param[in] paint A Tvg_Paint pointer to the picture object.
2068 * \param[in] paint A Tvg_Paint pointer to the picture object.
2071 * \return A pointer to the paint object that matches the given identifier, or @c nullptr if no matc…
2098 * A scene object is used to group many paints into one object, which can be manipulated using TVG A…
2111 * \param[in] scene A Tvg_Paint pointer to the scene object.
2112 * \param[in] size The number of objects for which the memory is to be reserved.
2122 * \brief Passes drawing elements to the scene using Tvg_Paint objects.
2128 * \param[in] scene A Tvg_Paint pointer to the scene object.
2129 * \param[in] paint A graphical object to be drawn.
2134 …as they were pushed. Consider sorting the paints before pushing them if you intend to use layering.
2142 * Tvg_Paint objects stored in the scene are released if @p free is set to @c true, otherwise the me…
2143 * all paints should be released manually in order to avoid memory leaks.
2145 * \param[in] scene The scene object to be cleared.
2161 * \brief A class to represent text objects in a graphical context, allowing for rendering and manip…
2184 * This function allows you to define the font characteristics used for text rendering.
2187 * \param[in] paint A Tvg_Paint pointer to the text object.
2188 * \param[in] name The name of the font. This should correspond to a font available in the canvas.
2202 * \brief Assigns the given unicode text to be rendered.
2205 * The text is set according to the specified UTF encoding method, which defaults to UTF-8.
2207 * \param[in] paint A Tvg_Paint pointer to the text object.
2208 * \param[in] text The multi-byte text encoded with utf8 string to be rendered.
2221 * \param[in] paint A Tvg_Paint pointer to the text object.
2240 * \param[in] paint A Tvg_Paint pointer to the text object.
2261 * \param[in] path The path to the font file.
2265 * \retval TVG_RESULT_NOT_SUPPORTED When trying to load a file with an unknown extension.
2282 * \param[in] data A pointer to a memory location where the content of the font data is stored.
2288 …ARGUMENT If no name is provided or if \p size is zero while \p data points to a valid memory locat…
2289 * \retval TVG_RESULT_NOT_SUPPORTED When trying to load a file with an unknown extension.
2290 * \retval TVG_RESULT_INSUFFICIENT_CONDITION When trying to unload the font data that has not been p…
2292 * \warning: It's the user responsibility to release the \p data memory.
2294 * \note To unload the font data loaded using this API, pass the proper \p name and \c nullptr as \p…
2304 * This function is used to release resources associated with a font file that has been loaded into …
2306 * \param[in] path The path to the loaded font file.
2326 * The module enables to save the composed scene and/or image from a paint object.
2327 * Once it's successfully exported to a file, it can be recreated using the Picture module.
2344 * \brief Exports the given @p paint data to the given @p path
2348 * if you wish to optimize for speed.
2351 * \param[in] paint The paint to be saved with all its associated properties.
2352 * \param[in] path A path to the file, in which the paint data is to be saved.
2358 * \retval TVG_RESULT_NOT_SUPPORTED Trying to save a file with an unknown extension or in an unsuppo…
2359 * \retval TVG_RESULT_UNKNOWN An empty paint is to be saved.
2361 * \note Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee…
2371 * Thus, if you wish to have a benefit of it, you must call tvg_saver_sync() after the tvg_saver_sav…
2389 * \param[in] saver The Tvg_Saver object to be deleted.
2426 * \param[in] animation A Tvg_Animation pointer to the animation object.
2427 * \param[in] no The index of the animation frame to be displayed. The index should be less than the…
2434 * \note For efficiency, ThorVG ignores updates to the new frame value if the difference from the cu…
2447 * This function provides access to the picture instance that can be used to load animation formats,…
2448 * After setting up the picture, it can be pushed to the designated canvas, enabling control over an…
2451 * \param[in] animation A Tvg_Animation pointer to the animation object.
2453 * \return A picture instance that is tied to this animation.
2465 * \param[in] animation A Tvg_Animation pointer to the animation object.
2482 * \param[in] animation A Tvg_Animation pointer to the animation object.
2499 * \param[in] animation A Tvg_Animation pointer to the animation object.
2515 * \param[in] animation The Tvg_Animation pointer to the animation object.
2531 * \param[in] animation The Tvg_Animation pointer to the animation object.
2547 * \param[in] animation The Tvg_Animation object to be deleted.
2564 * This module helps to control the scene tree.
2576 * You can use this to assign a unique ID to the Paint object.
2578 * \param[in] name The input string to generate the unique identifier from.
2615 * \param[in] animation The Tvg_Animation object to override the property with the slot.
2616 * \param[in] slot The Lottie slot data in json, or @c nullptr to reset.
2631 * \param[in] animation The Tvg_Animation pointer to the Lottie animation object.
2647 * \param[in] animation The Tvg_Animation pointer to the Lottie animation object.
2661 * \param[in] animation The Tvg_Animation pointer to the Lottie animation object.