examples/contact-cards/masked-image.h

   1 #ifndef MASKED_IMAGE_H
   2 #define MASKED_IMAGE_H
   3
   4 /*
   5  * Copyright (c) 2020 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-toolkit/public-api/controls/control.h>
  23 #include <string>
  24
  25 /**
  26  * @brief This namespace provides a helper function which creates an ImageView with a mask that matches the Circle geometry provided by ClippedImage.
  27  *
  28  * Using a mask yields much better quality than when using an image with a circle geometry.
  29  * @see ClippedImage
  30  */
  31 namespace MaskedImage
  32 {
  33 /**
  34  * @brief Creates an image with a circular mask.
  35  *
  36  * @param[in]  imagePath  The path to the image to show.
  37  * @return The ImageView with a mask control.
  38  */
  39 Dali::Toolkit::Control Create(const std::string& imagePath);
  40
  41 } // namespace MaskedImage
  42
  43 #endif // MASKED_IMAGE_H