doc: specify api visibility scope.

This lottie-player is a library for tizen platform developers.

Change-Id: Iaf3d91fde40e64cf2e3e719b1a39d6cacd4e7bcc
This commit is contained in:
Hermet Park 2018-12-06 12:07:03 +09:00
parent ebc6577274
commit 973b74c0a2

View File

@ -44,6 +44,8 @@ public:
* @param[in] bytesPerLine number of bytes in a surface scanline. * @param[in] bytesPerLine number of bytes in a surface scanline.
* *
* @note Default surface format is ARGB32_Premultiplied. * @note Default surface format is ARGB32_Premultiplied.
*
* @internal
*/ */
Surface(uint32_t *buffer, size_t width, size_t height, size_t bytesPerLine); Surface(uint32_t *buffer, size_t width, size_t height, size_t bytesPerLine);
@ -51,6 +53,9 @@ public:
* @brief Returns width of the surface. * @brief Returns width of the surface.
* *
* @return surface width * @return surface width
*
* @internal
*
*/ */
size_t width() const {return mWidth;} size_t width() const {return mWidth;}
@ -58,6 +63,8 @@ public:
* @brief Returns height of the surface. * @brief Returns height of the surface.
* *
* @return surface height * @return surface height
*
* @internal
*/ */
size_t height() const {return mHeight;} size_t height() const {return mHeight;}
@ -65,6 +72,8 @@ public:
* @brief Returns number of bytes in the surface scanline. * @brief Returns number of bytes in the surface scanline.
* *
* @return number of bytes in scanline. * @return number of bytes in scanline.
*
* @internal
*/ */
size_t bytesPerLine() const {return mBytesPerLine;} size_t bytesPerLine() const {return mBytesPerLine;}
@ -72,6 +81,8 @@ public:
* @brief Returns buffer attached tp the surface. * @brief Returns buffer attached tp the surface.
* *
* @return buffer attaced to the Surface. * @return buffer attaced to the Surface.
*
* @internal
*/ */
uint32_t *buffer() const {return mBuffer;} uint32_t *buffer() const {return mBuffer;}
@ -96,6 +107,8 @@ public:
* *
* @return Animation object that can render the contents of the * @return Animation object that can render the contents of the
* lottie resource represented by file path. * lottie resource represented by file path.
*
* @internal
*/ */
static std::unique_ptr<Animation> static std::unique_ptr<Animation>
loadFromFile(const std::string &path); loadFromFile(const std::string &path);
@ -108,6 +121,8 @@ public:
* *
* @return Animation object that can render the contents of the * @return Animation object that can render the contents of the
* lottie resource represented by JSON string data. * lottie resource represented by JSON string data.
*
* @internal
*/ */
static std::unique_ptr<Animation> static std::unique_ptr<Animation>
loadFromData(std::string jsonData, const std::string &key); loadFromData(std::string jsonData, const std::string &key);
@ -117,6 +132,8 @@ public:
* *
* @return framerate of the lottie resource * @return framerate of the lottie resource
* *
* @internal
*
*/ */
double frameRate() const; double frameRate() const;
@ -126,6 +143,8 @@ public:
* @return frame count of the lottie resource. * @return frame count of the lottie resource.
* *
* @note frame number starts with 0. * @note frame number starts with 0.
*
* @internal
*/ */
size_t totalFrame() const; size_t totalFrame() const;
@ -135,6 +154,8 @@ public:
* @param[out] width default width of the viewport. * @param[out] width default width of the viewport.
* @param[out] height default height of the viewport. * @param[out] height default height of the viewport.
* *
* @internal
*
*/ */
void size(size_t &width, size_t &height) const; void size(size_t &width, size_t &height) const;
@ -148,6 +169,8 @@ public:
* *
* @see totalFrame() * @see totalFrame()
* @see frameRate() * @see frameRate()
*
* @internal
*/ */
double duration() const; double duration() const;
@ -161,6 +184,7 @@ public:
* *
* @return frame numer maps to the position value [startFrame .... endFrame] * @return frame numer maps to the position value [startFrame .... endFrame]
* *
* @internal
*/ */
size_t frameAtPos(double pos); size_t frameAtPos(double pos);
@ -180,7 +204,9 @@ public:
* @return future that will hold the result when rendering finished. * @return future that will hold the result when rendering finished.
* *
* for Synchronus rendering @see renderSync * for Synchronus rendering @see renderSync
*
* @see Surface * @see Surface
* @internal
*/ */
std::future<Surface> render(size_t frameNo, Surface surface); std::future<Surface> render(size_t frameNo, Surface surface);
@ -190,6 +216,8 @@ public:
* *
* @param[in] frameNo Content corresponds to the frameno needs to be drawn * @param[in] frameNo Content corresponds to the frameno needs to be drawn
* @param[in] surface Surface in which content will be drawn * @param[in] surface Surface in which content will be drawn
*
* @internal
*/ */
void renderSync(size_t frameNo, Surface surface); void renderSync(size_t frameNo, Surface surface);
@ -202,6 +230,8 @@ public:
* @param[in] height content viewbox height * @param[in] height content viewbox height
* *
* @return render node list. * @return render node list.
*
* @internal
*/ */
const std::vector<LOTNode *> &renderList(size_t frameNo, size_t width, size_t height) const; const std::vector<LOTNode *> &renderList(size_t frameNo, size_t width, size_t height) const;
@ -214,17 +244,23 @@ public:
* @param[in] height content viewbox height * @param[in] height content viewbox height
* *
* @return Root layer node. * @return Root layer node.
*
* @internal
*/ */
const LOTLayerNode * renderTree(size_t frameNo, size_t width, size_t height) const; const LOTLayerNode * renderTree(size_t frameNo, size_t width, size_t height) const;
/** /**
* @brief default destructor * @brief default destructor
*
* @internal
*/ */
~Animation(); ~Animation();
private: private:
/** /**
* @brief default constructor * @brief default constructor
*
* @internal
*/ */
Animation(); Animation();