1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
5 * Copyright (c) 2016 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-toolkit/internal/visuals/visual-base-impl.h>
23 #include <dali-toolkit/devel-api/image-loader/atlas-upload-observer.h>
26 #include <dali/public-api/images/image.h>
27 #include <dali/public-api/images/image-operations.h>
28 #include <dali/public-api/images/resource-image.h>
29 #include <dali/devel-api/object/weak-handle.h>
43 typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
46 * The visual which renders an image to the control's quad
48 * The following properties are optional
50 * | %Property Name | Type |
51 * |--------------------|------------------|
53 * | fittingMode | STRING |
54 * | samplingMode | STRING |
55 * | desiredWidth | INT |
56 * | desiredHeight | INT |
57 * | synchronousLoading | BOOLEAN |
59 * where imageFittingMode should be one of the following fitting modes:
66 * where imageSamplingMode should be one of the following sampling modes:
77 class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver
84 * @param[in] factoryCache The VisualFactoryCache object
86 ImageVisual( VisualFactoryCache& factoryCache );
89 * @brief Constructor with a URL.
91 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
93 * @param[in] factoryCache The VisualFactoryCache object
94 * @param[in] imageUrl The URL of the image resource to use
95 * @param[in] size The width and height to fit the loaded image to.
96 * @param[in] fittingMode The FittingMode of the resource to load
97 * @param[in] samplingMode The SamplingMode of the resource to load
99 ImageVisual( VisualFactoryCache& factoryCache,
100 const std::string& imageUrl,
101 ImageDimensions size=ImageDimensions(),
102 FittingMode::Type fittingMode = FittingMode::DEFAULT,
103 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
106 * @brief Constructor with an Image type.
108 * @param[in] factoryCache The VisualFactoryCache object
109 * @param[in] image The image to use
111 ImageVisual( VisualFactoryCache& factoryCache, const Image& image );
114 * @brief A reference counted object may only be deleted by calling Unreference().
118 public: // from Visual
121 * @copydoc Visual::Base::GetNaturalSize
123 virtual void GetNaturalSize( Vector2& naturalSize ) const;
126 * @copydoc Visual::Base::CreatePropertyMap
128 virtual void DoCreatePropertyMap( Property::Map& map ) const;
131 * @copydoc Visual::Base::DoSetProperty
133 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
136 * @copydoc Visual::Base::DoGetProperty
138 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
142 * @copydoc Visual::Base::DoInitialize
144 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
147 * @copydoc Visual::Base::DoSetOnStage
149 virtual void DoSetOnStage( Actor& actor );
152 * @copydoc Visual::Base::DoSetOffStage
154 virtual void DoSetOffStage( Actor& actor );
159 * Get the standard image rendering shader.
160 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
161 * @param[in] atlasing Whether texture atlasing is applied.
162 * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
164 static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
167 * @copydoc AtlasUploadObserver::UploadCompleted
169 * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
170 * This callback is the place to add the renderer as it would be called once the loading is finished.
172 virtual void UploadCompleted();
177 * @brief Applies the image to the texture set used for this renderer
179 * @param[in] image The Image to apply to the texture set used for this renderer
181 void ApplyImageToSampler( const Image& image );
184 * @brief Initializes the Dali::Renderer from an image url string
186 * @param[in] imageUrl The image url string to intialize this ImageVisual from
188 void InitializeRenderer( const std::string& imageUrl );
191 * @brief Initializes the Dali::Renderer from an image handle
193 * @param[in] image The image handle to intialize this ImageVisual from
195 void InitializeRenderer( const Image& image );
198 * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
200 * @return Returns the created Dali::Renderer
202 Renderer CreateRenderer() const;
205 * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
207 * @return Returns the created Dali::Renderer
209 Renderer CreateNativeImageRenderer() const;
212 * @brief Query whether resources requires to be loaded synchronously.
213 * @return Returns true if synchronous resource loading is required, false otherwise.
215 bool IsSynchronousResourceLoading() const;
218 * @brief Load the resource synchronously
220 void LoadResourceSynchronously();
224 * @param[in] url The URL of the image resource to use.
225 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
227 Image LoadImage( const std::string& url, bool synchronousLoading );
230 * Load the image and create a texture set to hold the texture, with automatic atlasing applied.
231 * @param [out] textureRect The texture area of the resource image in the atlas.
232 * @param[in] url The URL of the image resource to use.
233 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
235 TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading );
238 * Callback function of image resource loading succeed
239 * @param[in] image The Image content that we attempted to load from mImageUrl
241 void OnImageLoaded( ResourceImage image );
244 * Set the value to the uTextureRect uniform
245 * @param[in] textureRect The texture rectangular area.
247 void SetTextureRectUniform( const Vector4& textureRect );
250 * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
252 void CleanCache(const std::string& url);
255 * Set shader code for nativeimage if it exists
257 void SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage );
263 WeakHandle<Actor> mPlacementActor;
265 std::string mImageUrl;
266 Dali::ImageDimensions mDesiredSize;
267 Dali::FittingMode::Type mFittingMode;
268 Dali::SamplingMode::Type mSamplingMode;
269 Dali::WrapMode::Type mWrapModeU;
270 Dali::WrapMode::Type mWrapModeV;
272 std::string mNativeFragmentShaderCode;
273 bool mNativeImageFlag;
276 } // namespace Internal
278 } // namespace Toolkit
282 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */