git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 13:43:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

api doc: replace beta api desc to beta tag

Browse source
This commit is contained in:
Hermet Park 2021-05-14 19:49:28 +09:00
parent f8f90f3f34
commit af01f5b899
2 changed files with 24 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
inc/thorvg.h
View file

@ -1012,23 +1012,29 @@ public:
Result size(float* w, float* h) const noexcept;
/**
* @brief Gets the pixels information of the picture. (BETA version)
* @brief Gets the pixels information of the picture.
*
* @warning Please do not use it, this API is not official one. It could be modified in the next version.
*
* @BETA_API
*/
const uint32_t* data() const noexcept;
/**
* @brief Loads a raw data from a memory block with a given size. (BETA version)
* @brief Loads a raw data from a memory block with a given size.
*
* @warning Please do not use it, this API is not official one. It could be modified in the next version.
*
* @BETA_API
*/
Result load(uint32_t* data, uint32_t w, uint32_t h, bool copy) noexcept;
/**
* @brief Gets the position and the size of the loaded picture. (BETA version)
* @brief Gets the position and the size of the loaded picture.
*
* @warning Please do not use it, this API is not official one. It could be modified in the next version.
*
* @BETA_API
*/
Result viewbox(float* x, float* y, float* w, float* h) const noexcept;
@ -1088,9 +1094,11 @@ public:
Result reserve(uint32_t size) noexcept;
/**
* @brief Sets the total number of the paints pushed into the scene to be zero. (BETA version)
* @brief Sets the total number of the paints pushed into the scene to be zero.
*
* @warning Please do not use it, this API is not official one. It could be modified in the next version.
*
* @BETA_API
*/
Result clear() noexcept;
@ -1192,11 +1200,13 @@ public:
/**
* @class GlCanvas (BETA version)
* @class GlCanvas
*
* @brief A class for the rendering graphic elements with a GL raster engine.
*
* @warning Please do not use it. This class is not fully supported yet.
*
* @BETA_API
*/
class TVG_EXPORT GlCanvas final : public Canvas
{
@ -1204,16 +1214,20 @@ public:
~GlCanvas();
/**
* @brief Sets the target buffer for the rasterization. (BETA version)
* @brief Sets the target buffer for the rasterization.
*
* @warning Please do not use it, this API is not official one. It could be modified in the next version.
*
* @BETA_API
*/
Result target(uint32_t* buffer, uint32_t stride, uint32_t w, uint32_t h) noexcept;
/**
* @brief Creates a new GlCanvas object.(BETA version)
* @brief Creates a new GlCanvas object.
*
* @return A new GlCanvas object.
*
* @BETA_API
*/
static std::unique_ptr<GlCanvas> gen() noexcept;

4
inc/thorvg_capi.h
View file

@ -1,7 +1,7 @@
/*!
* \file thorvg_capi.h
*
* \brief The module provides C bindings for the ThorVG library. (BETA version)
* \brief The module provides C bindings for the ThorVG library.
* Please refer to src/examples/Capi.cpp to find the thorvg_capi usage examples.
*
* The thorvg_capi module allows to implement the ThorVG client and provides
@ -12,6 +12,8 @@
* - stroking: width, join, cap, dash
* - composition: blending, masking, path clipping
* - pictures: SVG, PNG, bitmap
*
* @BETA_API
*/
#ifndef __THORVG_CAPI_H__