2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "image-renderer.h"
22 #include <dali/public-api/images/resource-image.h>
23 #include <dali/integration-api/debug.h>
26 #include <dali-toolkit/internal/controls/renderers/renderer-factory-impl.h>
27 #include <dali-toolkit/internal/controls/renderers/renderer-factory-cache.h>
28 #include <dali-toolkit/internal/controls/renderers/control-renderer-impl.h>
29 #include <dali-toolkit/internal/controls/renderers/control-renderer-data-impl.h>
42 const char * const RENDERER_TYPE("renderer-type");
43 const char * const RENDERER_TYPE_VALUE("image-renderer");
46 const char * const IMAGE_URL_NAME( "image-url" );
47 const char * const IMAGE_FITTING_MODE( "image-fitting-mode" );
48 const char * const IMAGE_SAMPLING_MODE( "image-sampling-mode" );
49 const char * const IMAGE_DESIRED_WIDTH( "image-desired-width" );
50 const char * const IMAGE_DESIRED_HEIGHT( "image-desired-height" );
53 const char * const SHRINK_TO_FIT("shrink-to-fit");
54 const char * const SCALE_TO_FILL("scale-to-fill");
55 const char * const FIT_WIDTH("fit-width");
56 const char * const FIT_HEIGHT("fit-height");
57 const char * const DEFAULT("default");
60 const char * const BOX("box");
61 const char * const NEAREST("nearest");
62 const char * const LINEAR("linear");
63 const char * const BOX_THEN_NEAREST("box-then-nearest");
64 const char * const BOX_THEN_LINEAR("box-then-linear");
65 const char * const NO_FILTER("no-filter");
66 const char * const DONT_CARE("dont-care");
68 std::string TEXTURE_UNIFORM_NAME = "sTexture";
70 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
71 attribute mediump vec2 aPosition;\n
72 varying mediump vec2 vTexCoord;\n
73 uniform mediump mat4 uMvpMatrix;\n
74 uniform mediump vec3 uSize;\n
78 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
79 vertexPosition.xyz *= uSize;\n
80 vertexPosition = uMvpMatrix * vertexPosition;\n
82 vTexCoord = aPosition + vec2(0.5);\n
83 gl_Position = vertexPosition;\n
87 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
88 varying mediump vec2 vTexCoord;\n
89 uniform sampler2D sTexture;\n
90 uniform lowp vec4 uColor;\n
94 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
98 void AddQuadIndices( Vector< unsigned int >& indices, unsigned int rowIdx, unsigned int nextRowIdx )
100 indices.PushBack( rowIdx );
101 indices.PushBack( nextRowIdx + 1 );
102 indices.PushBack( rowIdx + 1 );
104 indices.PushBack( rowIdx );
105 indices.PushBack( nextRowIdx );
106 indices.PushBack( nextRowIdx + 1 );
109 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned int >& indices )
111 Property::Map vertexFormat;
112 vertexFormat[ "aPosition" ] = Property::VECTOR2;
113 PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat, vertices.Size() );
114 if( vertices.Size() > 0 )
116 vertexPropertyBuffer.SetData( &vertices[ 0 ] );
119 Property::Map indexFormat;
120 indexFormat[ "indices" ] = Property::INTEGER;
121 PropertyBuffer indexPropertyBuffer = PropertyBuffer::New( indexFormat, indices.Size() );
122 if( indices.Size() > 0 )
124 indexPropertyBuffer.SetData( &indices[ 0 ] );
127 // Create the geometry object
128 Geometry geometry = Geometry::New();
129 geometry.AddVertexBuffer( vertexPropertyBuffer );
130 geometry.SetIndexBuffer( indexPropertyBuffer );
135 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
139 if( gridSize == ImageDimensions( 1, 1 ) )
141 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
144 geometry = factoryCache.CreateQuadGeometry();
145 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
150 uint16_t gridWidth = gridSize.GetWidth();
151 uint16_t gridHeight = gridSize.GetHeight();
154 Vector< Vector2 > vertices;
155 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
157 for( int y = 0; y < gridHeight + 1; ++y )
159 for( int x = 0; x < gridWidth + 1; ++x )
161 vertices.PushBack( Vector2( (float)x/gridWidth - 0.5f, (float)y/gridHeight - 0.5f) );
166 Vector< unsigned int > indices;
167 indices.Reserve( gridWidth * gridHeight * 6 );
169 unsigned int rowIdx = 0;
170 unsigned int nextRowIdx = gridWidth + 1;
171 for( int y = 0; y < gridHeight; ++y, ++nextRowIdx, ++rowIdx )
173 for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
175 AddQuadIndices( indices, rowIdx, nextRowIdx );
179 return GenerateGeometry( vertices, indices );
185 } //unnamed namespace
187 ImageRenderer::ImageRenderer()
190 mFittingMode( FittingMode::DEFAULT ),
191 mSamplingMode( SamplingMode::DEFAULT )
195 ImageRenderer::~ImageRenderer()
199 void ImageRenderer::DoInitialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap )
201 Initialize(factoryCache);
203 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
206 imageURLValue->Get( mImageUrl );
207 if( !mImageUrl.empty() )
212 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
216 fittingValue->Get( fitting );
218 mFittingMode = FittingMode::DEFAULT;
219 if( fitting == SHRINK_TO_FIT )
221 mFittingMode = FittingMode::SHRINK_TO_FIT;
223 else if( fitting == SCALE_TO_FILL )
225 mFittingMode = FittingMode::SCALE_TO_FILL;
227 else if( fitting == FIT_WIDTH )
229 mFittingMode = FittingMode::FIT_WIDTH;
231 else if( fitting == FIT_HEIGHT )
233 mFittingMode = FittingMode::FIT_HEIGHT;
235 else if( fitting == DEFAULT )
237 mFittingMode = FittingMode::DEFAULT;
241 DALI_ASSERT_ALWAYS("Unknown fitting mode");
245 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
248 std::string sampling;
249 samplingValue->Get( sampling );
251 mSamplingMode = SamplingMode::DEFAULT;
252 if( sampling == BOX )
254 mSamplingMode = SamplingMode::BOX;
256 else if( sampling == NEAREST )
258 mSamplingMode = SamplingMode::NEAREST;
260 else if( sampling == LINEAR )
262 mSamplingMode = SamplingMode::LINEAR;
264 else if( sampling == BOX_THEN_NEAREST )
266 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
268 else if( sampling == BOX_THEN_LINEAR )
270 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
272 else if( sampling == NO_FILTER )
274 mSamplingMode = SamplingMode::NO_FILTER;
276 else if( sampling == DONT_CARE )
278 mSamplingMode = SamplingMode::DONT_CARE;
280 else if( sampling == DEFAULT )
282 mSamplingMode = SamplingMode::DEFAULT;
286 DALI_ASSERT_ALWAYS("Unknown sampling mode");
290 int desiredWidth = 0;
291 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
292 if( desiredWidthValue )
294 desiredWidthValue->Get( desiredWidth );
297 int desiredHeight = 0;
298 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
299 if( desiredHeightValue )
301 desiredHeightValue->Get( desiredHeight );
304 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
308 void ImageRenderer::SetSize( const Vector2& size )
310 ControlRenderer::SetSize( size );
313 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
317 naturalSize.x = mImage.GetWidth();
318 naturalSize.y = mImage.GetHeight();
321 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
323 naturalSize.x = mDesiredSize.GetWidth();
324 naturalSize.y = mDesiredSize.GetHeight();
327 else if( !mImageUrl.empty() )
329 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
330 naturalSize.x = dimentions.GetWidth();
331 naturalSize.y = dimentions.GetHeight();
335 naturalSize = Vector2::ZERO;
338 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
340 ControlRenderer::SetClipRect( clipRect );
343 void ImageRenderer::SetOffset( const Vector2& offset )
347 void ImageRenderer::DoSetOnStage( Actor& actor )
349 if( !mImageUrl.empty() && !mImage )
351 mImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
354 ApplyImageToSampler();
357 void ImageRenderer::DoSetOffStage( Actor& actor )
359 //If we own the image then make sure we release it when we go off stage
360 if( !mImageUrl.empty() )
366 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
369 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
370 if( !mImageUrl.empty() )
372 map.Insert( IMAGE_URL_NAME, mImageUrl );
373 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
374 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
378 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
379 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
381 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
384 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
388 switch( mFittingMode )
390 case Dali::FittingMode::FIT_HEIGHT:
392 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
395 case Dali::FittingMode::FIT_WIDTH:
397 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
400 case Dali::FittingMode::SCALE_TO_FILL:
402 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
405 case Dali::FittingMode::SHRINK_TO_FIT:
407 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
412 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
417 switch( mSamplingMode )
419 case Dali::SamplingMode::BOX:
421 map.Insert( IMAGE_SAMPLING_MODE, BOX );
424 case Dali::SamplingMode::NEAREST:
426 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
429 case Dali::SamplingMode::LINEAR:
431 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
434 case Dali::SamplingMode::BOX_THEN_LINEAR:
436 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
439 case Dali::SamplingMode::BOX_THEN_NEAREST:
441 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
444 case Dali::SamplingMode::NO_FILTER:
446 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
449 case Dali::SamplingMode::DONT_CARE:
451 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
456 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
462 void ImageRenderer::Initialize( RendererFactoryCache& factoryCache )
464 if( !mImpl->mCustomShader )
466 mImpl->mGeometry = CreateGeometry( factoryCache, ImageDimensions( 1, 1 ) );
468 mImpl->mShader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
470 if( !mImpl->mShader )
472 mImpl->mShader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
473 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, mImpl->mShader );
478 mImpl->mGeometry = CreateGeometry( factoryCache, mImpl->mCustomShader->mGridSize );
480 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
482 mImpl->mShader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
484 if( !mImpl->mShader )
486 mImpl->mShader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
487 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, mImpl->mShader );
492 mImpl->mShader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
493 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
494 mImpl->mCustomShader->mHints );
498 if( mImpl->mRenderer )
500 mImpl->mRenderer.SetGeometry( mImpl->mGeometry );
501 Material material = mImpl->mRenderer.GetMaterial();
504 material.SetShader( mImpl->mShader );
509 void ImageRenderer::SetImage( const std::string& imageUrl )
511 SetImage( imageUrl, 0, 0, Dali::FittingMode::DEFAULT, Dali::SamplingMode::DEFAULT );
514 void ImageRenderer::SetImage( const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
516 if( mImageUrl != imageUrl )
518 mImageUrl = imageUrl;
519 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
520 mFittingMode = fittingMode;
521 mSamplingMode = samplingMode;
523 if( !mImageUrl.empty() && mImpl->mIsOnStage )
525 mImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
526 ApplyImageToSampler();
535 void ImageRenderer::SetImage( Image image )
537 if( mImage != image )
540 mDesiredSize = ImageDimensions();
541 mFittingMode = FittingMode::DEFAULT;
542 mSamplingMode = SamplingMode::DEFAULT;
545 if( mImage && mImpl->mIsOnStage )
547 ApplyImageToSampler();
552 Image ImageRenderer::GetImage() const
557 void ImageRenderer::ApplyImageToSampler()
561 Material material = mImpl->mRenderer.GetMaterial();
564 for( std::size_t i = 0; i < material.GetNumberOfSamplers(); ++i )
566 Sampler sampler = material.GetSamplerAt( i );
567 if( sampler.GetUniformName() == TEXTURE_UNIFORM_NAME )
569 sampler.SetImage( mImage );
574 Sampler sampler = Sampler::New( mImage, TEXTURE_UNIFORM_NAME );
575 material.AddSampler( sampler );
580 } // namespace Internal
582 } // namespace Toolkit