Merge "Fix logging for debug build." into devel/master
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / visuals / npatch / npatch-visual.cpp
1 /*
2  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
3  *
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  *
16  */
17
18 // CLASS HEADER
19 #include "npatch-visual.h"
20
21 // EXTERNAL INCLUDES
22 #include <dali/devel-api/object/handle-devel.h>
23 #include <dali/devel-api/images/texture-set-image.h>
24 #include <dali/devel-api/adaptor-framework/image-loading.h>
25 #include <dali/integration-api/debug.h>
26
27 // INTERNAL INCLUDES
28 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
29 #include <dali-toolkit/devel-api/visuals/image-visual-properties-devel.h>
30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
31 #include <dali-toolkit/internal/visuals/npatch-loader.h>
32 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
34 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
35 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
37
38 namespace Dali
39 {
40
41 namespace Toolkit
42 {
43
44 namespace Internal
45 {
46
47 namespace
48 {
49 const char* VERTEX_SHADER = DALI_COMPOSE_SHADER(
50   attribute mediump vec2 aPosition;\n
51   varying mediump vec2 vTexCoord;\n
52   varying mediump vec2 vMaskTexCoord;\n
53   uniform highp   mat4 uMvpMatrix;\n
54   uniform mediump vec3 uSize;\n
55   uniform mediump vec2 uNinePatchFactorsX[ FACTOR_SIZE_X ];\n
56   uniform mediump vec2 uNinePatchFactorsY[ FACTOR_SIZE_Y ];\n
57   \n
58
59   // Visual size and offset
60   uniform mediump vec2 offset;\n
61   uniform mediump vec2 size;\n
62   uniform mediump vec4 offsetSizeMode;\n
63   uniform mediump vec2 origin;\n
64   uniform mediump vec2 anchorPoint;\n
65   uniform mediump vec2 extraSize;\n
66
67   void main()\n
68   {\n
69     mediump vec2 fixedFactor  = vec2( uNinePatchFactorsX[ int( ( aPosition.x + 1.0 ) * 0.5 ) ].x, uNinePatchFactorsY[ int( ( aPosition.y + 1.0 ) * 0.5 ) ].x );\n
70     mediump vec2 stretch      = vec2( uNinePatchFactorsX[ int( ( aPosition.x       ) * 0.5 ) ].y, uNinePatchFactorsY[ int( ( aPosition.y       ) * 0.5 ) ].y );\n
71     \n
72     mediump vec2 fixedTotal   = vec2( uNinePatchFactorsX[ FACTOR_SIZE_X - 1 ].x, uNinePatchFactorsY[ FACTOR_SIZE_Y - 1 ].x );\n
73     mediump vec2 stretchTotal = vec2( uNinePatchFactorsX[ FACTOR_SIZE_X - 1 ].y, uNinePatchFactorsY[ FACTOR_SIZE_Y - 1 ].y );\n
74     \n
75     vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw ) + extraSize;\n
76     vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
77     \n
78     mediump vec4 gridPosition = vec4( fixedFactor + ( visualSize.xy - fixedTotal ) * stretch / stretchTotal, 0.0, 1.0 );\n
79     mediump vec4 vertexPosition = gridPosition;\n
80     vertexPosition.xy -= visualSize.xy * vec2( 0.5, 0.5 );\n
81     vertexPosition.xy += anchorPoint*visualSize + (visualOffset + origin)*uSize.xy;\n
82     vertexPosition = uMvpMatrix * vertexPosition;\n
83     \n
84     vTexCoord = ( fixedFactor + stretch ) / ( fixedTotal + stretchTotal );\n
85     vMaskTexCoord = gridPosition.xy / visualSize;\n
86     \n
87     gl_Position = vertexPosition;\n
88   }\n
89 );
90
91 const char* VERTEX_SHADER_3X3 = DALI_COMPOSE_SHADER(
92     attribute mediump vec2 aPosition;\n
93     varying mediump vec2 vTexCoord;\n
94     varying mediump vec2 vMaskTexCoord;\n
95     uniform highp   mat4 uMvpMatrix;\n
96     uniform mediump vec3 uSize;\n
97     uniform mediump vec2 uFixed[ 3 ];\n
98     uniform mediump vec2 uStretchTotal;\n
99     \n
100     //Visual size and offset
101     uniform mediump vec2 offset;\n
102     uniform mediump vec2 size;\n
103     uniform mediump vec4 offsetSizeMode;\n
104     uniform mediump vec2 origin;\n
105     uniform mediump vec2 anchorPoint;\n
106     uniform mediump vec2 extraSize;\n
107     \n
108     void main()\n
109     {\n
110       vec2 visualSize = mix(uSize.xy*size, size, offsetSizeMode.zw ) + extraSize;\n
111       vec2 visualOffset = mix( offset, offset/uSize.xy, offsetSizeMode.xy);\n
112       \n
113       mediump vec2 size         = visualSize.xy;\n
114       \n
115       mediump vec2 fixedFactor  = vec2( uFixed[ int( ( aPosition.x + 1.0 ) * 0.5 ) ].x, uFixed[ int( ( aPosition.y  + 1.0 ) * 0.5 ) ].y );\n
116       mediump vec2 stretch      = floor( aPosition * 0.5 );\n
117       mediump vec2 fixedTotal   = uFixed[ 2 ];\n
118       \n
119       mediump vec4 gridPosition = vec4( fixedFactor + ( size - fixedTotal ) * stretch, 0.0, 1.0 );\n
120       mediump vec4 vertexPosition = gridPosition;\n
121       vertexPosition.xy -= size * vec2( 0.5, 0.5 );\n
122       vertexPosition.xy += anchorPoint*size + (visualOffset + origin)*uSize.xy;\n
123       \n
124       vertexPosition = uMvpMatrix * vertexPosition;\n
125       \n
126       vTexCoord = ( fixedFactor + stretch * uStretchTotal ) / ( fixedTotal + uStretchTotal );\n
127       \n
128       vMaskTexCoord = gridPosition.xy / size;\n
129       gl_Position = vertexPosition;\n
130     }\n
131 );
132
133 const char* FRAGMENT_SHADER = DALI_COMPOSE_SHADER(
134   varying mediump vec2 vTexCoord;\n
135   uniform sampler2D sTexture;\n
136   uniform lowp vec4 uColor;\n
137   uniform lowp vec3 mixColor;\n
138   uniform lowp float preMultipliedAlpha;\n
139   \n
140   void main()\n
141   {\n
142     gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
143   }\n
144 );
145
146 const char* FRAGMENT_MASK_SHADER = DALI_COMPOSE_SHADER(
147   varying mediump vec2 vTexCoord;\n
148   varying mediump vec2 vMaskTexCoord;\n
149   uniform sampler2D sTexture;\n
150   uniform sampler2D sMask;\n
151   uniform lowp vec4 uColor;\n
152   uniform lowp vec3 mixColor;\n
153   uniform lowp float preMultipliedAlpha;\n
154   uniform mediump float auxiliaryImageAlpha;\n
155   \n
156   void main()\n
157   {\n
158       // Where mask image is transparent, all of background image must show through.
159       // where mask image is opaque, only mask should be shown
160       // where mask is translucent, less of background should be shown.
161       // auxiliaryImageAlpha controls how much of mask is visible
162
163       mediump vec4 color = texture2D( sTexture, vTexCoord );\n
164       mediump vec4 mask  = texture2D( sMask, vMaskTexCoord );\n
165
166       mediump vec3 mixedColor = color.rgb * mix( 1.0-mask.a, 1.0, 1.0-auxiliaryImageAlpha)
167                                 + mask.rgb*mask.a * auxiliaryImageAlpha;\n
168       gl_FragColor = vec4(mixedColor,1.0) * uColor * vec4( mixColor, 1.0 );\n
169   }\n
170 );
171
172 /**
173  * @brief Creates the geometry formed from the vertices and indices
174  *
175  * @param[in]  vertices             The vertices to generate the geometry from
176  * @param[in]  indices              The indices to generate the geometry from
177  * @return The geometry formed from the vertices and indices
178  */
179 Geometry GenerateGeometry( const Vector< Vector2 >& vertices, const Vector< unsigned short >& indices )
180 {
181   Property::Map vertexFormat;
182   vertexFormat[ "aPosition" ] = Property::VECTOR2;
183   PropertyBuffer vertexPropertyBuffer = PropertyBuffer::New( vertexFormat );
184   if( vertices.Size() > 0 )
185   {
186     vertexPropertyBuffer.SetData( &vertices[ 0 ], vertices.Size() );
187   }
188
189   // Create the geometry object
190   Geometry geometry = Geometry::New();
191   geometry.AddVertexBuffer( vertexPropertyBuffer );
192   if( indices.Size() > 0 )
193   {
194     geometry.SetIndexBuffer( &indices[ 0 ], indices.Size() );
195   }
196
197
198   return geometry;
199 }
200
201 /**
202  * @brief Adds the indices to form a quad composed off two triangles where the indices are organised in a grid
203  *
204  * @param[out] indices     The indices to add to
205  * @param[in]  rowIdx      The row index to start the quad
206  * @param[in]  nextRowIdx  The index to the next row
207  */
208 void AddQuadIndices( Vector< unsigned short >& indices, unsigned int rowIdx, unsigned int nextRowIdx )
209 {
210   indices.PushBack( rowIdx );
211   indices.PushBack( nextRowIdx + 1 );
212   indices.PushBack( rowIdx + 1 );
213
214   indices.PushBack( rowIdx );
215   indices.PushBack( nextRowIdx );
216   indices.PushBack( nextRowIdx + 1 );
217 }
218
219 void AddVertex( Vector< Vector2 >& vertices, unsigned int x, unsigned int y )
220 {
221   vertices.PushBack( Vector2( x, y ) );
222 }
223
224 void RegisterStretchProperties( Renderer& renderer, const char * uniformName, const NPatchLoader::StretchRanges& stretchPixels, uint16_t imageExtent)
225 {
226   uint16_t prevEnd = 0;
227   uint16_t prevFix = 0;
228   uint16_t prevStretch = 0;
229   unsigned int i = 1;
230   for( NPatchLoader::StretchRanges::ConstIterator it = stretchPixels.Begin(); it != stretchPixels.End(); ++it, ++i )
231   {
232     uint16_t start = it->GetX();
233     uint16_t end = it->GetY();
234
235     uint16_t fix = prevFix + start - prevEnd;
236     uint16_t stretch = prevStretch + end - start;
237
238     std::stringstream uniform;
239     uniform << uniformName << "[" << i << "]";
240     renderer.RegisterProperty( uniform.str(), Vector2( fix, stretch ) );
241
242     prevEnd = end;
243     prevFix = fix;
244     prevStretch = stretch;
245   }
246
247   {
248     prevFix += imageExtent - prevEnd;
249     std::stringstream uniform;
250     uniform << uniformName << "[" << i << "]";
251     renderer.RegisterProperty( uniform.str(), Vector2( prevFix, prevStretch ) );
252   }
253 }
254
255 } //unnamed namespace
256
257 /////////////////NPatchVisual////////////////
258
259 NPatchVisualPtr NPatchVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties )
260 {
261   NPatchVisualPtr nPatchVisual( new NPatchVisual( factoryCache ) );
262   nPatchVisual->mImageUrl = imageUrl;
263   nPatchVisual->SetProperties( properties );
264
265   return nPatchVisual;
266 }
267
268 NPatchVisualPtr NPatchVisual::New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl )
269 {
270   NPatchVisualPtr nPatchVisual( new NPatchVisual( factoryCache ) );
271   nPatchVisual->mImageUrl = imageUrl;
272
273   return nPatchVisual;
274 }
275
276 void NPatchVisual::LoadImages()
277 {
278   TextureManager& textureManager = mFactoryCache.GetTextureManager();
279   bool synchronousLoading = mImpl->mFlags & Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
280
281   if( NPatchLoader::UNINITIALIZED_ID == mId && mImageUrl.IsLocalResource() )
282   {
283     bool preMultiplyOnLoad = IsPreMultipliedAlphaEnabled() && !mImpl->mCustomShader ? true : false;
284     mId = mLoader.Load( textureManager, this, mImageUrl.GetUrl(), mBorder, preMultiplyOnLoad, synchronousLoading );
285
286     const NPatchLoader::Data* data;
287     if( mLoader.GetNPatchData( mId, data ) && data->loadCompleted )
288     {
289       EnablePreMultipliedAlpha( preMultiplyOnLoad );
290     }
291   }
292
293   if( !mAuxiliaryPixelBuffer && mAuxiliaryUrl.IsValid() && mAuxiliaryUrl.IsLocalResource() )
294   {
295     // Load the auxiliary image
296     auto preMultiplyOnLoading = TextureManager::MultiplyOnLoad::LOAD_WITHOUT_MULTIPLY;
297     mAuxiliaryPixelBuffer = textureManager.LoadPixelBuffer( mAuxiliaryUrl, Dali::ImageDimensions(), FittingMode::DEFAULT,
298                                                             SamplingMode::BOX_THEN_LINEAR, synchronousLoading,
299                                                             this, true, preMultiplyOnLoading );
300   }
301 }
302
303 void NPatchVisual::GetNaturalSize( Vector2& naturalSize )
304 {
305   naturalSize.x = 0u;
306   naturalSize.y = 0u;
307
308   // load now if not already loaded
309   const NPatchLoader::Data* data;
310   if( mLoader.GetNPatchData( mId, data ) && data->loadCompleted )
311   {
312     naturalSize.x = data->croppedWidth;
313     naturalSize.y = data->croppedHeight;
314   }
315   else
316   {
317     if( mImageUrl.IsValid() )
318     {
319       ImageDimensions dimensions = Dali::GetOriginalImageSize( mImageUrl.GetUrl() );
320       if( dimensions != ImageDimensions( 0, 0 ) )
321       {
322         naturalSize.x = dimensions.GetWidth();
323         naturalSize.y = dimensions.GetHeight();
324       }
325     }
326   }
327
328   if( mAuxiliaryPixelBuffer )
329   {
330     naturalSize.x = std::max( naturalSize.x, float(mAuxiliaryPixelBuffer.GetWidth()) );
331     naturalSize.y = std::max( naturalSize.y, float(mAuxiliaryPixelBuffer.GetHeight()) );
332   }
333 }
334
335 void NPatchVisual::DoSetProperties( const Property::Map& propertyMap )
336 {
337   // URL is already passed in via constructor
338
339   Property::Value* borderOnlyValue = propertyMap.Find( Toolkit::ImageVisual::Property::BORDER_ONLY, BORDER_ONLY );
340   if( borderOnlyValue )
341   {
342     borderOnlyValue->Get( mBorderOnly );
343   }
344
345   Property::Value* borderValue = propertyMap.Find( Toolkit::ImageVisual::Property::BORDER, BORDER );
346   if( borderValue && ! borderValue->Get( mBorder ) ) // If value exists and is rect, just set mBorder
347   {
348     // Not a rect so try vector4
349     Vector4 border;
350     if( borderValue->Get( border ) )
351     {
352       mBorder.left = static_cast< int >( border.x );
353       mBorder.right = static_cast< int >( border.y );
354       mBorder.bottom = static_cast< int >( border.z );
355       mBorder.top = static_cast< int >( border.w );
356     }
357   }
358
359   Property::Value* auxImage = propertyMap.Find( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, AUXILIARY_IMAGE_NAME );
360   if( auxImage )
361   {
362     std::string url;
363     if( auxImage->Get( url ) )
364     {
365       mAuxiliaryUrl = url;
366     }
367   }
368
369   Property::Value* auxImageAlpha = propertyMap.Find( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, AUXILIARY_IMAGE_ALPHA_NAME );
370   if( auxImageAlpha )
371   {
372     auxImageAlpha->Get( mAuxiliaryImageAlpha );
373   }
374
375   Property::Value* synchronousLoading = propertyMap.Find( Toolkit::ImageVisual::Property::SYNCHRONOUS_LOADING, SYNCHRONOUS_LOADING );
376   if( synchronousLoading )
377   {
378     bool sync = false;
379     synchronousLoading->Get( sync );
380     if( sync )
381     {
382       mImpl->mFlags |= Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
383     }
384     else
385     {
386       mImpl->mFlags &= ~Impl::IS_SYNCHRONOUS_RESOURCE_LOADING;
387     }
388   }
389 }
390
391 void NPatchVisual::DoSetOnStage( Actor& actor )
392 {
393   // load when first go on stage
394   LoadImages();
395
396   const NPatchLoader::Data* data;
397   if( mLoader.GetNPatchData( mId, data ) )
398   {
399     Geometry geometry = CreateGeometry();
400     Shader shader = CreateShader();
401
402     mImpl->mRenderer = Renderer::New( geometry, shader );
403
404     mPlacementActor = actor;
405     if( data->loadCompleted )
406     {
407       ApplyTextureAndUniforms();
408       actor.AddRenderer( mImpl->mRenderer );
409       mPlacementActor.Reset();
410
411       // npatch loaded and ready to display
412       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
413     }
414   }
415 }
416
417 void NPatchVisual::DoSetOffStage( Actor& actor )
418 {
419   actor.RemoveRenderer( mImpl->mRenderer );
420   mImpl->mRenderer.Reset();
421   mPlacementActor.Reset();
422 }
423
424 void NPatchVisual::OnSetTransform()
425 {
426   if( mImpl->mRenderer )
427   {
428     mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
429   }
430 }
431
432 void NPatchVisual::DoCreatePropertyMap( Property::Map& map ) const
433 {
434   map.Clear();
435   map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::N_PATCH );
436   map.Insert( Toolkit::ImageVisual::Property::URL, mImageUrl.GetUrl() );
437   map.Insert( Toolkit::ImageVisual::Property::BORDER_ONLY, mBorderOnly );
438   map.Insert( Toolkit::ImageVisual::Property::BORDER, mBorder );
439
440   if( mAuxiliaryUrl.IsValid() )
441   {
442     map.Insert( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, mAuxiliaryUrl.GetUrl() );
443     map.Insert( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, mAuxiliaryImageAlpha );
444   }
445 }
446
447 void NPatchVisual::DoCreateInstancePropertyMap( Property::Map& map ) const
448 {
449   if( mAuxiliaryUrl.IsValid() )
450   {
451     map.Insert( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE, mAuxiliaryUrl.GetUrl() );
452     map.Insert( Toolkit::DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA, mAuxiliaryImageAlpha );
453   }
454 }
455
456 NPatchVisual::NPatchVisual( VisualFactoryCache& factoryCache )
457 : Visual::Base( factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::N_PATCH ),
458   mPlacementActor(),
459   mLoader( factoryCache.GetNPatchLoader() ),
460   mImageUrl(),
461   mAuxiliaryUrl(),
462   mId( NPatchLoader::UNINITIALIZED_ID ),
463   mBorderOnly( false ),
464   mBorder(),
465   mAuxiliaryImageAlpha( 0.0f )
466 {
467   EnablePreMultipliedAlpha( mFactoryCache.GetPreMultiplyOnLoad() );
468 }
469
470 NPatchVisual::~NPatchVisual()
471 {
472 }
473
474 Geometry NPatchVisual::CreateGeometry()
475 {
476   Geometry geometry;
477   const NPatchLoader::Data* data;
478   if( mLoader.GetNPatchData( mId, data ) && data->loadCompleted )
479   {
480     if( data->stretchPixelsX.Size() == 1 && data->stretchPixelsY.Size() == 1 )
481     {
482       if( DALI_UNLIKELY( mBorderOnly ) )
483       {
484         geometry = GetNinePatchGeometry( VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY );
485       }
486       else
487       {
488         geometry = GetNinePatchGeometry( VisualFactoryCache::NINE_PATCH_GEOMETRY );
489       }
490     }
491     else if( data->stretchPixelsX.Size() > 0 || data->stretchPixelsY.Size() > 0)
492     {
493       Uint16Pair gridSize( 2 * data->stretchPixelsX.Size() + 1,  2 * data->stretchPixelsY.Size() + 1 );
494       geometry = !mBorderOnly ? CreateGridGeometry( gridSize ) : CreateBorderGeometry( gridSize );
495     }
496   }
497   else
498   {
499     // no N patch data so use default geometry
500     geometry = GetNinePatchGeometry( VisualFactoryCache::NINE_PATCH_GEOMETRY );
501   }
502   return geometry;
503 }
504
505 Shader NPatchVisual::CreateShader()
506 {
507   Shader shader;
508   const NPatchLoader::Data* data;
509   // 0 is either no data (load failed?) or no stretch regions on image
510   // for both cases we use the default shader
511   NPatchLoader::StretchRanges::SizeType xStretchCount = 0;
512   NPatchLoader::StretchRanges::SizeType yStretchCount = 0;
513
514   auto fragmentShader = mAuxiliaryPixelBuffer ? FRAGMENT_MASK_SHADER
515                                               : FRAGMENT_SHADER;
516   auto shaderType = mAuxiliaryPixelBuffer ? VisualFactoryCache::NINE_PATCH_MASK_SHADER
517                                           : VisualFactoryCache::NINE_PATCH_SHADER;
518
519   // ask loader for the regions
520   if( mLoader.GetNPatchData( mId, data ) )
521   {
522     xStretchCount = data->stretchPixelsX.Count();
523     yStretchCount = data->stretchPixelsY.Count();
524   }
525
526   if( DALI_LIKELY( !mImpl->mCustomShader ) )
527   {
528     if( DALI_LIKELY( ( xStretchCount == 1 && yStretchCount == 1 ) ||
529                      ( xStretchCount == 0 && yStretchCount == 0 ) ) )
530     {
531       shader = mFactoryCache.GetShader( shaderType );
532       if( DALI_UNLIKELY( !shader ) )
533       {
534         shader = Shader::New( VERTEX_SHADER_3X3, fragmentShader );
535         // Only cache vanilla 9 patch shaders
536         mFactoryCache.SaveShader( shaderType, shader );
537       }
538     }
539     else if( xStretchCount > 0 || yStretchCount > 0)
540     {
541       std::stringstream vertexShader;
542       vertexShader << "#define FACTOR_SIZE_X " << xStretchCount + 2 << "\n"
543                    << "#define FACTOR_SIZE_Y " << yStretchCount + 2 << "\n"
544                    << VERTEX_SHADER;
545
546       shader = Shader::New( vertexShader.str(), fragmentShader );
547     }
548   }
549   else
550   {
551     Dali::Shader::Hint::Value hints = Dali::Shader::Hint::NONE;
552
553     if( !mImpl->mCustomShader->mFragmentShader.empty() )
554     {
555       fragmentShader = mImpl->mCustomShader->mFragmentShader.c_str();
556     }
557     hints = mImpl->mCustomShader->mHints;
558
559     /* Apply Custom Vertex Shader only if image is 9-patch */
560     if( ( xStretchCount == 1 && yStretchCount == 1 ) ||
561         ( xStretchCount == 0 && yStretchCount == 0 ) )
562     {
563       const char* vertexShader = VERTEX_SHADER_3X3;
564
565       if( !mImpl->mCustomShader->mVertexShader.empty() )
566       {
567         vertexShader = mImpl->mCustomShader->mVertexShader.c_str();
568       }
569       shader = Shader::New( vertexShader, fragmentShader, hints );
570     }
571     else if( xStretchCount > 0 || yStretchCount > 0)
572     {
573       std::stringstream vertexShader;
574       vertexShader << "#define FACTOR_SIZE_X " << xStretchCount + 2 << "\n"
575                    << "#define FACTOR_SIZE_Y " << yStretchCount + 2 << "\n"
576                    << VERTEX_SHADER;
577
578       shader = Shader::New( vertexShader.str(), fragmentShader, hints );
579     }
580   }
581
582   return shader;
583 }
584
585 void NPatchVisual::ApplyTextureAndUniforms()
586 {
587   const NPatchLoader::Data* data;
588   TextureSet textureSet;
589
590   if( mLoader.GetNPatchData( mId, data ) && data->loadCompleted )
591   {
592     textureSet = data->textureSet;
593
594     if( data->stretchPixelsX.Size() == 1 && data->stretchPixelsY.Size() == 1 )
595     {
596       //special case for 9 patch
597       Uint16Pair stretchX = data->stretchPixelsX[ 0 ];
598       Uint16Pair stretchY = data->stretchPixelsY[ 0 ];
599
600       uint16_t stretchWidth = ( stretchX.GetY() >= stretchX.GetX() ) ? stretchX.GetY() - stretchX.GetX() : 0;
601       uint16_t stretchHeight = ( stretchY.GetY() >= stretchY.GetX() ) ? stretchY.GetY() - stretchY.GetX() : 0;
602
603       mImpl->mRenderer.RegisterProperty( "uFixed[0]", Vector2::ZERO );
604       mImpl->mRenderer.RegisterProperty( "uFixed[1]", Vector2( stretchX.GetX(), stretchY.GetX()) );
605       mImpl->mRenderer.RegisterProperty( "uFixed[2]", Vector2( data->croppedWidth - stretchWidth, data->croppedHeight - stretchHeight ) );
606       mImpl->mRenderer.RegisterProperty( "uStretchTotal", Vector2( stretchWidth, stretchHeight ) );
607     }
608     else
609     {
610       mImpl->mRenderer.RegisterProperty( "uNinePatchFactorsX[0]", Vector2::ZERO );
611       mImpl->mRenderer.RegisterProperty( "uNinePatchFactorsY[0]", Vector2::ZERO );
612
613       RegisterStretchProperties( mImpl->mRenderer, "uNinePatchFactorsX", data->stretchPixelsX, data->croppedWidth );
614       RegisterStretchProperties( mImpl->mRenderer, "uNinePatchFactorsY", data->stretchPixelsY, data->croppedHeight );
615     }
616   }
617   else
618   {
619     DALI_LOG_ERROR("The N patch image '%s' is not a valid N patch image\n", mImageUrl.GetUrl().c_str() );
620     textureSet = TextureSet::New();
621
622     Image croppedImage = mFactoryCache.GetBrokenVisualImage();
623     TextureSetImage( textureSet, 0u, croppedImage );
624     mImpl->mRenderer.RegisterProperty( "uFixed[0]", Vector2::ZERO );
625     mImpl->mRenderer.RegisterProperty( "uFixed[1]", Vector2::ZERO );
626     mImpl->mRenderer.RegisterProperty( "uFixed[2]", Vector2::ZERO );
627     mImpl->mRenderer.RegisterProperty( "uStretchTotal", Vector2( croppedImage.GetWidth(), croppedImage.GetHeight() ) );
628   }
629
630   if( mAuxiliaryPixelBuffer )
631   {
632     // If the auxiliary image is smaller than the un-stretched NPatch, use CPU resizing to enlarge it to the
633     // same size as the unstretched NPatch. This will give slightly higher quality results than just relying
634     // on GL interpolation alone.
635     if( mAuxiliaryPixelBuffer.GetWidth() < data->croppedWidth &&
636         mAuxiliaryPixelBuffer.GetHeight() < data->croppedHeight )
637     {
638       mAuxiliaryPixelBuffer.Resize( data->croppedWidth, data->croppedHeight );
639     }
640
641     // Note, this resets mAuxiliaryPixelBuffer handle
642     auto auxiliaryPixelData = Devel::PixelBuffer::Convert( mAuxiliaryPixelBuffer );
643
644     auto texture = Texture::New( TextureType::TEXTURE_2D,
645                                  auxiliaryPixelData.GetPixelFormat(), auxiliaryPixelData.GetWidth(),
646                                  auxiliaryPixelData.GetHeight() );
647     texture.Upload( auxiliaryPixelData );
648     textureSet.SetTexture( 1, texture );
649     DevelHandle::RegisterProperty( mImpl->mRenderer, DevelImageVisual::Property::AUXILIARY_IMAGE_ALPHA,
650                                    AUXILIARY_IMAGE_ALPHA_NAME, mAuxiliaryImageAlpha );
651   }
652   mImpl->mRenderer.SetTextures( textureSet );
653
654   // Register transform properties
655   mImpl->mTransform.RegisterUniforms( mImpl->mRenderer, Direction::LEFT_TO_RIGHT );
656 }
657
658 Geometry NPatchVisual::GetNinePatchGeometry( VisualFactoryCache::GeometryType subType )
659 {
660   Geometry geometry = mFactoryCache.GetGeometry( subType );
661   if( !geometry )
662   {
663     if( DALI_LIKELY( VisualFactoryCache::NINE_PATCH_GEOMETRY == subType ) )
664     {
665       geometry = CreateGridGeometry( Uint16Pair( 3, 3 ) );
666     }
667     else if( VisualFactoryCache::NINE_PATCH_BORDER_GEOMETRY == subType )
668     {
669       geometry = CreateBorderGeometry( Uint16Pair( 3, 3 ) );
670     }
671     mFactoryCache.SaveGeometry( subType, geometry );
672   }
673   return geometry;
674 }
675
676 Geometry NPatchVisual::CreateGridGeometry( Uint16Pair gridSize )
677 {
678   uint16_t gridWidth = gridSize.GetWidth();
679   uint16_t gridHeight = gridSize.GetHeight();
680
681   // Create vertices
682   Vector< Vector2 > vertices;
683   vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
684
685   for( int y = 0; y < gridHeight + 1; ++y )
686   {
687     for( int x = 0; x < gridWidth + 1; ++x )
688     {
689       AddVertex( vertices, x, y );
690     }
691   }
692
693   // Create indices
694   Vector< unsigned short > indices;
695   indices.Reserve( gridWidth * gridHeight * 6 );
696
697   unsigned int rowIdx     = 0;
698   unsigned int nextRowIdx = gridWidth + 1;
699   for( int y = 0; y < gridHeight; ++y, ++nextRowIdx, ++rowIdx )
700   {
701     for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
702     {
703       AddQuadIndices( indices, rowIdx, nextRowIdx );
704     }
705   }
706
707   return GenerateGeometry( vertices, indices );
708 }
709
710 Geometry NPatchVisual::CreateBorderGeometry( Uint16Pair gridSize )
711 {
712   uint16_t gridWidth = gridSize.GetWidth();
713   uint16_t gridHeight = gridSize.GetHeight();
714
715   // Create vertices
716   Vector< Vector2 > vertices;
717   vertices.Reserve( ( gridWidth + 1 ) * ( gridHeight + 1 ) );
718
719   //top
720   int y = 0;
721   for(; y < 2; ++y)
722   {
723     for( int x = 0; x < gridWidth + 1; ++x )
724     {
725       AddVertex( vertices, x, y );
726     }
727   }
728
729   for(; y < gridHeight - 1; ++y)
730   {
731     //left
732     AddVertex( vertices, 0, y );
733     AddVertex( vertices, 1, y );
734
735     //right
736     AddVertex( vertices, gridWidth - 1, y );
737     AddVertex( vertices, gridWidth, y );
738   }
739
740   //bottom
741   for(; y < gridHeight + 1; ++y)
742   {
743     for( int x = 0; x < gridWidth + 1; ++x )
744     {
745       AddVertex( vertices, x, y );
746     }
747   }
748
749   // Create indices
750   Vector< unsigned short > indices;
751   indices.Reserve( gridWidth * gridHeight * 6 );
752
753   //top
754   unsigned int rowIdx     = 0 ;
755   unsigned int nextRowIdx = gridWidth + 1;
756   for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
757   {
758     AddQuadIndices( indices, rowIdx, nextRowIdx );
759   }
760
761   if(gridHeight > 2)
762   {
763     rowIdx     = gridWidth + 1;
764     nextRowIdx = ( gridWidth + 1 ) * 2;
765
766     unsigned increment = gridWidth - 1;
767     if(gridHeight > 3)
768     {
769       increment = 2;
770       //second row left
771       AddQuadIndices( indices, rowIdx, nextRowIdx );
772
773       rowIdx     = gridWidth * 2;
774       nextRowIdx = ( gridWidth + 1 ) * 2 + 2;
775       //second row right
776       AddQuadIndices( indices, rowIdx, nextRowIdx );
777
778       //left and right
779       rowIdx     = nextRowIdx - 2;
780       nextRowIdx = rowIdx + 4;
781       for(int y = 2; y < 2*(gridHeight - 3); ++y, rowIdx += 2, nextRowIdx += 2)
782       {
783         AddQuadIndices( indices, rowIdx, nextRowIdx );
784       }
785     }
786
787     //second row left
788     AddQuadIndices( indices, rowIdx, nextRowIdx );
789
790     rowIdx     += increment;
791     nextRowIdx += gridWidth - 1;
792     //second row right
793     AddQuadIndices( indices, rowIdx, nextRowIdx );
794   }
795
796   //bottom
797   rowIdx     = nextRowIdx - gridWidth + 1;
798   nextRowIdx = rowIdx + gridWidth + 1;
799   for( int x = 0; x < gridWidth; ++x, ++nextRowIdx, ++rowIdx )
800   {
801     AddQuadIndices( indices, rowIdx, nextRowIdx );
802   }
803
804   return GenerateGeometry( vertices, indices );
805 }
806
807 void NPatchVisual::SetResource()
808 {
809   const NPatchLoader::Data* data;
810   if( mImpl->mRenderer && mLoader.GetNPatchData( mId, data ) )
811   {
812     Geometry geometry = CreateGeometry();
813     Shader shader = CreateShader();
814
815     mImpl->mRenderer.SetGeometry( geometry );
816     mImpl->mRenderer.SetShader( shader );
817
818     Actor actor = mPlacementActor.GetHandle();
819     if( actor )
820     {
821       ApplyTextureAndUniforms();
822       actor.AddRenderer( mImpl->mRenderer );
823       mPlacementActor.Reset();
824
825       // npatch loaded and ready to display
826       ResourceReady( Toolkit::Visual::ResourceStatus::READY );
827     }
828   }
829 }
830
831 void NPatchVisual::LoadComplete( bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied )
832 {
833   if( url.GetUrl() == mAuxiliaryUrl.GetUrl() )
834   {
835     mAuxiliaryPixelBuffer = pixelBuffer;
836     const NPatchLoader::Data* data;
837     if( mLoader.GetNPatchData( mId, data ) && data->loadCompleted )
838     {
839       SetResource();
840     }
841   }
842   else
843   {
844     if( loadSuccess )
845     {
846       mLoader.SetNPatchData( mId, pixelBuffer );
847       EnablePreMultipliedAlpha( preMultiplied );
848     }
849
850     if( mAuxiliaryPixelBuffer || !mAuxiliaryUrl.IsValid() )
851     {
852       SetResource();
853     }
854   }
855 }
856
857 } // namespace Internal
858
859 } // namespace Toolkit
860
861 } // namespace Dali