1 #ifndef __DALI_INTERNAL_SHADER_EFFECT_H__
2 #define __DALI_INTERNAL_SHADER_EFFECT_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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/proxy-object.h>
26 #include <dali/internal/event/resources/resource-ticket.h>
27 #include <dali/internal/render/shaders/shader.h>
42 * An abstract base class for a shader effect proxy.
43 * The corresponding scene-graph object is a collection of shader programs,
44 * which can apply the same effect to different geometry types.
46 class ShaderEffect : public ProxyObject
49 typedef Dali::ShaderEffect::UniformCoordinateType UniformCoordinateType;
53 DOESNT_MODIFY_GEOMETRY,
58 * Create a new ShaderEffect with no programs
59 * @param hints GeometryHints to define the geometry of the rendered object
60 * @return A smart-pointer to a newly allocated shader effect.
62 static ShaderEffectPtr New( Dali::ShaderEffect::GeometryHints hints = Dali::ShaderEffect::HINT_NONE );
65 * @copydoc Dali::ShaderEffect::SetEffectImage
67 void SetEffectImage( Dali::Image image );
70 * @copydoc Dali::ShaderEffect::SetUniform( const std::string& name, Property::Value value, UniformCoordinateType uniformCoordinateType )
72 void SetUniform( const std::string& name,
73 Property::Value value,
74 UniformCoordinateType uniformCoordinateType );
77 * @copydoc Dali::ShaderEffect::AttachExtension()
79 void AttachExtension( Dali::ShaderEffect::Extension *object );
82 * @copydoc Dali::ShaderEffect::GetExtension()
84 Dali::ShaderEffect::Extension& GetExtension();
87 * @copydoc Dali::ShaderEffect::GetExtension() const
89 const Dali::ShaderEffect::Extension& GetExtension() const;
92 * Add a GeometryType specific default program to this ShaderEffect
93 * @param[in] geometryType The GeometryType rendered by the shader program
94 * @param[in] vertexSource The source code for the vertex shader
95 * @param[in] fragmentSource The source code for the fragment shader
97 void SetPrograms( GeometryType geometryType, const std::string& vertexSource, const std::string& fragmentSource );
100 * Add a GeometryType specific default program to this ShaderEffect.
101 * This overload allows the optional prefixing for both the vertex and fragment shader.
102 * A useful prefix may be shader \#defines for conditional compilation.
103 * @param[in] geometryType The GeometryType rendered by the shader program
104 * @param[in] vertexPrefix The prefix source code for the vertex shader
105 * @param[in] fragmentPrefix The prefix source code for the fragment shader
106 * @param[in] vertexSource The source code for the vertex shader
107 * @param[in] fragmentSource The source code for the fragment shader
109 void SetPrograms( GeometryType geometryType,
110 const std::string& vertexPrefix, const std::string& fragmentPrefix,
111 const std::string& vertexSource, const std::string& fragmentSource );
114 * Send shader program to scene-graph object.
115 * @param[in] geometryType The GeometryType rendered by the shader program
116 * @param[in] subType The subtype, one of ShaderSubTypes.
117 * @param[in] vertexSource The source code for the vertex shader
118 * @param[in] fragmentSource The source code for the fragment shader
119 * @param[in] modifiesGeometry True if the shader modifies geometry
121 void SendProgramMessage( GeometryType geometryType, ShaderSubTypes subType,
122 const std::string& vertexSource, const std::string& fragmentSource,
123 bool modifiesGeometry );
126 * Notify ShaderEffect that it's being used by an Actor.
131 * Notify ShaderEffect that an Actor is no longer using it.
135 public: // Default property extensions from ProxyObject
138 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyCount()
140 virtual unsigned int GetDefaultPropertyCount() const;
143 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndices()
145 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
148 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyName()
150 virtual const char* GetDefaultPropertyName( Property::Index index ) const;
153 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndex()
155 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
158 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyWritable()
160 virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
163 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAnimatable()
165 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
168 * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAConstraintInput()
170 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
173 * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyType()
175 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
178 * @copydoc Dali::Internal::ProxyObject::SetDefaultProperty()
180 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
183 * @copydoc Dali::Internal::ProxyObject::GetDefaultProperty()
185 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
188 * @copydoc Dali::Internal::ProxyObject::InstallSceneObjectProperty()
190 virtual void InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index );
193 * @copydoc Dali::Internal::ProxyObject::GetSceneObject()
195 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
198 * @copydoc Dali::Internal::ProxyObject::GetSceneObjectAnimatableProperty()
200 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
203 * @copydoc Dali::Internal::ProxyObject::GetSceneObjectInputProperty()
205 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
210 * Protected constructor.
212 ShaderEffect( SceneGraph::UpdateManager& updateManager, Dali::ShaderEffect::GeometryHints hints );
215 * A reference counted object may only be deleted by calling Unreference()
217 virtual ~ShaderEffect();
221 // No copying allowed, thus these are undefined
222 ShaderEffect( const ShaderEffect& );
223 ShaderEffect& operator=( const ShaderEffect& rhs );
227 SceneGraph::UpdateManager& mUpdateManager;///< reference to the update manager
228 SceneGraph::Shader* mSceneObject; ///< pointer to the scene shader, should not be changed on this thread
229 Dali::Image mImage; ///< Client-side handle for the effect image
230 IntrusivePtr<Dali::ShaderEffect::Extension> mExtension;
231 std::vector<ResourceTicketPtr> mTickets; ///< Collection of shader program tickets
232 unsigned int mConnectionCount; ///< number of on-stage ImageActors using this shader effect
233 Dali::ShaderEffect::GeometryHints mGeometryHints; ///< shader geometry hints for building the geometry
234 Dali::Vector< UniformCoordinateType > mCoordinateTypes; ///< cached to avoid sending tons of unnecessary messages
238 } // namespace Internal
240 // Helpers for public-api forwarding methods
242 inline Internal::ShaderEffect& GetImplementation(Dali::ShaderEffect& effect)
244 DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
246 BaseObject& handle = effect.GetBaseObject();
248 return static_cast<Internal::ShaderEffect&>(handle);
251 inline const Internal::ShaderEffect& GetImplementation(const Dali::ShaderEffect& effect)
253 DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
255 const BaseObject& handle = effect.GetBaseObject();
257 return static_cast<const Internal::ShaderEffect&>(handle);
262 #endif // __DALI_INTERNAL_SHADER_EFFECT_H__