dali/devel-api/images/distance-field.h

   1 #ifndef __DALI_DISTANCE_FIELD_H__
   2 #define __DALI_DISTANCE_FIELD_H__
   3
   4 /*
   5  * Copyright (c) 2015 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
  22 // INTERNAL INCLUDES
  23 #include <dali/public-api/common/dali-common.h>
  24
  25 namespace Dali
  26 {
  27
  28 struct Vector2;
  29
  30 /**
  31  * @brief Generate a distance field map from a source image.
  32  *
  33  * @param[in]  imagePixels     A pointer to a buffer containing the source image
  34  * @param[in]  imageSize       The size, width and height, of the source image
  35  * @param[out] distanceMap     A pointer to a buffer to receive the calculated distance field map.
  36  *                             Note: This must not overlap with imagePixels for correct distance field map generation.
  37  * @param[in]  distanceMapSize The size, width and height, of the distance field map
  38  * @param[in]  fieldBorder     The amount of distance field cells to add around the data (for glow/shadow effects)
  39  * @param[in]  maxSize         The image is scaled from this size to distanceMapSize
  40  * @param[in]  highQuality     Set true to generate high quality distance fields
  41  */
  42 DALI_IMPORT_API void GenerateDistanceFieldMap( const unsigned char* const imagePixels, const Vector2& imageSize,
  43                                                unsigned char* const distanceMap, const Vector2& distanceMapSize,
  44                                                const unsigned int fieldBorder,
  45                                                const Vector2& maxSize,
  46                                                bool highQuality = true);
  47
  48 } //namespace Dali
  49
  50 #endif // ifndef __DALI_DISTANCE_FIELD_H__