apis: release official apis.

tvg picture is going to be released, we need the Saver as well.
Also, two stable periperal apis are released in v0.5

@APIs:
Result Picture::load(const char* data, uint32_t size, const std::string& mimeType, bool copy = false) noexcept;
CompositeMethod Paint::composite(const Paint** target) const noexcept;
Result Saver::save(std::unique_ptr<Paint> paint, const std::string& path, bool compress = true) noexcept;
Result Saver::sync() noexcept;
static std::unique_ptr<Saver> Saver::gen() noexcept;
This commit is contained in:
Hermet Park 2021-09-23 15:17:48 +09:00 committed by Hermet Park
parent e784143ff8
commit 000d3ec2f0

View file

@ -315,7 +315,7 @@ public:
* *
* @return The method used to composite the source object with the target. * @return The method used to composite the source object with the target.
* *
* @BETA_API * @since 0.5
*/ */
CompositeMethod composite(const Paint** target) const noexcept; CompositeMethod composite(const Paint** target) const noexcept;
@ -1040,7 +1040,7 @@ public:
* *
* @warning: you have responsibility to release the @p data memory if the @p copy is true * @warning: you have responsibility to release the @p data memory if the @p copy is true
* *
* @BETA_API * @since 0.5
*/ */
Result load(const char* data, uint32_t size, const std::string& mimeType, bool copy = false) noexcept; Result load(const char* data, uint32_t size, const std::string& mimeType, bool copy = false) noexcept;
@ -1361,7 +1361,7 @@ public:
* *
* @see Picture::load() * @see Picture::load()
* *
* @BETA_API * @since 0.5
*/ */
class TVG_EXPORT Saver class TVG_EXPORT Saver
{ {
@ -1386,7 +1386,7 @@ public:
* @note Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call sync() afterwards. * @note Saving can be asynchronous if the assigned thread number is greater than zero. To guarantee the saving is done, call sync() afterwards.
* @see Saver::sync() * @see Saver::sync()
* *
* @BETA_API * @since 0.5
*/ */
Result save(std::unique_ptr<Paint> paint, const std::string& path, bool compress = true) noexcept; Result save(std::unique_ptr<Paint> paint, const std::string& path, bool compress = true) noexcept;
@ -1403,7 +1403,7 @@ public:
* @note The asynchronous tasking is depend on the saver module implementation. * @note The asynchronous tasking is depend on the saver module implementation.
* @see Saver::save() * @see Saver::save()
* *
* @BETA_API * @since 0.5
*/ */
Result sync() noexcept; Result sync() noexcept;
@ -1412,7 +1412,7 @@ public:
* *
* @return A new Saver object. * @return A new Saver object.
* *
* @BETA_API * @since 0.5
*/ */
static std::unique_ptr<Saver> gen() noexcept; static std::unique_ptr<Saver> gen() noexcept;