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>
30 #include <dali-toolkit/internal/controls/renderers/image-atlas-manager.h>
43 const char * const RENDERER_TYPE("rendererType");
44 const char * const RENDERER_TYPE_VALUE("imageRenderer");
47 const char * const IMAGE_URL_NAME( "imageUrl" );
48 const char * const IMAGE_FITTING_MODE( "imageFittingMode" );
49 const char * const IMAGE_SAMPLING_MODE( "imageSamplingMode" );
50 const char * const IMAGE_DESIRED_WIDTH( "imageDesiredWidth" );
51 const char * const IMAGE_DESIRED_HEIGHT( "imageDesiredHeight" );
54 const char * const SHRINK_TO_FIT("shrinkToFit");
55 const char * const SCALE_TO_FILL("scaleToFill");
56 const char * const FIT_WIDTH("fitWidth");
57 const char * const FIT_HEIGHT("fitHeight");
58 const char * const DEFAULT("default");
61 const char * const BOX("box");
62 const char * const NEAREST("nearest");
63 const char * const LINEAR("linear");
64 const char * const BOX_THEN_NEAREST("boxThenNearest");
65 const char * const BOX_THEN_LINEAR("boxThenLinear");
66 const char * const NO_FILTER("noFilter");
67 const char * const DONT_CARE("dontCare");
69 const std::string TEXTURE_UNIFORM_NAME = "sTexture";
70 const std::string TEXTURE_RECT_UNIFORM_NAME = "uTextureRect";
71 const Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
73 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
74 attribute mediump vec2 aPosition;\n
75 varying mediump vec2 vTexCoord;\n
76 uniform mediump mat4 uMvpMatrix;\n
77 uniform mediump vec3 uSize;\n
78 uniform mediump vec4 uTextureRect;\n
82 mediump vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n
83 vertexPosition.xyz *= uSize;\n
84 vertexPosition = uMvpMatrix * vertexPosition;\n
86 vTexCoord = mix( uTextureRect.xy, uTextureRect.zw, aPosition + vec2(0.5));\n
87 gl_Position = vertexPosition;\n
91 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
92 varying mediump vec2 vTexCoord;\n
93 uniform sampler2D sTexture;\n
94 uniform lowp vec4 uColor;\n
98 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor;\n
102 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned int >& indices )
104 Property::Map vertexFormat;
105 vertexFormat[ "aPosition" ] = Property::VECTOR2;
106 PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat, vertices.Size() );
107 if( vertices.Size() > 0 )
109 vertexPropertyBuffer.SetData( &vertices[ 0 ] );
112 Property::Map indexFormat;
113 indexFormat[ "indices" ] = Property::INTEGER;
114 PropertyBuffer indexPropertyBuffer = PropertyBuffer::New( indexFormat, indices.Size() );
115 if( indices.Size() > 0 )
117 indexPropertyBuffer.SetData( &indices[ 0 ] );
120 // Create the geometry object
121 Geometry geometry = Geometry::New();
122 geometry.AddVertexBuffer( vertexPropertyBuffer );
123 geometry.SetIndexBuffer( indexPropertyBuffer );
124 geometry.SetGeometryType( Geometry::TRIANGLE_STRIP );
129 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
133 if( gridSize == ImageDimensions( 1, 1 ) )
135 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
138 geometry = factoryCache.CreateQuadGeometry();
139 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
144 uint16_t gridWidth = gridSize.GetWidth();
145 uint16_t gridHeight = gridSize.GetHeight();
148 Vector< Vector2 > vertices;
149 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
151 for( int y = 0; y < gridHeight + 1; ++y )
153 for( int x = 0; x < gridWidth + 1; ++x )
155 vertices.PushBack( Vector2( (float)x/gridWidth - 0.5f, (float)y/gridHeight - 0.5f) );
160 Vector< unsigned int > indices;
161 indices.Reserve( (gridWidth+2)*gridHeight*2 - 2);
163 for( unsigned int row = 0u; row < gridHeight; ++row )
165 unsigned int rowStartIndex = row*(gridWidth+1u);
166 unsigned int nextRowStartIndex = rowStartIndex + gridWidth +1u;
168 if( row != 0u ) // degenerate index on non-first row
170 indices.PushBack( rowStartIndex );
173 for( unsigned int column = 0u; column < gridWidth+1u; column++) // main strip
175 indices.PushBack( rowStartIndex + column);
176 indices.PushBack( nextRowStartIndex + column);
179 if( row != gridHeight-1u ) // degenerate index on non-last row
181 indices.PushBack( nextRowStartIndex + gridWidth );
185 return GenerateGeometry( vertices, indices );
191 } //unnamed namespace
193 ImageRenderer::ImageRenderer( RendererFactoryCache& factoryCache, ImageAtlasManager& atlasManager )
194 : ControlRenderer( factoryCache ),
195 mAtlasManager( atlasManager ),
196 mTextureRect( FULL_TEXTURE_RECT ),
198 mFittingMode( FittingMode::DEFAULT ),
199 mSamplingMode( SamplingMode::DEFAULT )
203 ImageRenderer::~ImageRenderer()
207 void ImageRenderer::DoInitialize( Actor& actor, const Property::Map& propertyMap )
209 std::string oldImageUrl = mImageUrl;
211 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
214 imageURLValue->Get( mImageUrl );
215 if( !mImageUrl.empty() )
220 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
224 fittingValue->Get( fitting );
226 mFittingMode = FittingMode::DEFAULT;
227 if( fitting == SHRINK_TO_FIT )
229 mFittingMode = FittingMode::SHRINK_TO_FIT;
231 else if( fitting == SCALE_TO_FILL )
233 mFittingMode = FittingMode::SCALE_TO_FILL;
235 else if( fitting == FIT_WIDTH )
237 mFittingMode = FittingMode::FIT_WIDTH;
239 else if( fitting == FIT_HEIGHT )
241 mFittingMode = FittingMode::FIT_HEIGHT;
243 else if( fitting == DEFAULT )
245 mFittingMode = FittingMode::DEFAULT;
249 DALI_ASSERT_ALWAYS("Unknown fitting mode");
253 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
256 std::string sampling;
257 samplingValue->Get( sampling );
259 mSamplingMode = SamplingMode::DEFAULT;
260 if( sampling == BOX )
262 mSamplingMode = SamplingMode::BOX;
264 else if( sampling == NEAREST )
266 mSamplingMode = SamplingMode::NEAREST;
268 else if( sampling == LINEAR )
270 mSamplingMode = SamplingMode::LINEAR;
272 else if( sampling == BOX_THEN_NEAREST )
274 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
276 else if( sampling == BOX_THEN_LINEAR )
278 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
280 else if( sampling == NO_FILTER )
282 mSamplingMode = SamplingMode::NO_FILTER;
284 else if( sampling == DONT_CARE )
286 mSamplingMode = SamplingMode::DONT_CARE;
288 else if( sampling == DEFAULT )
290 mSamplingMode = SamplingMode::DEFAULT;
294 DALI_ASSERT_ALWAYS("Unknown sampling mode");
298 int desiredWidth = 0;
299 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
300 if( desiredWidthValue )
302 desiredWidthValue->Get( desiredWidth );
305 int desiredHeight = 0;
306 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
307 if( desiredHeightValue )
309 desiredHeightValue->Get( desiredHeight );
312 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
315 // remove old renderer if exit
316 if( mImpl->mRenderer )
318 if( actor ) //remove old renderer from actor
320 actor.RemoveRenderer( mImpl->mRenderer );
322 if( !oldImageUrl.empty() ) //clean old renderer from cache
324 CleanCache( oldImageUrl );
328 // if actor is on stage, create new renderer and apply to actor
329 if( actor && actor.OnStage() )
335 void ImageRenderer::SetSize( const Vector2& size )
337 ControlRenderer::SetSize( size );
340 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
344 naturalSize.x = mImage.GetWidth();
345 naturalSize.y = mImage.GetHeight();
348 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
350 naturalSize.x = mDesiredSize.GetWidth();
351 naturalSize.y = mDesiredSize.GetHeight();
354 else if( !mImageUrl.empty() )
356 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
357 naturalSize.x = dimentions.GetWidth();
358 naturalSize.y = dimentions.GetHeight();
362 naturalSize = Vector2::ZERO;
365 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
367 ControlRenderer::SetClipRect( clipRect );
370 void ImageRenderer::SetOffset( const Vector2& offset )
374 Renderer ImageRenderer::CreateRenderer() const
379 if( !mImpl->mCustomShader )
381 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
382 shader = GetImageShader(mFactoryCache);
386 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
387 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
389 shader = GetImageShader(mFactoryCache);
393 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
394 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
395 mImpl->mCustomShader->mHints );
399 Material material = Material::New( shader );
400 return Renderer::New( geometry, material );
403 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
405 if( imageUrl.empty() )
410 mImageUrl = imageUrl;
411 mImpl->mRenderer.Reset();
413 if( !mImpl->mCustomShader )
415 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
416 if( !mImpl->mRenderer )
418 Material material = mAtlasManager.Add(mTextureRect, imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
421 Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
422 mImpl->mRenderer = Renderer::New( geometry, material );
423 SetTextureRectUniform(mTextureRect);
425 else // big image, atlasing is not applied
427 mImpl->mRenderer = CreateRenderer();
428 mTextureRect = FULL_TEXTURE_RECT;
429 SetTextureRectUniform(mTextureRect);
431 ResourceImage image = Dali::ResourceImage::New( imageUrl );
432 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
433 Material material = mImpl->mRenderer.GetMaterial();
434 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
437 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
441 Property::Value textureRect = mImpl->mRenderer.GetProperty( mImpl->mRenderer.GetPropertyIndex(TEXTURE_RECT_UNIFORM_NAME) );
442 textureRect.Get( mTextureRect );
444 mImpl->mFlags |= Impl::IS_FROM_CACHE;
448 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
449 mImpl->mRenderer = CreateRenderer();
450 ResourceImage resourceImage = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
451 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
452 ApplyImageToSampler( resourceImage );
454 // custom shader with the default image vertex shader
455 if( mImpl->mCustomShader->mVertexShader.empty() )
457 mTextureRect = FULL_TEXTURE_RECT;
458 SetTextureRectUniform( mTextureRect );
463 void ImageRenderer::InitializeRenderer( const Image& image )
465 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
472 mImpl->mRenderer = CreateRenderer();
473 ApplyImageToSampler( image );
475 // default shader or custom shader with the default image vertex shader
476 if( !mImpl->mCustomShader || mImpl->mCustomShader->mVertexShader.empty() )
478 mTextureRect = FULL_TEXTURE_RECT;
479 SetTextureRectUniform( mTextureRect );
484 void ImageRenderer::DoSetOnStage( Actor& actor )
486 if( !mImageUrl.empty() )
488 InitializeRenderer( mImageUrl );
492 InitializeRenderer( mImage );
496 void ImageRenderer::DoSetOffStage( Actor& actor )
498 //If we own the image then make sure we release it when we go off stage
499 if( !mImageUrl.empty() )
501 actor.RemoveRenderer( mImpl->mRenderer );
502 CleanCache(mImageUrl);
508 actor.RemoveRenderer( mImpl->mRenderer );
509 mImpl->mRenderer.Reset();
513 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
516 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
517 if( !mImageUrl.empty() )
519 map.Insert( IMAGE_URL_NAME, mImageUrl );
520 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
521 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
525 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
526 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
528 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
531 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
535 switch( mFittingMode )
537 case Dali::FittingMode::FIT_HEIGHT:
539 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
542 case Dali::FittingMode::FIT_WIDTH:
544 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
547 case Dali::FittingMode::SCALE_TO_FILL:
549 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
552 case Dali::FittingMode::SHRINK_TO_FIT:
554 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
559 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
564 switch( mSamplingMode )
566 case Dali::SamplingMode::BOX:
568 map.Insert( IMAGE_SAMPLING_MODE, BOX );
571 case Dali::SamplingMode::NEAREST:
573 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
576 case Dali::SamplingMode::LINEAR:
578 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
581 case Dali::SamplingMode::BOX_THEN_LINEAR:
583 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
586 case Dali::SamplingMode::BOX_THEN_NEAREST:
588 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
591 case Dali::SamplingMode::NO_FILTER:
593 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
596 case Dali::SamplingMode::DONT_CARE:
598 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
603 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
609 Shader ImageRenderer::GetImageShader( RendererFactoryCache& factoryCache )
611 Shader shader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
614 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
615 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
620 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
622 if( mImageUrl != imageUrl )
624 std::string oldImageUrl = mImageUrl;
625 mImageUrl = imageUrl;
627 mFittingMode = fittingMode;
628 mSamplingMode = samplingMode;
631 if( mImpl->mRenderer )
633 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
635 //remove old renderer
638 actor.RemoveRenderer( mImpl->mRenderer );
642 if( !oldImageUrl.empty() )
644 CleanCache(oldImageUrl);
647 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
652 else // if renderer is not from cache, reuse the same renderer and only change the texture
654 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
655 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
656 ApplyImageToSampler( image );
662 void ImageRenderer::SetImage( Actor& actor, const Image& image )
664 if( mImage != image )
668 if( mImpl->mRenderer )
670 if( GetIsFromCache() ) // if renderer is from cache, remove the old one
672 //remove old renderer
675 actor.RemoveRenderer( mImpl->mRenderer );
679 if( !mImageUrl.empty() )
681 CleanCache(mImageUrl);
685 if( actor && actor.OnStage() ) // if actor on stage, create a new renderer and apply to actor
690 else // if renderer is not from cache, reuse the same renderer and only change the texture
692 ApplyImageToSampler( image );
697 mDesiredSize = ImageDimensions();
698 mFittingMode = FittingMode::DEFAULT;
699 mSamplingMode = SamplingMode::DEFAULT;
703 void ImageRenderer::ApplyImageToSampler( const Image& image )
707 Material material = mImpl->mRenderer.GetMaterial();
710 int index = material.GetTextureIndex( TEXTURE_UNIFORM_NAME );
713 material.SetTextureImage( index, image );
717 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
722 void ImageRenderer::OnImageLoaded( ResourceImage image )
724 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
726 Image brokenImage = RendererFactory::GetBrokenRendererImage();
727 if( mImpl->mRenderer )
729 ApplyImageToSampler( brokenImage );
734 void ImageRenderer::SetTextureRectUniform( const Vector4& textureRect )
736 if( mImpl->mRenderer )
738 // Register/Set property.
739 mImpl->mRenderer.RegisterProperty( TEXTURE_RECT_UNIFORM_NAME, textureRect );
743 void ImageRenderer::CleanCache(const std::string& url)
745 Material material = mImpl->mRenderer.GetMaterial();
746 mImpl->mRenderer.Reset();
747 if( mFactoryCache.CleanRendererCache( url ) )
749 mAtlasManager.Remove( material, mTextureRect );
753 } // namespace Internal
755 } // namespace Toolkit