dali-toolkit/internal/text/text-controller-background-actor.h

   1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_BACKGROUND_ACTOR_H
   2 #define DALI_TOOLKIT_TEXT_CONTROLLER_BACKGROUND_ACTOR_H
   3
   4 /*
   5  * Copyright (c) 2022 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/actors/actor.h>
  23 #include <dali/public-api/rendering/shader.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/logical-model-impl.h>
  27 #include <dali-toolkit/internal/text/visual-model-impl.h>
  28
  29 namespace Dali::Toolkit::Text
  30 {
  31 class View;
  32
  33 /**
  34  * @brief Create an actor that renders the text background color
  35  *
  36  * @param[in] textView The text view.
  37  * @param[in] textVisualModel The text visual model.
  38  * @param[in] textLogicalModel The text logical model.
  39  * @param[in] textShaderBackground The text shader for background.
  40  *
  41  * @return the created actor or an empty handle if no background color needs to be rendered.
  42  */
  43 Actor CreateControllerBackgroundActor(const View& textView, const VisualModelPtr& textVisualModel, const LogicalModelPtr& textLogicalModel, Shader& textShaderBackground);
  44
  45 } // namespace Dali::Toolkit::Text
  46
  47 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_BACKGROUND_ACTOR_H