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("rendererType");
43 const char * const RENDERER_TYPE_VALUE("imageRenderer");
46 const char * const IMAGE_URL_NAME( "imageUrl" );
47 const char * const IMAGE_FITTING_MODE( "imageFittingMode" );
48 const char * const IMAGE_SAMPLING_MODE( "imageSamplingMode" );
49 const char * const IMAGE_DESIRED_WIDTH( "imageDesiredWidth" );
50 const char * const IMAGE_DESIRED_HEIGHT( "imageDesiredHeight" );
53 const char * const SHRINK_TO_FIT("shrinkToFit");
54 const char * const SCALE_TO_FILL("scaleToFill");
55 const char * const FIT_WIDTH("fitWidth");
56 const char * const FIT_HEIGHT("fitHeight");
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("boxThenNearest");
64 const char * const BOX_THEN_LINEAR("boxThenLinear");
65 const char * const NO_FILTER("noFilter");
66 const char * const DONT_CARE("dontCare");
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 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned int >& indices )
100 Property::Map vertexFormat;
101 vertexFormat[ "aPosition" ] = Property::VECTOR2;
102 PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat, vertices.Size() );
103 if( vertices.Size() > 0 )
105 vertexPropertyBuffer.SetData( &vertices[ 0 ] );
108 Property::Map indexFormat;
109 indexFormat[ "indices" ] = Property::INTEGER;
110 PropertyBuffer indexPropertyBuffer = PropertyBuffer::New( indexFormat, indices.Size() );
111 if( indices.Size() > 0 )
113 indexPropertyBuffer.SetData( &indices[ 0 ] );
116 // Create the geometry object
117 Geometry geometry = Geometry::New();
118 geometry.AddVertexBuffer( vertexPropertyBuffer );
119 geometry.SetIndexBuffer( indexPropertyBuffer );
120 geometry.SetGeometryType( Geometry::TRIANGLE_STRIP );
125 Geometry CreateGeometry( RendererFactoryCache& factoryCache, ImageDimensions gridSize )
129 if( gridSize == ImageDimensions( 1, 1 ) )
131 geometry = factoryCache.GetGeometry( RendererFactoryCache::QUAD_GEOMETRY );
134 geometry = factoryCache.CreateQuadGeometry();
135 factoryCache.SaveGeometry( RendererFactoryCache::QUAD_GEOMETRY, geometry );
140 uint16_t gridWidth = gridSize.GetWidth();
141 uint16_t gridHeight = gridSize.GetHeight();
144 Vector< Vector2 > vertices;
145 vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
147 for( int y = 0; y < gridHeight + 1; ++y )
149 for( int x = 0; x < gridWidth + 1; ++x )
151 vertices.PushBack( Vector2( (float)x/gridWidth - 0.5f, (float)y/gridHeight - 0.5f) );
156 Vector< unsigned int > indices;
157 indices.Reserve( (gridWidth+2)*gridHeight*2 - 2);
159 for( unsigned int row = 0u; row < gridHeight; ++row )
161 unsigned int rowStartIndex = row*(gridWidth+1u);
162 unsigned int nextRowStartIndex = rowStartIndex + gridWidth +1u;
164 if( row != 0u ) // degenerate index on non-first row
166 indices.PushBack( rowStartIndex );
169 for( unsigned int column = 0u; column < gridWidth+1u; column++) // main strip
171 indices.PushBack( rowStartIndex + column);
172 indices.PushBack( nextRowStartIndex + column);
175 if( row != gridHeight-1u ) // degenerate index on non-last row
177 indices.PushBack( nextRowStartIndex + gridWidth );
181 return GenerateGeometry( vertices, indices );
187 } //unnamed namespace
189 ImageRenderer::ImageRenderer( RendererFactoryCache& factoryCache )
190 : ControlRenderer( factoryCache ),
192 mFittingMode( FittingMode::DEFAULT ),
193 mSamplingMode( SamplingMode::DEFAULT )
197 ImageRenderer::~ImageRenderer()
201 void ImageRenderer::DoInitialize( Actor& actor, const Property::Map& propertyMap )
203 std::string oldImageUrl = mImageUrl;
205 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
208 imageURLValue->Get( mImageUrl );
209 if( !mImageUrl.empty() )
214 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
218 fittingValue->Get( fitting );
220 mFittingMode = FittingMode::DEFAULT;
221 if( fitting == SHRINK_TO_FIT )
223 mFittingMode = FittingMode::SHRINK_TO_FIT;
225 else if( fitting == SCALE_TO_FILL )
227 mFittingMode = FittingMode::SCALE_TO_FILL;
229 else if( fitting == FIT_WIDTH )
231 mFittingMode = FittingMode::FIT_WIDTH;
233 else if( fitting == FIT_HEIGHT )
235 mFittingMode = FittingMode::FIT_HEIGHT;
237 else if( fitting == DEFAULT )
239 mFittingMode = FittingMode::DEFAULT;
243 DALI_ASSERT_ALWAYS("Unknown fitting mode");
247 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
250 std::string sampling;
251 samplingValue->Get( sampling );
253 mSamplingMode = SamplingMode::DEFAULT;
254 if( sampling == BOX )
256 mSamplingMode = SamplingMode::BOX;
258 else if( sampling == NEAREST )
260 mSamplingMode = SamplingMode::NEAREST;
262 else if( sampling == LINEAR )
264 mSamplingMode = SamplingMode::LINEAR;
266 else if( sampling == BOX_THEN_NEAREST )
268 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
270 else if( sampling == BOX_THEN_LINEAR )
272 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
274 else if( sampling == NO_FILTER )
276 mSamplingMode = SamplingMode::NO_FILTER;
278 else if( sampling == DONT_CARE )
280 mSamplingMode = SamplingMode::DONT_CARE;
282 else if( sampling == DEFAULT )
284 mSamplingMode = SamplingMode::DEFAULT;
288 DALI_ASSERT_ALWAYS("Unknown sampling mode");
292 int desiredWidth = 0;
293 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
294 if( desiredWidthValue )
296 desiredWidthValue->Get( desiredWidth );
299 int desiredHeight = 0;
300 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
301 if( desiredHeightValue )
303 desiredHeightValue->Get( desiredHeight );
306 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
309 if( mImpl->mRenderer )
311 //remove old renderer
314 actor.RemoveRenderer( mImpl->mRenderer );
318 if( !oldImageUrl.empty() )
320 mFactoryCache.CleanRendererCache( oldImageUrl );
323 //Initialize the renderer
324 if( !mImageUrl.empty() )
326 InitializeRenderer( mImageUrl );
330 InitializeRenderer( mImage );
333 //add the new renderer to the actor
334 if( actor && mImpl->mRenderer )
336 actor.AddRenderer( mImpl->mRenderer );
341 void ImageRenderer::SetSize( const Vector2& size )
343 ControlRenderer::SetSize( size );
346 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
350 naturalSize.x = mImage.GetWidth();
351 naturalSize.y = mImage.GetHeight();
354 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
356 naturalSize.x = mDesiredSize.GetWidth();
357 naturalSize.y = mDesiredSize.GetHeight();
360 else if( !mImageUrl.empty() )
362 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
363 naturalSize.x = dimentions.GetWidth();
364 naturalSize.y = dimentions.GetHeight();
368 naturalSize = Vector2::ZERO;
371 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
373 ControlRenderer::SetClipRect( clipRect );
376 void ImageRenderer::SetOffset( const Vector2& offset )
380 Renderer ImageRenderer::CreateRenderer() const
385 if( !mImpl->mCustomShader )
387 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
388 shader = mFactoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
391 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
392 mFactoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
397 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
398 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
400 shader = mFactoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
403 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
404 mFactoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
409 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
410 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
411 mImpl->mCustomShader->mHints );
415 Material material = Material::New( shader );
416 return Renderer::New( geometry, material );
419 void ImageRenderer::InitializeRenderer( const std::string& imageUrl )
421 if( mImageUrl.empty() )
423 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
427 mImpl->mRenderer.Reset();
428 if( !mImpl->mCustomShader )
430 mImpl->mRenderer = mFactoryCache.GetRenderer( imageUrl );
431 if( !mImpl->mRenderer )
433 mImpl->mRenderer = CreateRenderer();
435 ResourceImage image = Dali::ResourceImage::New( imageUrl );
436 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
437 Material material = mImpl->mRenderer.GetMaterial();
438 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
440 mFactoryCache.SaveRenderer( imageUrl, mImpl->mRenderer );
442 mImpl->mFlags |= Impl::IS_FROM_CACHE;
446 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
447 mImpl->mRenderer = CreateRenderer();
448 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
449 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
450 ApplyImageToSampler( image );
454 void ImageRenderer::InitializeRenderer( const Image& image )
456 mImpl->mFlags &= ~Impl::IS_FROM_CACHE;
463 mImpl->mRenderer = CreateRenderer();
464 ApplyImageToSampler( image );
468 void ImageRenderer::DoSetOnStage( Actor& actor )
470 if( !mImageUrl.empty() )
472 InitializeRenderer( mImageUrl );
476 InitializeRenderer( mImage );
479 if( !GetIsFromCache() )
481 Image image = mImage;
482 if( !mImageUrl.empty() )
484 ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
485 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
486 image = resourceImage;
489 ApplyImageToSampler( image );
493 void ImageRenderer::DoSetOffStage( Actor& actor )
495 //If we own the image then make sure we release it when we go off stage
496 if( !mImageUrl.empty() )
498 //clean the renderer from the cache since it may no longer be in use
499 mFactoryCache.CleanRendererCache( mImageUrl );
505 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
508 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
509 if( !mImageUrl.empty() )
511 map.Insert( IMAGE_URL_NAME, mImageUrl );
512 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
513 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
517 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
518 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
520 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
523 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
527 switch( mFittingMode )
529 case Dali::FittingMode::FIT_HEIGHT:
531 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
534 case Dali::FittingMode::FIT_WIDTH:
536 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
539 case Dali::FittingMode::SCALE_TO_FILL:
541 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
544 case Dali::FittingMode::SHRINK_TO_FIT:
546 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
551 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
556 switch( mSamplingMode )
558 case Dali::SamplingMode::BOX:
560 map.Insert( IMAGE_SAMPLING_MODE, BOX );
563 case Dali::SamplingMode::NEAREST:
565 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
568 case Dali::SamplingMode::LINEAR:
570 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
573 case Dali::SamplingMode::BOX_THEN_LINEAR:
575 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
578 case Dali::SamplingMode::BOX_THEN_NEAREST:
580 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
583 case Dali::SamplingMode::NO_FILTER:
585 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
588 case Dali::SamplingMode::DONT_CARE:
590 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
595 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
601 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl )
603 SetImage( actor, imageUrl, 0, 0, Dali::FittingMode::DEFAULT, Dali::SamplingMode::DEFAULT );
606 void ImageRenderer::SetImage( Actor& actor, const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
608 if( mImageUrl != imageUrl )
610 if( mImpl->mRenderer )
612 if( GetIsFromCache() )
614 //remove old renderer
617 actor.RemoveRenderer( mImpl->mRenderer );
621 if( !mImageUrl.empty() )
623 mFactoryCache.CleanRendererCache( mImageUrl );
626 //Initialize the renderer
627 InitializeRenderer( imageUrl );
629 //add the new renderer to the actor
630 if( actor && mImpl->mRenderer )
632 actor.AddRenderer( mImpl->mRenderer );
637 ResourceImage image = Dali::ResourceImage::New( imageUrl, mDesiredSize, mFittingMode, mSamplingMode );
638 image.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
639 ApplyImageToSampler( image );
643 mImageUrl = imageUrl;
644 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
645 mFittingMode = fittingMode;
646 mSamplingMode = samplingMode;
651 void ImageRenderer::SetImage( Actor& actor, const Image& image )
653 if( mImage != image )
655 if( mImpl->mRenderer )
657 if( GetIsFromCache() )
659 //remove old renderer
662 actor.RemoveRenderer( mImpl->mRenderer );
666 if( !mImageUrl.empty() )
668 mFactoryCache.CleanRendererCache( mImageUrl );
671 //Initialize the renderer
672 InitializeRenderer( image );
674 //add the new renderer to the actor
675 if( actor && mImpl->mRenderer )
677 actor.AddRenderer( mImpl->mRenderer );
682 ApplyImageToSampler( image );
688 mDesiredSize = ImageDimensions();
689 mFittingMode = FittingMode::DEFAULT;
690 mSamplingMode = SamplingMode::DEFAULT;
694 void ImageRenderer::ApplyImageToSampler( const Image& image )
698 Material material = mImpl->mRenderer.GetMaterial();
701 int index = material.GetTextureIndex( TEXTURE_UNIFORM_NAME );
704 material.SetTextureImage( index, image );
708 material.AddTexture( image, TEXTURE_UNIFORM_NAME );
713 void ImageRenderer::OnImageLoaded( ResourceImage image )
715 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
717 Image image = RendererFactory::GetBrokenRendererImage();
718 if( mImpl->mRenderer )
720 ApplyImageToSampler( image );
725 } // namespace Internal
727 } // namespace Toolkit