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>
28 #include <dali/public-api/rendering/decorated-visual-renderer.h>
32 #include <dali-toolkit/internal/graphics/builtin-shader-extern-gen.h>
33 #include <dali-toolkit/internal/visuals/gradient/linear-gradient.h>
34 #include <dali-toolkit/internal/visuals/gradient/radial-gradient.h>
35 #include <dali-toolkit/internal/visuals/visual-base-data-impl.h>
36 #include <dali-toolkit/internal/visuals/visual-factory-cache.h>
37 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
38 #include <dali-toolkit/internal/visuals/visual-string-constants.h>
39 #include <dali-toolkit/public-api/visuals/gradient-visual-properties.h>
40 #include <dali-toolkit/public-api/visuals/visual-properties.h>
50 const int CUSTOM_PROPERTY_COUNT(1); // alignment
52 DALI_ENUM_TO_STRING_TABLE_BEGIN(UNITS)
53 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::Units, OBJECT_BOUNDING_BOX)
54 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::Units, USER_SPACE)
55 DALI_ENUM_TO_STRING_TABLE_END(UNITS)
57 DALI_ENUM_TO_STRING_TABLE_BEGIN(SPREAD_METHOD)
58 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, PAD)
59 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, REFLECT)
60 DALI_ENUM_TO_STRING_WITH_SCOPE(Toolkit::GradientVisual::SpreadMethod, REPEAT)
61 DALI_ENUM_TO_STRING_TABLE_END(SPREAD_METHOD)
64 const char* const UNIFORM_ALIGNMENT_MATRIX_NAME("uAlignmentMatrix");
66 // default offset value
67 const unsigned int DEFAULT_OFFSET_MINIMUM = 0.0f;
68 const unsigned int DEFAULT_OFFSET_MAXIMUM = 1.0f;
70 VisualFactoryCache::ShaderType SHADER_TYPE_TABLE[16] =
72 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX,
73 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_CORNER,
74 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_BORDERLINE,
75 VisualFactoryCache::GRADIENT_SHADER_LINEAR_BOUNDING_BOX_ROUNDED_BORDERLINE,
76 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE,
77 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_CORNER,
78 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_BORDERLINE,
79 VisualFactoryCache::GRADIENT_SHADER_LINEAR_USER_SPACE_ROUNDED_BORDERLINE,
80 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX,
81 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_CORNER,
82 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_BORDERLINE,
83 VisualFactoryCache::GRADIENT_SHADER_RADIAL_BOUNDING_BOX_ROUNDED_BORDERLINE,
84 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE,
85 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_CORNER,
86 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_BORDERLINE,
87 VisualFactoryCache::GRADIENT_SHADER_RADIAL_USER_SPACE_ROUNDED_BORDERLINE,
90 // enum of required list when we select shader
91 enum GradientVisualRequireFlag
94 ROUNDED_CORNER = 1 << 0,
100 Dali::WrapMode::Type GetWrapMode(Toolkit::GradientVisual::SpreadMethod::Type spread)
104 case Toolkit::GradientVisual::SpreadMethod::REPEAT:
106 return Dali::WrapMode::REPEAT;
108 case Toolkit::GradientVisual::SpreadMethod::REFLECT:
110 return Dali::WrapMode::MIRRORED_REPEAT;
112 case Toolkit::GradientVisual::SpreadMethod::PAD:
115 return Dali::WrapMode::CLAMP_TO_EDGE;
120 } // unnamed namespace
122 GradientVisualPtr GradientVisual::New(VisualFactoryCache& factoryCache, const Property::Map& properties)
124 GradientVisualPtr gradientVisualPtr(new GradientVisual(factoryCache));
125 gradientVisualPtr->SetProperties(properties);
126 gradientVisualPtr->Initialize();
127 return gradientVisualPtr;
130 GradientVisual::GradientVisual(VisualFactoryCache& factoryCache)
131 : Visual::Base(factoryCache, Visual::FittingMode::FILL, Toolkit::Visual::GRADIENT),
132 mGradientType(LINEAR),
135 mImpl->mFlags |= Impl::IS_PREMULTIPLIED_ALPHA;
138 GradientVisual::~GradientVisual()
142 void GradientVisual::DoSetProperties(const Property::Map& propertyMap)
144 Toolkit::GradientVisual::Units::Type gradientUnits = Toolkit::GradientVisual::Units::OBJECT_BOUNDING_BOX;
146 Property::Value* unitsValue = propertyMap.Find(Toolkit::GradientVisual::Property::UNITS, UNITS_NAME);
149 Scripting::GetEnumerationProperty(*unitsValue, UNITS_TABLE, UNITS_TABLE_COUNT, gradientUnits);
152 mGradientType = Type::LINEAR;
153 if(propertyMap.Find(Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME))
155 mGradientType = Type::RADIAL;
158 if(NewGradient(mGradientType, propertyMap))
160 mGradient->SetGradientUnits(gradientUnits);
161 mGradientTransform = mGradient->GetAlignmentTransform();
165 DALI_LOG_ERROR("Fail to provide valid properties to create a GradientVisual object\n");
169 void GradientVisual::OnSetTransform()
173 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
177 void GradientVisual::DoSetOnScene(Actor& actor)
179 actor.AddRenderer(mImpl->mRenderer);
181 // Gradient Visual generated and ready to display
182 ResourceReady(Toolkit::Visual::ResourceStatus::READY);
185 void GradientVisual::UpdateShader()
189 Shader shader = GenerateShader();
190 mImpl->mRenderer.SetShader(shader);
194 void GradientVisual::DoCreatePropertyMap(Property::Map& map) const
197 map.Insert(Toolkit::Visual::Property::TYPE, Toolkit::Visual::GRADIENT);
198 map.Insert(Toolkit::GradientVisual::Property::UNITS, mGradient->GetGradientUnits());
199 map.Insert(Toolkit::GradientVisual::Property::SPREAD_METHOD, mGradient->GetSpreadMethod());
201 const Vector<Gradient::GradientStop>& stops(mGradient->GetStops());
202 Property::Array offsets;
203 Property::Array colors;
204 for(unsigned int i = 0; i < stops.Count(); i++)
206 offsets.PushBack(stops[i].mOffset);
207 if(EqualsZero(stops[i].mStopColor.a))
209 colors.PushBack(Vector4::ZERO);
213 colors.PushBack(Vector4(stops[i].mStopColor.r / stops[i].mStopColor.a,
214 stops[i].mStopColor.g / stops[i].mStopColor.a,
215 stops[i].mStopColor.b / stops[i].mStopColor.a,
216 stops[i].mStopColor.a));
220 map.Insert(Toolkit::GradientVisual::Property::STOP_OFFSET, offsets);
221 map.Insert(Toolkit::GradientVisual::Property::STOP_COLOR, colors);
223 if(&typeid(*mGradient) == &typeid(LinearGradient))
225 LinearGradient* gradient = static_cast<LinearGradient*>(mGradient.Get());
226 map.Insert(Toolkit::GradientVisual::Property::START_POSITION, gradient->GetStartPosition());
227 map.Insert(Toolkit::GradientVisual::Property::END_POSITION, gradient->GetEndPosition());
229 else // if( &typeid( *mGradient ) == &typeid(RadialGradient) )
231 RadialGradient* gradient = static_cast<RadialGradient*>(mGradient.Get());
232 map.Insert(Toolkit::GradientVisual::Property::CENTER, gradient->GetCenter());
233 map.Insert(Toolkit::GradientVisual::Property::RADIUS, gradient->GetRadius());
237 void GradientVisual::DoCreateInstancePropertyMap(Property::Map& map) const
242 void GradientVisual::EnablePreMultipliedAlpha(bool preMultiplied)
244 // Make always enable pre multiplied alpha whether preMultiplied value is false.
247 DALI_LOG_WARNING("Note : GradientVisual cannot disable PreMultipliedAlpha\n");
251 void GradientVisual::OnInitialize()
253 Geometry geometry = mFactoryCache.GetGeometry(VisualFactoryCache::QUAD_GEOMETRY);
254 Shader shader = GenerateShader();
256 //Set up the texture set
257 TextureSet textureSet = TextureSet::New();
258 Dali::Texture lookupTexture = mGradient->GenerateLookupTexture();
259 textureSet.SetTexture(0u, lookupTexture);
260 Dali::WrapMode::Type wrap = GetWrapMode(mGradient->GetSpreadMethod());
261 Sampler sampler = Sampler::New();
262 sampler.SetWrapMode(wrap, wrap);
263 textureSet.SetSampler(0u, sampler);
265 mImpl->mRenderer = DecoratedVisualRenderer::New(geometry, shader);
266 mImpl->mRenderer.ReserveCustomProperties(CUSTOM_PROPERTY_COUNT);
267 mImpl->mRenderer.SetTextures(textureSet);
269 // If opaque and then no need to have blending
272 mImpl->mRenderer.SetProperty(Renderer::Property::BLEND_MODE, BlendMode::OFF);
275 mImpl->mRenderer.RegisterUniqueProperty(UNIFORM_ALIGNMENT_MATRIX_NAME, mGradientTransform);
277 //Register transform properties
278 mImpl->mTransform.SetUniforms(mImpl->mRenderer, Direction::LEFT_TO_RIGHT);
281 bool GradientVisual::NewGradient(Type gradientType, const Property::Map& propertyMap)
283 if(gradientType == Type::LINEAR)
285 Property::Value* startPositionValue = propertyMap.Find(Toolkit::GradientVisual::Property::START_POSITION, START_POSITION_NAME);
286 Property::Value* endPositionValue = propertyMap.Find(Toolkit::GradientVisual::Property::END_POSITION, END_POSITION_NAME);
287 Vector2 startPosition;
290 if(startPositionValue && startPositionValue->Get(startPosition) && endPositionValue && endPositionValue->Get(endPosition))
292 mGradient = new LinearGradient(startPosition, endPosition);
299 else // type==Type::RADIAL
301 Property::Value* centerValue = propertyMap.Find(Toolkit::GradientVisual::Property::CENTER, CENTER_NAME);
302 Property::Value* radiusValue = propertyMap.Find(Toolkit::GradientVisual::Property::RADIUS, RADIUS_NAME);
305 if(centerValue && centerValue->Get(center) && radiusValue && radiusValue->Get(radius))
307 mGradient = new RadialGradient(center, radius);
315 unsigned int numValidStop = 0u;
316 Property::Value* stopOffsetValue = propertyMap.Find(Toolkit::GradientVisual::Property::STOP_OFFSET, STOP_OFFSET_NAME);
317 Property::Value* stopColorValue = propertyMap.Find(Toolkit::GradientVisual::Property::STOP_COLOR, STOP_COLOR_NAME);
320 Vector<float> offsetArray;
321 Property::Array* colorArray = stopColorValue->GetArray();
324 GetStopOffsets(stopOffsetValue, offsetArray);
325 unsigned int numStop = offsetArray.Count() < colorArray->Count() ? offsetArray.Count() : colorArray->Count();
327 for(unsigned int i = 0; i < numStop; i++)
329 if((colorArray->GetElementAt(i)).Get(color))
331 mGradient->AddStop(offsetArray[i], Vector4(color.r * color.a, color.g * color.a, color.b * color.a, color.a));
333 if(!Equals(color.a, 1.0f, Math::MACHINE_EPSILON_1))
342 if(numValidStop < 1u) // no valid stop
347 Property::Value* spread = propertyMap.Find(Toolkit::GradientVisual::Property::SPREAD_METHOD, SPREAD_METHOD_NAME);
348 // The default spread method is PAD. Only need to set new spread if it's anything else.
351 Toolkit::GradientVisual::SpreadMethod::Type spreadMethod = Toolkit::GradientVisual::SpreadMethod::PAD;
352 if(Scripting::GetEnumerationProperty(*spread, SPREAD_METHOD_TABLE, SPREAD_METHOD_TABLE_COUNT, spreadMethod))
354 mGradient->SetSpreadMethod(spreadMethod);
361 Shader GradientVisual::GenerateShader() const
363 bool userspaceUnit = (mGradient->GetGradientUnits() == Toolkit::GradientVisual::Units::USER_SPACE);
364 bool roundedCorner = IsRoundedCornerRequired();
365 bool borderline = IsBorderlineRequired();
366 bool radialGradient = (mGradientType == Type::RADIAL);
368 int shaderTypeFlag = GradientVisualRequireFlag::DEFAULT;
371 shaderTypeFlag |= GradientVisualRequireFlag::ROUNDED_CORNER;
375 shaderTypeFlag |= GradientVisualRequireFlag::BORDERLINE;
379 shaderTypeFlag |= GradientVisualRequireFlag::USER_SPACE;
383 shaderTypeFlag |= GradientVisualRequireFlag::RADIAL;
386 VisualFactoryCache::ShaderType shaderType = SHADER_TYPE_TABLE[shaderTypeFlag];
387 Shader shader = mFactoryCache.GetShader(shaderType);
390 std::string vertexShaderPrefixList;
391 std::string fragmentShaderPrefixList;
395 vertexShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER\n";
396 fragmentShaderPrefixList += "#define IS_REQUIRED_ROUNDED_CORNER\n";
400 vertexShaderPrefixList += "#define IS_REQUIRED_BORDERLINE\n";
401 fragmentShaderPrefixList += "#define IS_REQUIRED_BORDERLINE\n";
405 fragmentShaderPrefixList += "#define RADIAL\n";
409 vertexShaderPrefixList += "#define USER_SPACE\n";
412 shader = Shader::New(Dali::Shader::GetVertexShaderPrefix() + vertexShaderPrefixList + SHADER_GRADIENT_VISUAL_SHADER_VERT.data(),
413 Dali::Shader::GetFragmentShaderPrefix() + fragmentShaderPrefixList + SHADER_GRADIENT_VISUAL_SHADER_FRAG.data());
414 mFactoryCache.SaveShader(shaderType, shader);
420 void GradientVisual::GetStopOffsets(const Property::Value* value, Vector<float>& stopOffsets)
422 if(value) // Only check valve type if a valid Property has been passed in
424 switch(value->GetType())
426 case Property::VECTOR2:
430 stopOffsets.PushBack(offset2.x);
431 stopOffsets.PushBack(offset2.y);
434 case Property::VECTOR3:
438 stopOffsets.PushBack(offset3.x);
439 stopOffsets.PushBack(offset3.y);
440 stopOffsets.PushBack(offset3.z);
443 case Property::VECTOR4:
447 stopOffsets.PushBack(offset4.x);
448 stopOffsets.PushBack(offset4.y);
449 stopOffsets.PushBack(offset4.z);
450 stopOffsets.PushBack(offset4.w);
453 case Property::ARRAY:
455 const Property::Array* offsetArray = value->GetArray();
458 unsigned int numStop = offsetArray->Count();
460 for(unsigned int i = 0; i < numStop; i++)
462 if(offsetArray->GetElementAt(i).Get(offset))
464 stopOffsets.PushBack(offset);
472 DALI_LOG_WARNING("GetStopOffsets passed unsupported Property Map\n");
478 if(stopOffsets.Empty())
480 // Set default offset if none set by Property system, need a minimum and maximum
481 stopOffsets.PushBack(DEFAULT_OFFSET_MINIMUM);
482 stopOffsets.PushBack(DEFAULT_OFFSET_MAXIMUM);
486 } // namespace Internal
488 } // namespace Toolkit