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 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( const Property::Map& propertyMap )
203 Property::Value* imageURLValue = propertyMap.Find( IMAGE_URL_NAME );
206 imageURLValue->Get( mImageUrl );
207 if( !mImageUrl.empty() )
209 SetCachedRendererKey( mImageUrl );
213 Property::Value* fittingValue = propertyMap.Find( IMAGE_FITTING_MODE );
217 fittingValue->Get( fitting );
219 mFittingMode = FittingMode::DEFAULT;
220 if( fitting == SHRINK_TO_FIT )
222 mFittingMode = FittingMode::SHRINK_TO_FIT;
224 else if( fitting == SCALE_TO_FILL )
226 mFittingMode = FittingMode::SCALE_TO_FILL;
228 else if( fitting == FIT_WIDTH )
230 mFittingMode = FittingMode::FIT_WIDTH;
232 else if( fitting == FIT_HEIGHT )
234 mFittingMode = FittingMode::FIT_HEIGHT;
236 else if( fitting == DEFAULT )
238 mFittingMode = FittingMode::DEFAULT;
242 DALI_ASSERT_ALWAYS("Unknown fitting mode");
246 Property::Value* samplingValue = propertyMap.Find( IMAGE_SAMPLING_MODE );
249 std::string sampling;
250 samplingValue->Get( sampling );
252 mSamplingMode = SamplingMode::DEFAULT;
253 if( sampling == BOX )
255 mSamplingMode = SamplingMode::BOX;
257 else if( sampling == NEAREST )
259 mSamplingMode = SamplingMode::NEAREST;
261 else if( sampling == LINEAR )
263 mSamplingMode = SamplingMode::LINEAR;
265 else if( sampling == BOX_THEN_NEAREST )
267 mSamplingMode = SamplingMode::BOX_THEN_NEAREST;
269 else if( sampling == BOX_THEN_LINEAR )
271 mSamplingMode = SamplingMode::BOX_THEN_LINEAR;
273 else if( sampling == NO_FILTER )
275 mSamplingMode = SamplingMode::NO_FILTER;
277 else if( sampling == DONT_CARE )
279 mSamplingMode = SamplingMode::DONT_CARE;
281 else if( sampling == DEFAULT )
283 mSamplingMode = SamplingMode::DEFAULT;
287 DALI_ASSERT_ALWAYS("Unknown sampling mode");
291 int desiredWidth = 0;
292 Property::Value* desiredWidthValue = propertyMap.Find( IMAGE_DESIRED_WIDTH );
293 if( desiredWidthValue )
295 desiredWidthValue->Get( desiredWidth );
298 int desiredHeight = 0;
299 Property::Value* desiredHeightValue = propertyMap.Find( IMAGE_DESIRED_HEIGHT );
300 if( desiredHeightValue )
302 desiredHeightValue->Get( desiredHeight );
305 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
309 void ImageRenderer::SetSize( const Vector2& size )
311 ControlRenderer::SetSize( size );
314 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
318 naturalSize.x = mImage.GetWidth();
319 naturalSize.y = mImage.GetHeight();
322 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
324 naturalSize.x = mDesiredSize.GetWidth();
325 naturalSize.y = mDesiredSize.GetHeight();
328 else if( !mImageUrl.empty() )
330 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
331 naturalSize.x = dimentions.GetWidth();
332 naturalSize.y = dimentions.GetHeight();
336 naturalSize = Vector2::ZERO;
339 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
341 ControlRenderer::SetClipRect( clipRect );
344 void ImageRenderer::SetOffset( const Vector2& offset )
348 void ImageRenderer::InitializeRenderer( Renderer& renderer )
352 if( !mImpl->mCustomShader )
354 geometry = CreateGeometry( mFactoryCache, ImageDimensions( 1, 1 ) );
356 shader = mFactoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
359 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
360 mFactoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
365 geometry = CreateGeometry( mFactoryCache, mImpl->mCustomShader->mGridSize );
367 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
369 shader = mFactoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
372 shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
373 mFactoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, shader );
378 shader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
379 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
380 mImpl->mCustomShader->mHints );
386 Material material = Material::New( shader );
387 renderer = Renderer::New( geometry, material );
391 renderer.SetGeometry( geometry );
392 Material material = renderer.GetMaterial();
395 material.SetShader( shader );
400 void ImageRenderer::DoSetOnStage( Actor& actor )
402 if( !mImageUrl.empty() && !mImage )
404 Dali::ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
405 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
407 mImage = resourceImage;
410 ApplyImageToSampler();
413 void ImageRenderer::DoSetOffStage( Actor& actor )
415 //If we own the image then make sure we release it when we go off stage
416 if( !mImageUrl.empty() )
422 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
425 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
426 if( !mImageUrl.empty() )
428 map.Insert( IMAGE_URL_NAME, mImageUrl );
429 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
430 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
434 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
435 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
437 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
440 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
444 switch( mFittingMode )
446 case Dali::FittingMode::FIT_HEIGHT:
448 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
451 case Dali::FittingMode::FIT_WIDTH:
453 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
456 case Dali::FittingMode::SCALE_TO_FILL:
458 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
461 case Dali::FittingMode::SHRINK_TO_FIT:
463 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
468 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
473 switch( mSamplingMode )
475 case Dali::SamplingMode::BOX:
477 map.Insert( IMAGE_SAMPLING_MODE, BOX );
480 case Dali::SamplingMode::NEAREST:
482 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
485 case Dali::SamplingMode::LINEAR:
487 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
490 case Dali::SamplingMode::BOX_THEN_LINEAR:
492 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
495 case Dali::SamplingMode::BOX_THEN_NEAREST:
497 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
500 case Dali::SamplingMode::NO_FILTER:
502 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
505 case Dali::SamplingMode::DONT_CARE:
507 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
512 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
518 void ImageRenderer::SetImage( const std::string& imageUrl )
520 SetImage( imageUrl, 0, 0, Dali::FittingMode::DEFAULT, Dali::SamplingMode::DEFAULT );
523 void ImageRenderer::SetImage( const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
525 if( mImageUrl != imageUrl )
527 mImageUrl = imageUrl;
528 SetCachedRendererKey( mImageUrl );
529 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
530 mFittingMode = fittingMode;
531 mSamplingMode = samplingMode;
533 if( !mImageUrl.empty() && mImpl->mIsOnStage )
535 Dali::ResourceImage resourceImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
536 resourceImage.LoadingFinishedSignal().Connect( this, &ImageRenderer::OnImageLoaded );
537 mImage = resourceImage;
539 ApplyImageToSampler();
548 void ImageRenderer::SetImage( Image image )
550 if( mImage != image )
553 mDesiredSize = ImageDimensions();
554 mFittingMode = FittingMode::DEFAULT;
555 mSamplingMode = SamplingMode::DEFAULT;
558 if( mImage && mImpl->mIsOnStage )
560 ApplyImageToSampler();
565 Image ImageRenderer::GetImage() const
570 void ImageRenderer::ApplyImageToSampler()
574 Material material = mImpl->mRenderer.GetMaterial();
577 int index = material.GetTextureIndex(TEXTURE_UNIFORM_NAME);
580 material.SetTextureImage( index, mImage );
584 material.AddTexture( mImage,TEXTURE_UNIFORM_NAME );
589 void ImageRenderer::OnImageLoaded( ResourceImage image )
591 if( image.GetLoadingState() == Dali::ResourceLoadingFailed )
593 mImage = RendererFactory::GetBrokenRendererImage();
594 if( mImpl->mIsOnStage )
596 ApplyImageToSampler();
601 } // namespace Internal
603 } // namespace Toolkit