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()
192 mFittingMode( FittingMode::DEFAULT ),
193 mSamplingMode( SamplingMode::DEFAULT )
197 ImageRenderer::~ImageRenderer()
201 void ImageRenderer::DoInitialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap )
203 Initialize(factoryCache);
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 );
310 void ImageRenderer::SetSize( const Vector2& size )
312 ControlRenderer::SetSize( size );
315 void ImageRenderer::GetNaturalSize( Vector2& naturalSize ) const
319 naturalSize.x = mImage.GetWidth();
320 naturalSize.y = mImage.GetHeight();
323 else if( mDesiredSize.GetWidth()>0 && mDesiredSize.GetHeight()>0)
325 naturalSize.x = mDesiredSize.GetWidth();
326 naturalSize.y = mDesiredSize.GetHeight();
329 else if( !mImageUrl.empty() )
331 ImageDimensions dimentions = ResourceImage::GetImageSize( mImageUrl );
332 naturalSize.x = dimentions.GetWidth();
333 naturalSize.y = dimentions.GetHeight();
337 naturalSize = Vector2::ZERO;
340 void ImageRenderer::SetClipRect( const Rect<int>& clipRect )
342 ControlRenderer::SetClipRect( clipRect );
345 void ImageRenderer::SetOffset( const Vector2& offset )
349 void ImageRenderer::DoSetOnStage( Actor& actor )
351 if( !mImageUrl.empty() && !mImage )
353 mImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
356 ApplyImageToSampler();
359 void ImageRenderer::DoSetOffStage( Actor& actor )
361 //If we own the image then make sure we release it when we go off stage
362 if( !mImageUrl.empty() )
368 void ImageRenderer::DoCreatePropertyMap( Property::Map& map ) const
371 map.Insert( RENDERER_TYPE, RENDERER_TYPE_VALUE );
372 if( !mImageUrl.empty() )
374 map.Insert( IMAGE_URL_NAME, mImageUrl );
375 map.Insert( IMAGE_DESIRED_WIDTH, mDesiredSize.GetWidth() );
376 map.Insert( IMAGE_DESIRED_HEIGHT, mDesiredSize.GetHeight() );
380 map.Insert( IMAGE_DESIRED_WIDTH, static_cast<int>(mImage.GetWidth()) );
381 map.Insert( IMAGE_DESIRED_HEIGHT, static_cast<int>(mImage.GetHeight()) );
383 ResourceImage resourceImage = ResourceImage::DownCast(mImage);
386 map.Insert( IMAGE_URL_NAME, resourceImage.GetUrl() );
390 switch( mFittingMode )
392 case Dali::FittingMode::FIT_HEIGHT:
394 map.Insert( IMAGE_FITTING_MODE, FIT_HEIGHT );
397 case Dali::FittingMode::FIT_WIDTH:
399 map.Insert( IMAGE_FITTING_MODE, FIT_WIDTH );
402 case Dali::FittingMode::SCALE_TO_FILL:
404 map.Insert( IMAGE_FITTING_MODE, SCALE_TO_FILL );
407 case Dali::FittingMode::SHRINK_TO_FIT:
409 map.Insert( IMAGE_FITTING_MODE, SHRINK_TO_FIT );
414 map.Insert( IMAGE_FITTING_MODE, DEFAULT );
419 switch( mSamplingMode )
421 case Dali::SamplingMode::BOX:
423 map.Insert( IMAGE_SAMPLING_MODE, BOX );
426 case Dali::SamplingMode::NEAREST:
428 map.Insert( IMAGE_SAMPLING_MODE, NEAREST );
431 case Dali::SamplingMode::LINEAR:
433 map.Insert( IMAGE_SAMPLING_MODE, LINEAR );
436 case Dali::SamplingMode::BOX_THEN_LINEAR:
438 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_LINEAR );
441 case Dali::SamplingMode::BOX_THEN_NEAREST:
443 map.Insert( IMAGE_SAMPLING_MODE, BOX_THEN_NEAREST );
446 case Dali::SamplingMode::NO_FILTER:
448 map.Insert( IMAGE_SAMPLING_MODE, NO_FILTER );
451 case Dali::SamplingMode::DONT_CARE:
453 map.Insert( IMAGE_SAMPLING_MODE, DONT_CARE );
458 map.Insert( IMAGE_SAMPLING_MODE, DEFAULT );
464 void ImageRenderer::Initialize( RendererFactoryCache& factoryCache )
466 if( !mImpl->mCustomShader )
468 mImpl->mGeometry = CreateGeometry( factoryCache, ImageDimensions( 1, 1 ) );
470 mImpl->mShader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
472 if( !mImpl->mShader )
474 mImpl->mShader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
475 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, mImpl->mShader );
480 mImpl->mGeometry = CreateGeometry( factoryCache, mImpl->mCustomShader->mGridSize );
482 if( mImpl->mCustomShader->mVertexShader.empty() && mImpl->mCustomShader->mFragmentShader.empty() )
484 mImpl->mShader = factoryCache.GetShader( RendererFactoryCache::IMAGE_SHADER );
486 if( !mImpl->mShader )
488 mImpl->mShader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
489 factoryCache.SaveShader( RendererFactoryCache::IMAGE_SHADER, mImpl->mShader );
494 mImpl->mShader = Shader::New( mImpl->mCustomShader->mVertexShader.empty() ? VERTEX_SHADER : mImpl->mCustomShader->mVertexShader,
495 mImpl->mCustomShader->mFragmentShader.empty() ? FRAGMENT_SHADER : mImpl->mCustomShader->mFragmentShader,
496 mImpl->mCustomShader->mHints );
500 if( mImpl->mRenderer )
502 mImpl->mRenderer.SetGeometry( mImpl->mGeometry );
503 Material material = mImpl->mRenderer.GetMaterial();
506 material.SetShader( mImpl->mShader );
511 void ImageRenderer::SetImage( const std::string& imageUrl )
513 SetImage( imageUrl, 0, 0, Dali::FittingMode::DEFAULT, Dali::SamplingMode::DEFAULT );
516 void ImageRenderer::SetImage( const std::string& imageUrl, int desiredWidth, int desiredHeight, Dali::FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode )
518 if( mImageUrl != imageUrl )
520 mImageUrl = imageUrl;
521 mDesiredSize = ImageDimensions( desiredWidth, desiredHeight );
522 mFittingMode = fittingMode;
523 mSamplingMode = samplingMode;
525 if( !mImageUrl.empty() && mImpl->mIsOnStage )
527 mImage = Dali::ResourceImage::New( mImageUrl, mDesiredSize, mFittingMode, mSamplingMode );
528 ApplyImageToSampler();
537 void ImageRenderer::SetImage( Image image )
539 if( mImage != image )
542 mDesiredSize = ImageDimensions();
543 mFittingMode = FittingMode::DEFAULT;
544 mSamplingMode = SamplingMode::DEFAULT;
547 if( mImage && mImpl->mIsOnStage )
549 ApplyImageToSampler();
554 Image ImageRenderer::GetImage() const
559 void ImageRenderer::ApplyImageToSampler()
563 Material material = mImpl->mRenderer.GetMaterial();
566 for( std::size_t i = 0; i < material.GetNumberOfSamplers(); ++i )
568 Sampler sampler = material.GetSamplerAt( i );
569 if( sampler.GetUniformName() == TEXTURE_UNIFORM_NAME )
571 sampler.SetImage( mImage );
576 Sampler sampler = Sampler::New( mImage, TEXTURE_UNIFORM_NAME );
577 material.AddSampler( sampler );
582 } // namespace Internal
584 } // namespace Toolkit