dali/internal/event/effects/shader-effect-impl.h

   1 #ifndef __DALI_INTERNAL_SHADER_EFFECT_H__
   2 #define __DALI_INTERNAL_SHADER_EFFECT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/images/image.h>
  23 #include <dali/public-api/shader-effects/shader-effect.h>
  24 #include <dali/internal/event/effects/shader-declarations.h>
  25 #include <dali/internal/event/common/object-impl.h>
  26 #include <dali/internal/event/resources/resource-ticket.h>
  27 #include <dali/internal/render/shaders/scene-graph-shader.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 namespace SceneGraph
  36 {
  37 class UpdateManager;
  38 }
  39
  40 /**
  41  * An abstract base class for a shader effect object.
  42  * The corresponding scene-graph object is a collection of shader programs,
  43  * which can apply the same effect to different geometry types.
  44  */
  45 class ShaderEffect : public Object
  46 {
  47 public:
  48   typedef Dali::ShaderEffect::UniformCoordinateType UniformCoordinateType;
  49
  50   enum GeometryState
  51   {
  52     DOESNT_MODIFY_GEOMETRY,
  53     MODIFIES_GEOMETRY
  54   };
  55
  56   /**
  57    * Create a new ShaderEffect with no programs
  58    * @param hints GeometryHints to define the geometry of the rendered object
  59    * @return A smart-pointer to a newly allocated shader effect.
  60    */
  61   static ShaderEffectPtr New( Dali::ShaderEffect::GeometryHints hints = Dali::ShaderEffect::HINT_NONE );
  62
  63   /**
  64    * @copydoc Dali::ShaderEffect::SetEffectImage
  65    */
  66   void SetEffectImage( Dali::Image image );
  67
  68   /**
  69    * @copydoc Dali::ShaderEffect::SetUniform( const std::string& name, Property::Value value, UniformCoordinateType uniformCoordinateType )
  70    */
  71   void SetUniform( const std::string& name,
  72                    Property::Value value,
  73                    UniformCoordinateType uniformCoordinateType );
  74
  75   /**
  76    * Add a GeometryType specific default program to this ShaderEffect
  77    * @param[in] geometryType    The GeometryType rendered by the shader program
  78    * @param[in] vertexSource    The source code for the vertex shader
  79    * @param[in] fragmentSource  The source code for the fragment shader
  80    */
  81   void SetPrograms( const std::string& vertexSource, const std::string& fragmentSource );
  82
  83   /**
  84    * Add a default program to this ShaderEffect.
  85    * This overload allows the optional prefixing for both the vertex and fragment shader.
  86    * A useful prefix may be shader \#defines for conditional compilation.
  87    * @param[in] vertexPrefix    The prefix source code for the vertex shader
  88    * @param[in] fragmentPrefix  The prefix source code for the fragment shader
  89    * @param[in] vertexSource    The source code for the vertex shader
  90    * @param[in] fragmentSource  The source code for the fragment shader
  91    */
  92   void SetPrograms( const std::string& vertexPrefix, const std::string& fragmentPrefix,
  93                     const std::string& vertexSource, const std::string& fragmentSource );
  94
  95   /**
  96    * Send shader program to scene-graph object.
  97    * @param[in] vertexSource     The source code for the vertex shader
  98    * @param[in] fragmentSource   The source code for the fragment shader
  99    * @param[in] modifiesGeometry True if the shader modifies geometry
 100    */
 101   void SendProgramMessage( const std::string& vertexSource, const std::string& fragmentSource,
 102                            bool modifiesGeometry );
 103
 104   /**
 105    * Notify ShaderEffect that it's being used by an Actor.
 106    */
 107   void Connect();
 108
 109   /**
 110    * Notify ShaderEffect that an Actor is no longer using it.
 111    */
 112   void Disconnect();
 113
 114 public: // Default property extensions from Object
 115
 116   /**
 117    * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
 118    */
 119   virtual unsigned int GetDefaultPropertyCount() const;
 120
 121   /**
 122    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
 123    */
 124   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
 125
 126   /**
 127    * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
 128    */
 129   virtual const char* GetDefaultPropertyName( Property::Index index ) const;
 130
 131   /**
 132    * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
 133    */
 134   virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
 135
 136   /**
 137    * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
 138    */
 139   virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
 140
 141   /**
 142    * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
 143    */
 144   virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
 145
 146   /**
 147    * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
 148    */
 149   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
 150
 151   /**
 152    * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
 153    */
 154   virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
 155
 156   /**
 157    * @copydoc Dali::Internal::Object::SetDefaultProperty()
 158    */
 159   virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
 160
 161   /**
 162    * @copydoc Dali::Internal::Object::GetDefaultProperty()
 163    */
 164   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 165
 166   /**
 167    * @copydoc Dali::Internal::Object::NotifyScenePropertyInstalled()
 168    */
 169   virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const;
 170
 171   /**
 172    * @copydoc Dali::Internal::Object::GetSceneObject()
 173    */
 174   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
 175
 176   /**
 177    * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
 178    */
 179   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
 180
 181   /**
 182    * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
 183    */
 184   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
 185
 186 protected:
 187
 188   /**
 189    * Protected constructor.
 190    * @param[in] eventThreadServices the interface to use for sending messages to the update thread
 191    * @param[in] hints Geometry hints
 192    */
 193   ShaderEffect( EventThreadServices& eventThreadServices, Dali::ShaderEffect::GeometryHints hints );
 194
 195   /**
 196    * A reference counted object may only be deleted by calling Unreference()
 197    */
 198   virtual ~ShaderEffect();
 199
 200 private:
 201
 202   // No copying allowed, thus these are undefined
 203   ShaderEffect( const ShaderEffect& );
 204   ShaderEffect& operator=( const ShaderEffect& rhs );
 205
 206 private: // Data
 207   EventThreadServices& mEventThreadServices; ///< Event thread services, for sending messages
 208   SceneGraph::Shader* mSceneObject;         ///< pointer to the scene shader, should not be changed on this thread
 209   Dali::Image mImage;                       ///< Client-side handle for the effect image
 210   unsigned int  mConnectionCount;           ///< number of on-stage ImageActors using this shader effect
 211   Dali::ShaderEffect::GeometryHints  mGeometryHints; ///< shader geometry hints for building the geometry
 212   Dali::Vector< UniformCoordinateType > mCoordinateTypes; ///< cached to avoid sending tons of unnecessary messages
 213
 214 };
 215
 216 } // namespace Internal
 217
 218 // Helpers for public-api forwarding methods
 219
 220 inline Internal::ShaderEffect& GetImplementation(Dali::ShaderEffect& effect)
 221 {
 222   DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
 223
 224   BaseObject& handle = effect.GetBaseObject();
 225
 226   return static_cast<Internal::ShaderEffect&>(handle);
 227 }
 228
 229 inline const Internal::ShaderEffect& GetImplementation(const Dali::ShaderEffect& effect)
 230 {
 231   DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
 232
 233   const BaseObject& handle = effect.GetBaseObject();
 234
 235   return static_cast<const Internal::ShaderEffect&>(handle);
 236 }
 237
 238 } // namespace Dali
 239
 240 #endif // __DALI_INTERNAL_SHADER_EFFECT_H__