1 #ifndef __DALI_TOOLKIT_ATLAS_GLYPH_MANAGER_H__
2 #define __DALI_TOOLKIT_ATLAS_GLYPH_MANAGER_H__
5 * Copyright (c) 2015 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-toolkit/internal/atlas-manager/atlas-manager.h>
23 #include <dali-toolkit/internal/text/text-definitions.h>
31 namespace Internal DALI_INTERNAL
33 class AtlasGlyphManager;
37 class DALI_IMPORT_API AtlasGlyphManager : public BaseHandle
42 * Description of GlyphManager state
46 uint32_t mGlyphCount; // number of glyphs being managed
47 AtlasManager::Metrics mAtlasMetrics; // metrics from the Atlas Manager
51 * @brief Create a AtlasGlyphManager handle.
53 * Calling member functions with an uninitialised handle is not allowed.
60 * This is non-virtual since derived Handle types must not contain data or virtual methods.
65 * @brief Create or retrieve AtlasGlyphManager singleton.
67 * @return A handle to the AtlasGlyphManager control.
69 static AtlasGlyphManager Get();
72 * @brief Ask Atlas Manager to add a glyph
74 * @param[in] glyph glyph to add to an atlas
75 * @param[in] bitmap bitmap to use for glyph addition
76 * @param[out] slot information returned by atlas manager for addition
78 void Add( const Text::GlyphInfo& glyph,
79 const BufferImage& bitmap,
80 AtlasManager::AtlasSlot& slot );
83 * @brief Generate mesh data for an image contained in an atlas
85 * @param[in] imageId ID of image to generate geometry for
86 * @param[in] position top left of image
87 * @param[out] meshData generated MeshData
89 void GenerateMeshData( uint32_t imageId,
90 const Vector2& position,
94 * @brief Stitch Two Meshes together
96 * @param[in] first first mesh
97 * @param[in] second second mesh
99 void StitchMesh( MeshData& first,
100 const MeshData& second );
103 * @brief Check to see if a glyph is being cached
105 * @param[in] fontId The font that this glyph comes from
106 * @param[in] index The GlyphIndex of this glyph
107 * @param[out] slot container holding information about the glyph( mImage = 0 indicates not being cached )
109 void Cached( Text::FontId fontId,
110 Text::GlyphIndex index,
111 AtlasManager::AtlasSlot& slot );
114 * @brief Retrieve the size of an atlas
116 * @param[in] atlasId Id of the atlas to interrogate
118 * @return The pixel size of the atlas
120 Vector2 GetAtlasSize( uint32_t atlasId );
123 * @brief Set the Atlas size and block size for subsequent atlas generation
125 * @param[in] size size of the atlas in pixels
126 * @param[in] blockSize size of a block in this atlas in pixels
128 void SetNewAtlasSize( const Vector2& size,
129 const Vector2& blockSize );
132 * @brief Unreference an image from the atlas and remove from cache if no longer needed
134 * @param[in] imageId ID of the image
136 void Remove( uint32_t imageId );
139 * @brief Get the Pixel Format used by an atlas
141 * @param[in] atlasId Id of atlas to check
143 * @return The pixel format of the atlas
145 Pixel::Format GetPixelFormat( uint32_t atlasId );
148 * @brief Get Glyph Manager metrics
150 * @return const reference to glyph manager metrics
152 const Metrics& GetMetrics();
156 explicit DALI_INTERNAL AtlasGlyphManager(Internal::AtlasGlyphManager *impl);
160 } // namespace Toolkit
164 #endif // __DALI_TOOLKIT_ATLAS_GLYPH_MANAGER_H__