1 #ifndef DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H
2 #define DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H
5 * Copyright (c) 2018 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-toolkit/public-api/dali-toolkit-common.h>
22 #include <dali/public-api/signals/dali-signal.h>
34 * @brief Base class used to observe the upload status of a texture.
36 * Derived class must implement the UploadComplete method which is
37 * executed once the texture is ready to draw.
39 class TextureUploadObserver
43 typedef Signal< void ( TextureUploadObserver* ) > DestructionSignalType; ///< Signal prototype for the Destruction Signal.
48 TextureUploadObserver();
51 * @brief Virtual destructor.
53 virtual ~TextureUploadObserver();
56 * The action to be taken once the async load has finished and the upload to GPU is completed.
57 * This should be overridden by the deriving class.
59 * @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.
60 * @param[in] textureId The textureId of the loaded texture in the TextureManager
61 * @param[in] textureSet The TextureSet containing the Texture
62 * @param[in] useAtlasing True if atlasing was used (note: this may be different to what was requested)
63 * @param[in] atlasRect If using atlasing, this is the rectangle within the atlas to use.
64 * @param[in] preMultiplied True if the image had pre-multiplied alpha applied
66 virtual void UploadComplete( bool loadSuccess, int32_t textureId, TextureSet textureSet, bool useAtlasing,
67 const Vector4& atlasRect, bool preMultiplied ) = 0;
70 * @brief Returns the destruction signal.
71 * This is emitted when the observer is destroyed.
72 * This is used by the observer notifier to mark this observer as destroyed (IE. It no longer needs notifying).
74 DestructionSignalType& DestructionSignal();
78 DestructionSignalType mDestructionSignal; ///< The destruction signal emitted when the observer is destroyed.
83 } // namespace Toolkit
87 #endif // DALI_TOOLKIT_INTERNAL_TEXTURE_UPLOAD_OBSERVER_H