1 #ifndef DALI_VECTOR_IMAGE_RENDERER_H
2 #define DALI_VECTOR_IMAGE_RENDERER_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/base-handle.h>
25 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
26 #include <dali/public-api/dali-adaptor-common.h>
31 * @addtogroup dali_adaptor_framework
35 namespace Internal::Adaptor
37 class VectorImageRenderer;
38 } // namespace Internal::Adaptor
41 * @brief Used for rendering a vector image file (SVG)
43 class DALI_ADAPTOR_API VectorImageRenderer : public BaseHandle
47 * @brief Creates an initialized handle to a new VectorImageRenderer.
49 * @return A handle to a newly allocated VectorImageRenderer
51 static VectorImageRenderer New();
54 * @brief Creates an empty handle.
55 * Use VectorImageRenderer::New() to create an initialized object.
57 VectorImageRenderer();
62 ~VectorImageRenderer();
65 * @brief This copy constructor is required for (smart) pointer semantics.
67 * @param[in] handle A reference to the copied handle
69 VectorImageRenderer(const VectorImageRenderer& handle) = default;
72 * @brief This assignment operator is required for (smart) pointer semantics.
74 * @param[in] rhs A reference to the copied handle
75 * @return A reference to this
77 VectorImageRenderer& operator=(const VectorImageRenderer& rhs) = default;
80 * @brief Load vector image data directly.
82 * @param[in] data SVG image data to load.
83 * @param[in] dpi The DPI of the screen.
84 * @return True if the load success, false otherwise.
86 bool Load(const Vector<uint8_t>& data, float dpi);
89 * @brief Query whether the vector image is loaded.
91 * @return True if the image is loaded, false other wise.
93 bool IsLoaded() const;
96 * @brief Rasterizes the content to the pixel buffer synchronously.
98 * @param[in] width The pixel buffer width
99 * @param[in] height The pixel buffer height
100 * @return The handle to the rasterized PixelBuffer object or an empty handle in case failed.
102 Dali::Devel::PixelBuffer Rasterize(uint32_t width, uint32_t height);
105 * @brief Gets the default size of the file.
107 * @param[out] width The default width of the file
108 * @param[out] height The default height of the file
110 void GetDefaultSize(uint32_t& width, uint32_t& height) const;
112 public: // Not intended for application developers
115 * @brief The constructor.
116 * @note Not intended for application developers.
118 * @param[in] pointer A pointer to a newly allocated VectorImageRenderer
120 explicit DALI_INTERNAL VectorImageRenderer(Internal::Adaptor::VectorImageRenderer* internal);
129 #endif // DALI_VECTOR_IMAGE_RENDERER_H