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;
105 * @copydoc Visual::Base::DoInitialize
107 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
110 * @copydoc Visual::Base::DoSetOnStage
112 virtual void DoSetOnStage( Actor& actor );
115 * @copydoc Visual::Base::DoSetOffStage
117 virtual void DoSetOffStage( Actor& actor );
122 * Get the standard image rendering shader.
123 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
124 * @param[in] atlasing Whether texture atlasing is applied.
125 * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied.
127 static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping );
130 * @brief Sets the image of this visual to the resource at imageUrl
131 * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
133 * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
134 * @param[in] imageUrl The URL of the image resource to use
135 * @param[in] size The width and height to fit the loaded image to.
136 * @param[in] fittingMode The FittingMode of the resource to load
137 * @param[in] samplingMode The SamplingMode of the resource to load
139 void SetImage( Actor& actor,
140 const std::string& imageUrl,
141 ImageDimensions size=ImageDimensions(),
142 FittingMode::Type fittingMode = FittingMode::DEFAULT,
143 Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR );
146 * @brief Sets the image to be rendered by this visual
148 * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor
149 * @param[in] image The image to use
151 void SetImage( Actor& actor, const Image& image );
156 * @brief Applies the image to the texture set used for this renderer
158 * @param[in] image The Image to apply to the texture set used for this renderer
160 void ApplyImageToSampler( const Image& image );
163 * @brief Initializes the Dali::Renderer from an image url string
165 * @param[in] imageUrl The image url string to intialize this ImageVisual from
167 void InitializeRenderer( const std::string& imageUrl );
170 * @brief Initializes the Dali::Renderer from an image handle
172 * @param[in] image The image handle to intialize this ImageVisual from
174 void InitializeRenderer( const Image& image );
177 * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it
179 * @return Returns the created Dali::Renderer
181 Renderer CreateRenderer() const;
184 * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it
186 * @return Returns the created Dali::Renderer
188 Renderer CreateNativeImageRenderer() const;
191 * @brief Query whether resources requires to be loaded synchronously.
192 * @return Returns true if synchronoud resource loading is required, false otherwise.
194 bool IsSynchronousResourceLoading() const;
197 * @brief Do the synchronous resource loading
199 void DoSynchronousResourceLoading();
203 * @param[in] url The URL of the image resource to use.
204 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
206 Image LoadImage( const std::string& url, bool synchronousLoading );
209 * Load the image and create a texture set to hold the texture, with automatic atlasing applied.
210 * @param [out] textureRect The texture area of the resource image in the atlas.
211 * @param[in] url The URL of the image resource to use.
212 * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously.
214 TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading );
217 * Callback function of image resource loading succeed
218 * @param[in] image The Image content that we attempted to load from mImageUrl
220 void OnImageLoaded( ResourceImage image );
223 * Set the value to the uTextureRect uniform
224 * @param[in] textureRect The texture rectangular area.
226 void SetTextureRectUniform( const Vector4& textureRect );
229 * Clean the renderer from cache, and remove the image from atlas if it is not used anymore
231 void CleanCache(const std::string& url);
234 * Set shader code for nativeimage if it exists
236 void SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage );
243 std::string mImageUrl;
244 Dali::ImageDimensions mDesiredSize;
245 Dali::FittingMode::Type mFittingMode;
246 Dali::SamplingMode::Type mSamplingMode;
247 Dali::WrapMode::Type mWrapModeU;
248 Dali::WrapMode::Type mWrapModeV;
250 std::string mNativeFragmentShaderCode;
251 bool mNativeImageFlag;
254 } // namespace Internal
256 } // namespace Toolkit
260 #endif /* DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H */