1 #ifndef DALI_TOOLKIT_VISUAL_FACTORY_H
2 #define DALI_TOOLKIT_VISUAL_FACTORY_H
5 * Copyright (c) 2020 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/public-api/images/image-operations.h>
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/object/property-map.h>
27 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
36 namespace Internal DALI_INTERNAL
42 * @brief VisualFactory is a singleton object that provides and shares visuals between controls
44 * By setting environment variable 'DALI_DEBUG_RENDERING', a debug visual is used which renders a quad wireframe.
46 * The visual type is required in the property map for requesting a visual.
48 * | %Property Name | Type |
49 * |--------------------------|-------------------|
50 * | visualType | INTEGER or STRING |
53 class DALI_TOOLKIT_API VisualFactory : public BaseHandle
57 * @brief Create or retrieve VisualFactory singleton.
59 * @return A handle to the VisualFactory control.
61 static VisualFactory Get();
64 * @brief Create a VisualFactory handle.
66 * Calling member functions with an uninitialised handle is not allowed.
73 * This is non-virtual since derived Handle types must not contain data or virtual methods.
78 * @brief This copy constructor is required for (smart) pointer semantics.
80 * @param[in] handle A reference to the copied handle.
82 VisualFactory(const VisualFactory& handle);
85 * @brief This assignment operator is required for (smart) pointer semantics.
87 * @param [in] handle A reference to the copied handle.
88 * @return A reference to this.
90 VisualFactory& operator=(const VisualFactory& handle);
93 * @brief Request the visual
95 * @param[in] propertyMap The map contains the properties required by the visual.
96 * The content of the map determines the type of visual that will be returned.
97 * @return The handle to the created visual
99 Visual::Base CreateVisual(const Property::Map& propertyMap);
102 * @brief Request the visual to render the given resource at the url.
104 * @param[in] url The URL to the resource to be rendered.
105 * @param[in] size The width and height to fit the loaded image to.
106 * @return The pointer pointing to the visual
108 Visual::Base CreateVisual(const std::string& url, ImageDimensions size);
111 * @brief Enable or disable premultiplying alpha in images and image visuals.
113 * The default is to enable pre-multiplication on load.
115 * Applications that have assets with pre-multiplied alpha already applied should turn this option off.
117 * @param[in] preMultiply True if loaded images for image visuals should have alpha multiplied into the color
120 void SetPreMultiplyOnLoad(bool preMultiply);
123 * @brief Get the setting for automatically pre-multiplying image visual images on load.
125 * @return True if loaded images have pre-multiplied alpha applied on load, false otherwise.
127 bool GetPreMultiplyOnLoad() const;
130 explicit DALI_INTERNAL VisualFactory(Internal::VisualFactory* impl);
133 } // namespace Toolkit
137 #endif // DALI_TOOLKIT_VISUAL_FACTORY_H