1 #ifndef __DALI_TOOLKIT_INTERNAL_IMAGE_RENDERER_H__
2 #define __DALI_TOOLKIT_INTERNAL_IMAGE_RENDERER_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/controls/renderers/control-renderer-impl.h>
25 #include <dali/public-api/images/image.h>
26 #include <dali/public-api/images/image-operations.h>
38 typedef IntrusivePtr< ImageRenderer > ImageRendererPtr;
41 * The renderer which renders an image to the control's quad
43 * The following properties are optional
45 * | %Property Name | Type |
46 * |---------------------------|------------------|
47 * | image-url | STRING |
48 * | image-fitting-mode | STRING |
49 * | image-sampling-mode | STRING |
50 * | image-desired-width | INT |
51 * | image-desired-height | INT |
53 * where image-fitting-mode should be one of the following fitting modes:
60 * where image-sampling-mode should be one of the following sampling modes:
71 class ImageRenderer: public ControlRenderer
81 * @brief A reference counted object may only be deleted by calling Unreference().
85 public: // from ControlRenderer
87 * @copydoc ControlRenderer::Initialize
89 virtual void Initialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap );
92 * @copydoc ControlRenderer::SetSize
94 virtual void SetSize( const Vector2& size );
97 * @copydoc ControlRenderer::SetClipRect
99 virtual void SetClipRect( const Rect<int>& clipRect );
102 * @copydoc ControlRenderer::SetOffset
104 virtual void SetOffset( const Vector2& offset );
108 * @copydoc ControlRenderer::DoSetOnStage
110 virtual void DoSetOnStage( Actor& actor );
113 * @copydoc ControlRenderer::DoSetOffStage
115 virtual void DoSetOffStage( Actor& actor );
120 * @brief Sets the image of this renderer to the resource at imageUrl
121 * The renderer will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
123 * @param[in] imageUrl The URL to to image resource to use
125 void SetImage( const std::string& imageUrl );
128 * @brief Sets the image of this renderer to the resource at imageUrl
129 * The renderer will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage
131 * @param[in] imageUrl The URL to to image resource to use
132 * @param[in] desiredWidth The desired width of the resource to load
133 * @param[in] desiredHeight The desired height of the resource to load
134 * @param[in] fittingMode The FittingMode of the resource to load
135 * @param[in] samplingMode The SamplingMode of the resource to load
137 void SetImage( const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode );
140 * @brief Sets the image of this renderer to use
142 * @param[in] image The image to use
144 void SetImage( Image image );
149 * @brief Applies this renderer's image to the sampler to the material used for this renderer
151 void ApplyImageToSampler();
156 std::string mImageUrl;
157 Dali::ImageDimensions mDesiredSize;
158 Dali::FittingMode::Type mFittingMode;
159 Dali::SamplingMode::Type mSamplingMode;
163 } // namespace Internal
165 } // namespace Toolkit
169 #endif /* __DALI_TOOLKIT_INTERNAL_IMAGE_RENDERER_H__ */