1 #ifndef DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H
2 #define DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H
5 * Copyright (c) 2021 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/images/pixel-data.h>
22 #include <dali/public-api/object/base-object.h>
25 #include <dali-toolkit/devel-api/image-loader/async-image-loader-devel.h>
26 #include <dali-toolkit/internal/image-loader/image-load-thread.h>
27 #include <dali-toolkit/public-api/image-loader/async-image-loader.h>
35 class AsyncImageLoader : public BaseObject
44 * @copydoc Toolkit::AsyncImageLoader::New()
46 static IntrusivePtr<AsyncImageLoader> New();
49 * @copydoc Toolkit::AsyncImageLoader::LoadAnimatedImage( Dali::AnimatedImageLoading animatedImageLoading, uint32_t frameIndex )
51 uint32_t LoadAnimatedImage(Dali::AnimatedImageLoading animatedImageLoading,
55 * @copydoc Toolkit::AsyncImageLoader::Load( const std::string&, ImageDimensions, FittingMode::Type, SamplingMode::Type, bool , DevelAsyncImageLoader::PreMultiplyOnLoad )
57 uint32_t Load(const VisualUrl& url,
58 ImageDimensions dimensions,
59 FittingMode::Type fittingMode,
60 SamplingMode::Type samplingMode,
61 bool orientationCorrection,
62 DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad);
65 * @brief Starts an mask applying task.
66 * @param[in] pixelBuffer of the to be masked image
67 * @param[in] maskPixelBuffer of the mask image
68 * @param[in] contentScale The factor to scale the content
69 * @param[in] cropToMask Whether to crop the content to the mask size
70 * @param[in] preMultiplyOnLoad ON if the image color should be multiplied by it's alpha. Set to OFF if there is no alpha.
71 * @return The loading task id
73 uint32_t ApplyMask(Devel::PixelBuffer pixelBuffer,
74 Devel::PixelBuffer maskPixelBuffer,
77 DevelAsyncImageLoader::PreMultiplyOnLoad preMultiplyOnLoad);
80 * @copydoc Toolkit::AsyncImageLoader::ImageLoadedSignal
82 Toolkit::AsyncImageLoader::ImageLoadedSignalType& ImageLoadedSignal();
85 * @copydoc Toolkit::AsyncImageLoader::PixelBufferLoadedSignal
87 Toolkit::DevelAsyncImageLoader::PixelBufferLoadedSignalType& PixelBufferLoadedSignal();
90 * @copydoc Toolkit::AsyncImageLoader::Cancel
92 bool Cancel(uint32_t loadingTaskId);
95 * @copydoc Toolkit::AsyncImageLoader::CancelAll
100 * Process the completed loading task from the worker thread.
102 void ProcessLoadedImage();
108 ~AsyncImageLoader() override;
111 Toolkit::AsyncImageLoader::ImageLoadedSignalType mLoadedSignal;
112 Toolkit::DevelAsyncImageLoader::PixelBufferLoadedSignalType mPixelBufferLoadedSignal;
114 ImageLoadThread mLoadThread;
115 uint32_t mLoadTaskId;
116 bool mIsLoadThreadStarted;
119 } // namespace Internal
121 inline const Internal::AsyncImageLoader& GetImplementation(const Toolkit::AsyncImageLoader& handle)
123 DALI_ASSERT_ALWAYS(handle && "AsyncImageLoader handle is empty");
125 const BaseObject& object = handle.GetBaseObject();
127 return static_cast<const Internal::AsyncImageLoader&>(object);
130 inline Internal::AsyncImageLoader& GetImplementation(Toolkit::AsyncImageLoader& handle)
132 DALI_ASSERT_ALWAYS(handle && "AsyncImageLoader handle is empty");
134 BaseObject& object = handle.GetBaseObject();
136 return static_cast<Internal::AsyncImageLoader&>(object);
139 } // namespace Toolkit
143 #endif // DALI_TOOLKIT_ASYNC_IMAGE_LOADER_IMPL_H