1 #ifndef DALI_TOOLKIT_IMAGE_H
2 #define DALI_TOOLKIT_IMAGE_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.
21 #include <dali/public-api/adaptor-framework/native-image-source.h>
22 #include <dali/public-api/images/pixel-data.h>
23 #include <dali/public-api/rendering/frame-buffer.h>
26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
33 * API to interface with the toolkit image
34 * Allows developers to add FrameBuffer, PixelData and NativeImageSource to toolkit so that visuals can use them to render
39 * @brief Generate a Url from frame buffer.
40 * This Url can be used in visuals to render the frame buffer.
41 * @note Any color textures already attached in this freme buffer are not converted to the Url by this method.
42 * This method does not check for duplicates, If same frame buffer is entered multiple times, a different URL is returned each time.
43 * @param[in] frameBuffer the frame buffer to converted to Url
44 * @param[in] pixelFormat the pixel format for this frame buffer
45 * @param[in] width the width for this frame buffer
46 * @param[in] height the height for this frame buffer
47 * @return the Url string representing this frame buffer
49 DALI_TOOLKIT_API std::string GenerateUrl(const Dali::FrameBuffer frameBuffer, Pixel::Format pixelFormat, uint32_t width, uint32_t height);
52 * @brief Generate a Url from frame buffer.
53 * This Url can be used in visuals to render the frame buffer.
54 * @note Only an color texture already attached in this frame buffer can be convert to Url by this method.
55 * This method does not check for duplicates, If same frame buffer is entered multiple times, a different URL is returned each time.
56 * @param[in] frameBuffer the frame buffer to converted to Url
57 * @param[in] index the index of the attached color texture.
58 * @return the Url string representing this frame buffer
60 DALI_TOOLKIT_API std::string GenerateUrl(const Dali::FrameBuffer frameBuffer, uint8_t index);
63 * @brief Generate a Url from Pixel data.
64 * This Url can be used in visuals to render the pixel data.
65 * @note This method does not check for duplicates, If same pixel data is entered multiple times, a different URL is returned each time.
66 * @param[in] pixelData the pixel data to converted to Url
67 * @return the Url string representing this pixel data
69 DALI_TOOLKIT_API std::string GenerateUrl(const Dali::PixelData pixelData);
72 * @brief Generate a Url from native image source.
73 * This Url can be used in visuals to render the native image source.
74 * @note This method does not check for duplicates, If same native image source is entered multiple times, a different URL is returned each time.
75 * @param[in] nativeImageSource the native image source to converted to Url
76 * @return the Url string representing this native image source
78 DALI_TOOLKIT_API std::string GenerateUrl(const Dali::NativeImageSourcePtr nativeImageSource);
82 } // namespace Toolkit
86 #endif // DALI_TOOLKIT_IMAGE_H