dali-toolkit/devel-api/utility/npatch-helper.h

   1 #ifndef DALI_TOOLKIT_NPATCH_HELPER_H
   2 #define DALI_TOOLKIT_NPATCH_HELPER_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/math/uint-16-pair.h>
  23 #include <dali/public-api/rendering/geometry.h>
  24 #include <dali/devel-api/rendering/renderer-devel.h>
  25 #include <memory> ///< for std::shared_ptr
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  29 #include <dali-toolkit/internal/visuals/npatch-data.h>
  30
  31 namespace Dali
  32 {
  33 namespace Toolkit
  34 {
  35 namespace NPatchHelper
  36 {
  37 /**
  38  * The list that includes stretch pixel ranges
  39  */
  40 using StretchRanges = Dali::Vector<Uint16Pair>;
  41
  42 /**
  43  * @brief Creates a Npatch Geometry object
  44  *
  45  * @param[in] gridSize The gridSize for creating a geometry
  46  * @return The Geometry for NPatch
  47  */
  48 DALI_TOOLKIT_API Geometry CreateGridGeometry(Uint16Pair gridSize);
  49
  50 /**
  51  * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
  52  * e.g. a 5x4 grid would create a geometry that would look like:
  53  *
  54  *   ---------------------
  55  *   |  /|  /|  /|  /|  /|
  56  *   |/  |/  |/  |/  |/  |
  57  *   ---------------------
  58  *   |  /|           |  /|
  59  *   |/  |           |/  |
  60  *   -----           -----
  61  *   |  /|           |  /|
  62  *   |/  |           |/  |
  63  *   ---------------------
  64  *   |  /|  /|  /|  /|  /|
  65  *   |/  |/  |/  |/  |/  |
  66  *   ---------------------
  67  *
  68  * @param[in] gridSize The grid size of the solid geometry to create
  69  * @return Returns the created geometry for the grid size
  70  */
  71 DALI_TOOLKIT_API Geometry CreateBorderGeometry(Uint16Pair gridSize);
  72
  73
  74 /**
  75  * @brief Registers a properties for Stretch Ranges
  76  *
  77  * @param[in,out] renderer The renderer for broken image
  78  * @param[in] uniformName The name of the uniform
  79  * @param[in] stretchPixels The stretchable pixels in the cropped image space
  80  * @param[in] imageExtent The imageExtent
  81  */
  82 void RegisterStretchProperties(Renderer& renderer, const char* uniformName, const NPatchUtility::StretchRanges& stretchPixels, uint16_t imageExtent);
  83
  84 /**
  85  * @brief Apply a texture and uniforms
  86  *
  87  * @param[in,out] renderer The renderer for broken image
  88  * @param[in] data The pointer of npatch-data
  89  */
  90 void ApplyTextureAndUniforms(Renderer& renderer, const std::shared_ptr<const Internal::NPatchData> data);
  91
  92 } // namespace NPatchUtility
  93
  94 } // namespace Toolkit
  95
  96 } // namespace Dali
  97
  98 #endif // DALI_TOOLKIT_NPATCH_HELPER_H