1 #ifndef DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H
2 #define DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_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/devel-api/adaptor-framework/pixel-buffer.h>
23 #include <dali/public-api/signals/dali-signal.h>
26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
27 #include <dali-toolkit/internal/visuals/visual-url.h>
39 * @brief Base class used to observe the upload status of a texture.
41 * Derived class must implement the UploadComplete method which is
42 * executed once the texture is ready to draw.
44 class TextureUploadObserver
48 typedef Signal< void ( TextureUploadObserver* ) > DestructionSignalType; ///< Signal prototype for the Destruction Signal.
53 TextureUploadObserver();
56 * @brief Virtual destructor.
58 virtual ~TextureUploadObserver();
61 * The action to be taken once the async load has finished and the upload to GPU is completed.
62 * This should be overridden by the deriving class.
64 * @param[in] loadSuccess True if the texture load was successful (i.e. the resource is available). If false, then the resource failed to load. In future, this will automatically upload a "broken" image.
65 * @param[in] textureId The textureId of the loaded texture in the TextureManager
66 * @param[in] textureSet The TextureSet containing the Texture
67 * @param[in] useAtlasing True if atlasing was used (note: this may be different to what was requested)
68 * @param[in] atlasRect If using atlasing, this is the rectangle within the atlas to use.
69 * @param[in] preMultiplied True if the image had pre-multiplied alpha applied
71 virtual void UploadComplete( bool loadSuccess, int32_t textureId, TextureSet textureSet, bool useAtlasing,
72 const Vector4& atlasRect, bool preMultiplied ) = 0;
75 * The action to be taken once the async load has finished.
76 * This should be overridden by the deriving class.
78 * @param[in] loadSuccess True if the image load was successful (i.e. the resource is available). If false, then the resource failed to load.
79 * @param[in] pixelBuffer The PixelBuffer of the loaded image.
80 * @param[in] url The url address of the loaded image.
81 * @param[in] preMultiplied True if the image had pre-multiplied alpha applied
83 virtual void LoadComplete( bool loadSuccess, Devel::PixelBuffer pixelBuffer, const Internal::VisualUrl& url, bool preMultiplied ) = 0;
86 * @brief Returns the destruction signal.
87 * This is emitted when the observer is destroyed.
88 * This is used by the observer notifier to mark this observer as destroyed (IE. It no longer needs notifying).
90 DestructionSignalType& DestructionSignal();
94 DestructionSignalType mDestructionSignal; ///< The destruction signal emitted when the observer is destroyed.
99 } // namespace Toolkit
103 #endif // DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H