-#ifndef __DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H__
-#define __DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H__
+#ifndef DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H
+#define DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
+
// EXTERNAL INCLUDES
-#include <dali/public-api/shader-effects/shader-effect.h>
+#include <dali/public-api/object/property-map.h>
namespace Dali
{
-
namespace Toolkit
{
-
/**
+ * Creates a new DistanceFieldEffect
+ *
* DistanceFieldEffect is a custom shader effect to achieve distance field on Image actors
+ *
+ * Animatable/Constrainable uniforms - These will need to be registered to the actor as a custom property to take into effect:
+ *
+ * "uDoGlow" - The glow state. If true, glow is enabled
+ * "uGlowBoundary" - The glow boundary factor
+ * "uGlowColor" - The glow color multiplier
+
+ * "uDoShadow" - The shadow state. If true, shadows is enabled. Cannot be used with glow/and or outline
+ * "uShadowColor" - The shadow color multiplier
+ * "uShadowOffset" - The shadow offset
+
+ * "uDoOutline" - The outline state. If true, outline is enabled
+ * "uOutlineColor" - The outline color multiplier
+ * "uOutlineParams"- Thickness of outline. The outline thickness is determined by two values.
+ * First value [0-1] Specifies the distance field value for the center of the outline.
+ * Second value [0-1] Specifies the softness/width/anti-aliasing of the outlines inner edge.
+ *
+ * @return The newly created Property::Map with the distance field effect
*/
-class DALI_IMPORT_API DistanceFieldEffect : public ShaderEffect
-{
-public:
-
- /**
- * Create an uninitialized DistanceFieldEffect; this can be initialized with DistanceFieldEffect::New()
- * Calling member functions with an uninitialized Dali::Object is not allowed.
- */
- DistanceFieldEffect();
-
- /**
- * @brief Destructor
- *
- * This is non-virtual since derived Handle types must not contain data or virtual methods.
- */
- ~DistanceFieldEffect();
-
- /**
- * Create an initialized DistanceFieldEffect.
- * @return A handle to a newly allocated Dali resource.
- */
- static DistanceFieldEffect New();
-
- /**
- * Set the shadow state
- * @param[in] shadowEnable value - true, enable shadow.
- * @note Shadow cannot be used with glow/and or outline.
- */
- void SetShadow(bool shadowEnable);
-
- /**
- * Set the shadow color multiplier (e.g. output RGB)
- * @param[in] color Shadow color value
- */
- void SetShadowColor(const Vector4& color);
-
- /**
- * Set the shadow offset
- * @param[in] color shadow offset value
- */
- void SetShadowOffset(const Vector2& color);
-
- /**
- * Set the glow state
- * @param[in] glowEnable value - true, enable glow.
- */
-
- void SetGlow(bool glowEnable);
-
- /**
- * Set the glow color multiplier (e.g. output RGB)
- * @param[in] color Glow color value
- */
- void SetGlowColor(const Vector4& color);
-
- /**
- * Set the glow boundary factor
- * @param[in] glowBoundary glow boundary
- */
- void SetGlowBoundary(float glowBoundary);
-
- /**
- * Set the outline state
- * @param[in] outlineEnable value - true, enable outline.
- */
-
- void SetOutline(bool outlineEnable);
-
- /**
- * Set the outline color multiplier (e.g. output RGB)
- * @param[in] color Outline color value
- */
- void SetOutlineColor(const Vector4& color);
-
- /**
- * Sets the outline parameters.
- * @param[in] outlineParams Thickness of outline. The outline thickness is determined by two parameters.
- * params[0] (0-1) Specifies the distance field value for the center of the outline.
- * 0 <= params[0] <= 1
- * params[1] (0-1) Specifies the softness/width/anti-aliasing of the outlines inner edge.
- * 0 <= params[0] <= 1
- */
- void SetOutlineParams(const Vector2& outlineParams);
-
- /**
- * Set soft edge smoothing
- * @param[in] smoothing Specify the distance field value for the center of the edge.
- * 0 <= params <= 1
- */
- void SetSmoothingEdge(float smoothing);
-
- /**
- * Get the name for the outline-enable property
- * @return A std::string containing the property name
- */
- const std::string& GetOutlineEnablePropertyName() const;
-
- /**
- * Get the name for the glow-enable property
- * @return A std::string containing the property name
- */
- const std::string& GetGlowEnablePropertyName() const;
-
- /**
- * Get the name for the shadow-enable property
- * @return A std::string containing the property name
- */
- const std::string& GetShadowEnablePropertyName() const;
-
- /**
- * Get the name for the radius property
- * @return A std::string containing the property name
- */
- const std::string& GetColorPropertyName() const;
-
- /**
- * Get the name for the smoothing property
- * @return A std::string containing the property name
- */
- const std::string& GetSmoothingPropertyName() const;
-
- /**
- * Get the name for the outline color property
- * @return A std::string containing the property name
- */
- const std::string& GetOutlineColorPropertyName() const;
-
- /**
- * Get the name for the outline size property
- * @return A std::string containing the property name
- */
- const std::string& GetOutlineSizePropertyName() const;
-
- /**
- * Get the name for the shadow color property
- * @return A std::string containing the property name
- */
- const std::string& GetShadowColorPropertyName() const;
-
- /**
- * Get the name for the shadow offset property
- * @return A std::string containing the property name
- */
- const std::string& GetShadowOffsetPropertyName() const;
-
- /**
- * Get the name for the glow color property
- * @return A std::string containing the property name
- */
- const std::string& GetGlowColorPropertyName() const;
-
- /**
- * Get the name for the glow boundary property
- * @return A std::string containing the property name
- */
- const std::string& GetGlowBoundaryPropertyName() const;
-
-private:
- DALI_INTERNAL DistanceFieldEffect(ShaderEffect handle);
-
-};
+DALI_TOOLKIT_API Dali::Property::Map CreateDistanceFieldEffect();
} // namespace Toolkit
} // namespace Dali
-#endif // __DALI_TOOLKIT_SHADER_EFFECT_SPOT_H__
+#endif // DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff