2 * Copyright (c) 2022 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 "gradient-visual.h"
22 #include <dali/devel-api/rendering/renderer-devel.h>
23 #include <dali/devel-api/scripting/enum-helper.h>
24 #include <dali/devel-api/scripting/scripting.h>
25 #include <dali/integration-api/debug.h>
26 #include <dali/public-api/common/dali-vector.h>
27 #include <dali/public-api/object/property-array.h>
31 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
32 #include <dali-toolkit/internal/visuals/gradient/linear-gradient.h>
33 #include <dali-toolkit/internal/visuals/gradient/radial-gradient.h>
34 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
35 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
37 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
38 #include <dali-toolkit/public-api/visuals/gradient-visual-properties.h>
39 #include <dali-toolkit/public-api/visuals/visual-properties.h>
49 const int CUSTOM_PROPERTY_COUNT(11); // 5 transform properties + alignment + corner/border
51 DALI_ENUM_TO_STRING_TABLE_BEGIN(UNITS)
52 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::Units, OBJECT_BOUNDING_BOX)
53 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::Units, USER_SPACE)
54 DALI_ENUM_TO_STRING_TABLE_END(UNITS)
56 DALI_ENUM_TO_STRING_TABLE_BEGIN(SPREAD_METHOD)
57 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, PAD)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, REFLECT)
59 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, REPEAT)
60 DALI_ENUM_TO_STRING_TABLE_END(SPREAD_METHOD)
63 const char* const UNIFORM_ALIGNMENT_MATRIX_NAME("uAlignmentMatrix");
65 // default offset value
66 const unsigned int DEFAULT_OFFSET_MINIMUM = 0.0f;
67 const unsigned int DEFAULT_OFFSET_MAXIMUM = 1.0f;
69 VisualFactoryCache::ShaderType SHADER_TYPE_TABLE[16] =
71 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
72 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
73 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
74 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
75 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE,
76 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
77 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
78 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
79 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
80 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
81 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
82 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
83 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE,
84 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
85 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
86 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
89 // enum of required list when we select shader
90 enum GradientVisualRequireFlag
93 ROUNDED_CORNER = 1 << 0,
99 Dali::WrapMode::Type GetWrapMode(Toolkit::GradientVisual::SpreadMethod::Type spread)
103 case Toolkit::GradientVisual::SpreadMethod::REPEAT:
105 return Dali::WrapMode::REPEAT;
107 case Toolkit::GradientVisual::SpreadMethod::REFLECT:
109 return Dali::WrapMode::MIRRORED_REPEAT;
111 case Toolkit::GradientVisual::SpreadMethod::PAD:
114 return Dali::WrapMode::CLAMP_TO_EDGE;
119 } // unnamed namespace
121 GradientVisualPtr GradientVisual::New(VisualFactoryCache& factoryCache, const Property::Map& properties)
123 GradientVisualPtr gradientVisualPtr(new GradientVisual(factoryCache));
124 gradientVisualPtr->SetProperties(properties);
125 gradientVisualPtr->Initialize();
126 return gradientVisualPtr;
129 GradientVisual::GradientVisual(VisualFactoryCache& factoryCache)
130 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::GRADIENT),
131 mGradientType(LINEAR),
134 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
137 GradientVisual::~GradientVisual()
141 void GradientVisual::DoSetProperties(const Property::Map& propertyMap)
143 Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
145 Property::Value* unitsValue = propertyMap.Find(Toolkit::GradientVisual::Property::UNITS, UNITS_NAME);
148 Scripting::GetEnumerationProperty(*unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits);
151 mGradientType = Type::LINEAR;
152 if(propertyMap.Find(Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME))
154 mGradientType = Type::RADIAL;
157 if(NewGradient(mGradientType, propertyMap))
159 mGradient->SetGradientUnits(gradientUnits);
160 mGradientTransform = mGradient->GetAlignmentTransform();
164 DALI_LOG_ERROR("Fail to provide valid properties to create a GradientVisual object\n");
168 void GradientVisual::OnSetTransform()
172 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
176 void GradientVisual::DoSetOnScene(Actor& actor)
178 actor.AddRenderer(mImpl->mRenderer);
180 // Gradient Visual generated and ready to display
181 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
184 void GradientVisual::UpdateShader()
188 Shader shader = GenerateShader();
189 mImpl->mRenderer.SetShader(shader);
193 void GradientVisual::DoCreatePropertyMap(Property::Map& map) const
196 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::GRADIENT);
197 map.Insert(Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits());
198 map.Insert(Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod());
200 const Vector<Gradient::GradientStop>& stops(mGradient->GetStops());
201 Property::Array offsets;
202 Property::Array colors;
203 for(unsigned int i = 0; i < stops.Count(); i++)
205 offsets.PushBack(stops[i].mOffset);
206 if(EqualsZero(stops[i].mStopColor.a))
208 colors.PushBack(Vector4::ZERO);
212 colors.PushBack(Vector4(stops[i].mStopColor.r / stops[i].mStopColor.a,
213 stops[i].mStopColor.g / stops[i].mStopColor.a,
214 stops[i].mStopColor.b / stops[i].mStopColor.a,
215 stops[i].mStopColor.a));
219 map.Insert(Toolkit::GradientVisual::Property::STOP_OFFSET, offsets);
220 map.Insert(Toolkit::GradientVisual::Property::STOP_COLOR, colors);
222 if(&typeid(*mGradient) == &typeid(LinearGradient))
224 LinearGradient* gradient = static_cast<LinearGradient*>(mGradient.Get());
225 map.Insert(Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition());
226 map.Insert(Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition());
228 else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
230 RadialGradient* gradient = static_cast<RadialGradient*>(mGradient.Get());
231 map.Insert(Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter());
232 map.Insert(Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius());
236 void GradientVisual::DoCreateInstancePropertyMap(Property::Map& map) const
241 void GradientVisual::OnInitialize()
243 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
244 Shader shader = GenerateShader();
246 //Set up the texture set
247 TextureSet textureSet = TextureSet::New();
248 Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
249 textureSet.SetTexture(0u, lookupTexture);
250 Dali::WrapMode::Type wrap = GetWrapMode(mGradient->GetSpreadMethod());
251 Sampler sampler = Sampler::New();
252 sampler.SetWrapMode(wrap, wrap);
253 textureSet.SetSampler(0u, sampler);
255 mImpl->mRenderer = Renderer::New(geometry, shader);
256 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
257 mImpl->mRenderer.SetTextures(textureSet);
259 // If opaque and then no need to have blending
262 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::OFF);
265 mImpl->mRenderer.RegisterUniqueProperty(UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform);
267 //Register transform properties
268 mImpl->mTransform.RegisterUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
271 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
273 if(gradientType == Type::LINEAR)
275 Property::Value* startPositionValue = propertyMap.Find(Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME);
276 Property::Value* endPositionValue = propertyMap.Find(Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME);
277 Vector2 startPosition;
280 if(startPositionValue && startPositionValue->Get(startPosition) && endPositionValue && endPositionValue->Get(endPosition))
282 mGradient = new LinearGradient(startPosition, endPosition);
289 else // type==Type::RADIAL
291 Property::Value* centerValue = propertyMap.Find(Toolkit::GradientVisual::Property::CENTER, CENTER_NAME);
292 Property::Value* radiusValue = propertyMap.Find(Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME);
295 if(centerValue && centerValue->Get(center) && radiusValue && radiusValue->Get(radius))
297 mGradient = new RadialGradient(center, radius);
305 unsigned int numValidStop = 0u;
306 Property::Value* stopOffsetValue = propertyMap.Find(Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME);
307 Property::Value* stopColorValue = propertyMap.Find(Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME);
310 Vector<float> offsetArray;
311 Property::Array* colorArray = stopColorValue->GetArray();
314 GetStopOffsets(stopOffsetValue, offsetArray);
315 unsigned int numStop = offsetArray.Count() < colorArray->Count() ? offsetArray.Count() : colorArray->Count();
317 for(unsigned int i = 0; i < numStop; i++)
319 if((colorArray->GetElementAt(i)).Get(color))
321 mGradient->AddStop(offsetArray[i], Vector4(color.r * color.a, color.g * color.a, color.b * color.a, color.a));
323 if(!Equals(color.a, 1.0f, Math::MACHINE_EPSILON_1))
332 if(numValidStop < 1u) // no valid stop
337 Property::Value* spread = propertyMap.Find(Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME);
338 // The default spread method is PAD. Only need to set new spread if it's anything else.
341 Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
342 if(Scripting::GetEnumerationProperty(*spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod))
344 mGradient->SetSpreadMethod(spreadMethod);
351 Shader GradientVisual::GenerateShader() const
353 bool userspaceUnit = (mGradient->GetGradientUnits() == Toolkit::GradientVisual::Units::USER_SPACE);
354 bool roundedCorner = IsRoundedCornerRequired();
355 bool borderline = IsBorderlineRequired();
356 bool radialGradient = (mGradientType == Type::RADIAL);
358 int shaderTypeFlag = GradientVisualRequireFlag::DEFAULT;
361 shaderTypeFlag |= GradientVisualRequireFlag::ROUNDED_CORNER;
365 shaderTypeFlag |= GradientVisualRequireFlag::BORDERLINE;
369 shaderTypeFlag |= GradientVisualRequireFlag::USER_SPACE;
373 shaderTypeFlag |= GradientVisualRequireFlag::RADIAL;
376 VisualFactoryCache::ShaderType shaderType = SHADER_TYPE_TABLE[shaderTypeFlag];
377 Shader shader = mFactoryCache.GetShader(shaderType);
380 std::string vertexShaderPrefixList;
381 std::string fragmentShaderPrefixList;
385 vertexShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER 1\n";
386 fragmentShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER 1\n";
390 vertexShaderPrefixList += "#define IS_REQUIRED_BORDERLINE 1\n";
391 fragmentShaderPrefixList += "#define IS_REQUIRED_BORDERLINE 1\n";
395 fragmentShaderPrefixList += "#define RADIAL 1\n";
399 vertexShaderPrefixList += "#define USER_SPACE 1\n";
402 shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + vertexShaderPrefixList + SHADER_GRADIENT_VISUAL_SHADER_VERT.data(),
403 Dali::Shader::GetFragmentShaderPrefix() + fragmentShaderPrefixList + SHADER_GRADIENT_VISUAL_SHADER_FRAG.data());
404 mFactoryCache.SaveShader(shaderType, shader);
410 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
412 if(value) // Only check valve type if a valid Property has been passed in
414 switch(value->GetType())
416 case Property::VECTOR2:
420 stopOffsets.PushBack(offset2.x);
421 stopOffsets.PushBack(offset2.y);
424 case Property::VECTOR3:
428 stopOffsets.PushBack(offset3.x);
429 stopOffsets.PushBack(offset3.y);
430 stopOffsets.PushBack(offset3.z);
433 case Property::VECTOR4:
437 stopOffsets.PushBack(offset4.x);
438 stopOffsets.PushBack(offset4.y);
439 stopOffsets.PushBack(offset4.z);
440 stopOffsets.PushBack(offset4.w);
443 case Property::ARRAY:
445 const Property::Array* offsetArray = value->GetArray();
448 unsigned int numStop = offsetArray->Count();
450 for(unsigned int i = 0; i < numStop; i++)
452 if(offsetArray->GetElementAt(i).Get(offset))
454 stopOffsets.PushBack(offset);
462 DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
468 if(stopOffsets.Empty())
470 // Set default offset if none set by Property system, need a minimum and maximum
471 stopOffsets.PushBack(DEFAULT_OFFSET_MINIMUM);
472 stopOffsets.PushBack(DEFAULT_OFFSET_MAXIMUM);
476 } // namespace Internal
478 } // namespace Toolkit