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>
27 #include <dali-toolkit/public-api/image-loader/image-url.h>
34 * API to interface with the toolkit image
35 * Allows developers to add FrameBuffer, PixelData and NativeImageSource to toolkit so that visuals can use them to render
40 * @brief Generate a Url from frame buffer.
41 * This Url can be used in visuals to render the frame buffer.
42 * @note Any color textures already attached in this freme buffer are not converted to the Url by this method.
43 * This method does not check for duplicates, If same frame buffer is entered multiple times, a different URL is returned each time.
44 * @param[in] frameBuffer the frame buffer to converted to Url
45 * @param[in] pixelFormat the pixel format for this frame buffer
46 * @param[in] width the width for this frame buffer
47 * @param[in] height the height for this frame buffer
48 * @return the ImageUrl representing this frame buffer
50 DALI_TOOLKIT_API Dali::Toolkit::ImageUrl GenerateUrl(const Dali::FrameBuffer frameBuffer, Pixel::Format pixelFormat, uint32_t width, uint32_t height);
53 * @brief Generate a Url from frame buffer.
54 * This Url can be used in visuals to render the frame buffer.
55 * @note Only an color texture already attached in this frame buffer can be convert to Url by this method.
56 * This method does not check for duplicates, If same frame buffer is entered multiple times, a different URL is returned each time.
57 * @param[in] frameBuffer the frame buffer to converted to Url
58 * @param[in] index the index of the attached color texture.
59 * @return the ImageUrl representing this frame buffer
61 DALI_TOOLKIT_API Dali::Toolkit::ImageUrl GenerateUrl(const Dali::FrameBuffer frameBuffer, uint8_t index);
64 * @brief Generate a Url from Pixel data.
65 * This Url can be used in visuals to render the pixel data.
66 * @note This method does not check for duplicates, If same pixel data is entered multiple times, a different URL is returned each time.
67 * @param[in] pixelData the pixel data to converted to Url
68 * @return the ImageUrl representing this pixel data
70 DALI_TOOLKIT_API Dali::Toolkit::ImageUrl GenerateUrl(const Dali::PixelData pixelData);
73 * @brief Generate a Url from native image source.
74 * This Url can be used in visuals to render the native image source.
75 * @note This method does not check for duplicates, If same native image source is entered multiple times, a different URL is returned each time.
76 * @param[in] nativeImageSource the native image source to converted to Url
77 * @return the ImageUrl representing this native image source
79 DALI_TOOLKIT_API Dali::Toolkit::ImageUrl GenerateUrl(const Dali::NativeImageSourcePtr nativeImageSource);
83 } // namespace Toolkit
87 #endif // DALI_TOOLKIT_IMAGE_H