1 #ifndef DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H
5 * Copyright (c) 2015 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>
25 #include <dali/public-api/images/image.h>
26 #include <dali/public-api/images/image-operations.h>
27 #include <dali/public-api/images/resource-image.h>
41 typedef IntrusivePtr< ImageVisual > ImageVisualPtr;
44 * The visual which renders an image to the control's quad
46 * The following properties are optional
48 * | %Property Name | Type |
49 * |--------------------|------------------|
51 * | fittingMode | STRING |
52 * | samplingMode | STRING |
53 * | desiredWidth | INT |
54 * | desiredHeight | INT |
55 * | synchronousLoading | BOOLEAN |
57 * where imageFittingMode should be one of the following fitting modes:
64 * where imageSamplingMode should be one of the following sampling modes:
75 class ImageVisual: public Visual::Base, public ConnectionTracker
82 * @param[in] factoryCache The VisualFactoryCache object
84 ImageVisual( VisualFactoryCache& factoryCache );
87 * @brief A reference counted object may only be deleted by calling Unreference().
91 public: // from Visual
94 * @copydoc Visual::Base::GetNaturalSize
96 virtual void GetNaturalSize( Vector2& naturalSize ) const;
99 * @copydoc Visual::Base::CreatePropertyMap
101 virtual void DoCreatePropertyMap( Property::Map& map ) const;
104 * @copydoc Visual::Base::DoSetProperty
106 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
109 * @copydoc Visual::Base::DoGetProperty
111 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
115 * @copydoc Visual::Base::DoInitialize
117 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
120 * @copydoc Visual::Base::DoSetOnStage
122 virtual void DoSetOnStage( Actor& actor );
125 * @copydoc Visual::Base::DoSetOffStage
127 virtual void DoSetOffStage( Actor& actor );
132 * Get the standard image rendering shader.
133 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
134 * @param[in] atlasing Whether texture atlasing is applied.
135 * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
137 static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
140 * @brief Sets the image of this visual to the resource at imageUrl
141 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
143 * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
144 * @param[in] imageUrl The URL of the image resource to use
145 * @param[in] size The width and height to fit the loaded image to.
146 * @param[in] fittingMode The FittingMode of the resource to load
147 * @param[in] samplingMode The SamplingMode of the resource to load
149 void SetImage( Actor& actor,
150 const std::string& imageUrl,
151 ImageDimensions size=ImageDimensions(),
152 FittingMode::Type fittingMode = FittingMode::DEFAULT,
153 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
156 * @brief Sets the image to be rendered by this visual
158 * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
159 * @param[in] image The image to use
161 void SetImage( Actor& actor, const Image& image );
166 * @brief Applies the image to the texture set used for this renderer
168 * @param[in] image The Image to apply to the texture set used for this renderer
170 void ApplyImageToSampler( const Image& image );
173 * @brief Initializes the Dali::Renderer from an image url string
175 * @param[in] imageUrl The image url string to intialize this ImageVisual from
177 void InitializeRenderer( const std::string& imageUrl );
180 * @brief Initializes the Dali::Renderer from an image handle
182 * @param[in] image The image handle to intialize this ImageVisual from
184 void InitializeRenderer( const Image& image );
187 * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
189 * @return Returns the created Dali::Renderer
191 Renderer CreateRenderer() const;
194 * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
196 * @return Returns the created Dali::Renderer
198 Renderer CreateNativeImageRenderer() const;
201 * @brief Query whether resources requires to be loaded synchronously.
202 * @return Returns true if synchronoud resource loading is required, false otherwise.
204 bool IsSynchronousResourceLoading() const;
207 * @brief Do the synchronous resource loading
209 void DoSynchronousResourceLoading();
213 * @param[in] url The URL of the image resource to use.
214 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
216 Image LoadImage( const std::string& url, bool synchronousLoading );
219 * Load the image and create a texture set to hold the texture, with automatic atlasing applied.
220 * @param [out] textureRect The texture area of the resource image in the atlas.
221 * @param[in] url The URL of the image resource to use.
222 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
224 TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading );
227 * Callback function of image resource loading succeed
228 * @param[in] image The Image content that we attempted to load from mImageUrl
230 void OnImageLoaded( ResourceImage image );
233 * Set the value to the uTextureRect uniform
234 * @param[in] textureRect The texture rectangular area.
236 void SetTextureRectUniform( const Vector4& textureRect );
239 * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
241 void CleanCache(const std::string& url);
244 * Set shader code for nativeimage if it exists
246 void SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage );
253 std::string mImageUrl;
254 Dali::ImageDimensions mDesiredSize;
255 Dali::FittingMode::Type mFittingMode;
256 Dali::SamplingMode::Type mSamplingMode;
257 Dali::WrapMode::Type mWrapModeU;
258 Dali::WrapMode::Type mWrapModeV;
260 std::string mNativeFragmentShaderCode;
261 bool mNativeImageFlag;
264 } // namespace Internal
266 } // namespace Toolkit
270 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */