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 if( mImpl->mRenderer )
317 //remove old renderer
320 actor.RemoveRenderer( mImpl->mRenderer );
324 if( !oldImageUrl.empty() )
326 CleanCache( oldImageUrl );
329 //Initialize the renderer
330 if( !mImageUrl.empty() )
332 InitializeRenderer( mImageUrl );
336 InitializeRenderer( mImage );
339 //add the new renderer to the actor
340 if( actor && mImpl->mRenderer )
342 actor.AddRenderer( mImpl->mRenderer );
347 void ImageRenderer::SetSize( const Vector2& size )
349 ControlRenderer::SetSize( size );
352 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
356 naturalSize.x = mImage.GetWidth();
357 naturalSize.y = mImage.GetHeight();
360 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
362 naturalSize.x = mDesiredSize.GetWidth();
363 naturalSize.y = mDesiredSize.GetHeight();
366 else if( !mImageUrl.empty() )
368 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
369 naturalSize.x = dimentions.GetWidth();
370 naturalSize.y = dimentions.GetHeight();
374 naturalSize = Vector2::ZERO;
377 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
379 ControlRenderer::SetClipRect( clipRect );
382 void ImageRenderer::SetOffset( const Vector2& offset )
386 Renderer ImageRenderer::CreateRenderer() const
391 if( !mImpl->mCustomShader )
393 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
394 shader = GetImageShader(mFactoryCache);
398 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
399 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
401 shader = GetImageShader(mFactoryCache);
405 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
406 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
407 mImpl->mCustomShader->mHints );
411 Material material = Material::New( shader );
412 return Renderer::New( geometry, material );
415 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
417 if( mImageUrl.empty() )
419 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
423 mImpl->mRenderer.Reset();
424 if( !mImpl->mCustomShader )
426 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
427 if( !mImpl->mRenderer )
429 Material material = mAtlasManager.Add(mTextureRect, imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
432 Geometry geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
433 mImpl->mRenderer = Renderer::New( geometry, material );
434 SetTextureRectUniform(mTextureRect);
436 else // big image, atlasing is not applied
438 mImpl->mRenderer = CreateRenderer();
439 SetTextureRectUniform(FULL_TEXTURE_RECT);
441 ResourceImage image = Dali::ResourceImage::New( imageUrl );
442 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
443 Material material = mImpl->mRenderer.GetMaterial();
444 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
447 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
451 Property::Value textureRect = mImpl->mRenderer.GetProperty( mImpl->mRenderer.GetPropertyIndex(TEXTURE_RECT_UNIFORM_NAME) );
452 textureRect.Get( mTextureRect );
454 mImpl->mFlags |= Impl::IS_FROM_CACHE;
458 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
459 mImpl->mRenderer = CreateRenderer();
460 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
461 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
462 ApplyImageToSampler( image );
466 void ImageRenderer::InitializeRenderer( const Image& image )
468 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
475 mImpl->mRenderer = CreateRenderer();
476 ApplyImageToSampler( image );
477 SetTextureRectUniform( FULL_TEXTURE_RECT );
481 void ImageRenderer::DoSetOnStage( Actor& actor )
483 if( !mImageUrl.empty() )
485 InitializeRenderer( mImageUrl );
489 InitializeRenderer( mImage );
492 if( !GetIsFromCache() )
494 Image image = mImage;
495 if( !mImageUrl.empty() )
497 ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
498 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
499 image = resourceImage;
501 // Set value to the uTextureRect uniform
502 SetTextureRectUniform( FULL_TEXTURE_RECT );
505 ApplyImageToSampler( image );
509 void ImageRenderer::DoSetOffStage( Actor& actor )
511 //If we own the image then make sure we release it when we go off stage
512 if( !mImageUrl.empty() )
514 actor.RemoveRenderer( mImpl->mRenderer );
515 CleanCache(mImageUrl);
521 actor.RemoveRenderer( mImpl->mRenderer );
522 mImpl->mRenderer.Reset();
526 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
529 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
530 if( !mImageUrl.empty() )
532 map.Insert( IMAGE_URL_NAME, mImageUrl );
533 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
534 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
538 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
539 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
541 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
544 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
548 switch( mFittingMode )
550 case Dali::FittingMode::FIT_HEIGHT:
552 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
555 case Dali::FittingMode::FIT_WIDTH:
557 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
560 case Dali::FittingMode::SCALE_TO_FILL:
562 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
565 case Dali::FittingMode::SHRINK_TO_FIT:
567 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
572 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
577 switch( mSamplingMode )
579 case Dali::SamplingMode::BOX:
581 map.Insert( IMAGE_SAMPLING_MODE, BOX );
584 case Dali::SamplingMode::NEAREST:
586 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
589 case Dali::SamplingMode::LINEAR:
591 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
594 case Dali::SamplingMode::BOX_THEN_LINEAR:
596 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
599 case Dali::SamplingMode::BOX_THEN_NEAREST:
601 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
604 case Dali::SamplingMode::NO_FILTER:
606 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
609 case Dali::SamplingMode::DONT_CARE:
611 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
616 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
622 Shader ImageRenderer::GetImageShader( RendererFactoryCache& factoryCache )
624 Shader shader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
627 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
628 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
633 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, ImageDimensions size, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
636 mFittingMode = fittingMode;
637 mSamplingMode = samplingMode;
639 if( mImageUrl != imageUrl )
641 if( mImpl->mRenderer )
643 if( GetIsFromCache() )
645 //remove old renderer
648 actor.RemoveRenderer( mImpl->mRenderer );
652 if( !mImageUrl.empty() )
654 CleanCache(mImageUrl);
657 //Initialize the renderer
658 InitializeRenderer( imageUrl );
660 //add the new renderer to the actor
661 if( actor && mImpl->mRenderer )
663 actor.AddRenderer( mImpl->mRenderer );
668 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
669 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
670 ApplyImageToSampler( image );
674 mImageUrl = imageUrl;
680 void ImageRenderer::SetImage( Actor& actor, const Image& image )
682 if( mImage != image )
684 if( mImpl->mRenderer )
686 if( GetIsFromCache() )
688 //remove old renderer
691 actor.RemoveRenderer( mImpl->mRenderer );
695 if( !mImageUrl.empty() )
697 CleanCache(mImageUrl);
700 //Initialize the renderer
701 InitializeRenderer( image );
703 //add the new renderer to the actor
704 if( actor && mImpl->mRenderer )
706 actor.AddRenderer( mImpl->mRenderer );
711 ApplyImageToSampler( image );
714 SetTextureRectUniform( FULL_TEXTURE_RECT );
718 mDesiredSize = ImageDimensions();
719 mFittingMode = FittingMode::DEFAULT;
720 mSamplingMode = SamplingMode::DEFAULT;
724 void ImageRenderer::ApplyImageToSampler( const Image& image )
728 Material material = mImpl->mRenderer.GetMaterial();
731 int index = material.GetTextureIndex( TEXTURE_UNIFORM_NAME );
734 material.SetTextureImage( index, image );
738 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
743 void ImageRenderer::OnImageLoaded( ResourceImage image )
745 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
747 Image brokenImage = RendererFactory::GetBrokenRendererImage();
748 if( mImpl->mRenderer )
750 ApplyImageToSampler( brokenImage );
755 void ImageRenderer::SetTextureRectUniform( const Vector4& textureRect )
757 if( mImpl->mRenderer )
759 Property::Index index = mImpl->mRenderer.GetPropertyIndex( TEXTURE_RECT_UNIFORM_NAME );
760 if( index == Property::INVALID_INDEX )
762 index = mImpl->mRenderer.RegisterProperty( TEXTURE_RECT_UNIFORM_NAME, textureRect );
766 mImpl->mRenderer.SetProperty( index, textureRect );
771 void ImageRenderer::CleanCache(const std::string& url)
773 Material material = mImpl->mRenderer.GetMaterial();
774 mImpl->mRenderer.Reset();
775 if( mFactoryCache.CleanRendererCache( url ) )
777 mAtlasManager.Remove( material, mTextureRect );
781 } // namespace Internal
783 } // namespace Toolkit