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/object-impl.h>
26 #include <dali/internal/event/resources/resource-ticket.h>
27 #include <dali/internal/render/shaders/scene-graph-shader.h>
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.
45 class ShaderEffect : public Object
48 typedef Dali::ShaderEffect::UniformCoordinateType UniformCoordinateType;
52 DOESNT_MODIFY_GEOMETRY,
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.
61 static ShaderEffectPtr New( Dali::ShaderEffect::GeometryHints hints = Dali::ShaderEffect::HINT_NONE );
64 * @copydoc Dali::ShaderEffect::SetEffectImage
66 void SetEffectImage( Dali::Image image );
69 * @copydoc Dali::ShaderEffect::SetUniform( const std::string& name, Property::Value value, UniformCoordinateType uniformCoordinateType )
71 void SetUniform( const std::string& name,
72 Property::Value value,
73 UniformCoordinateType uniformCoordinateType );
76 * @copydoc Dali::ShaderEffect::AttachExtension()
78 void AttachExtension( Dali::ShaderEffect::Extension *object );
81 * @copydoc Dali::ShaderEffect::GetExtension()
83 Dali::ShaderEffect::Extension& GetExtension();
86 * @copydoc Dali::ShaderEffect::GetExtension() const
88 const Dali::ShaderEffect::Extension& GetExtension() const;
91 * Add a GeometryType specific default program to this ShaderEffect
92 * @param[in] geometryType The GeometryType rendered by the shader program
93 * @param[in] vertexSource The source code for the vertex shader
94 * @param[in] fragmentSource The source code for the fragment shader
96 void SetPrograms( GeometryType geometryType, const std::string& vertexSource, const std::string& fragmentSource );
99 * Add a GeometryType specific default program to this ShaderEffect.
100 * This overload allows the optional prefixing for both the vertex and fragment shader.
101 * A useful prefix may be shader \#defines for conditional compilation.
102 * @param[in] geometryType The GeometryType rendered by the shader program
103 * @param[in] vertexPrefix The prefix source code for the vertex shader
104 * @param[in] fragmentPrefix The prefix source code for the fragment shader
105 * @param[in] vertexSource The source code for the vertex shader
106 * @param[in] fragmentSource The source code for the fragment shader
108 void SetPrograms( GeometryType geometryType,
109 const std::string& vertexPrefix, const std::string& fragmentPrefix,
110 const std::string& vertexSource, const std::string& fragmentSource );
113 * Send shader program to scene-graph object.
114 * @param[in] geometryType The GeometryType rendered by the shader program
115 * @param[in] vertexSource The source code for the vertex shader
116 * @param[in] fragmentSource The source code for the fragment shader
117 * @param[in] modifiesGeometry True if the shader modifies geometry
119 void SendProgramMessage( GeometryType geometryType,
120 const std::string& vertexSource, const std::string& fragmentSource,
121 bool modifiesGeometry );
124 * Notify ShaderEffect that it's being used by an Actor.
129 * Notify ShaderEffect that an Actor is no longer using it.
133 public: // Default property extensions from Object
136 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
138 virtual unsigned int GetDefaultPropertyCount() const;
141 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
143 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
146 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
148 virtual const char* GetDefaultPropertyName( Property::Index index ) const;
151 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
153 virtual Property::Index GetDefaultPropertyIndex( const std::string& name ) const;
156 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
158 virtual bool IsDefaultPropertyWritable( Property::Index index ) const;
161 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
163 virtual bool IsDefaultPropertyAnimatable( Property::Index index ) const;
166 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
168 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
171 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
173 virtual Property::Type GetDefaultPropertyType( Property::Index index ) const;
176 * @copydoc Dali::Internal::Object::SetDefaultProperty()
178 virtual void SetDefaultProperty( Property::Index index, const Property::Value& propertyValue );
181 * @copydoc Dali::Internal::Object::GetDefaultProperty()
183 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
186 * @copydoc Dali::Internal::Object::NotifyScenePropertyInstalled()
188 virtual void NotifyScenePropertyInstalled( const SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index ) const;
191 * @copydoc Dali::Internal::Object::GetSceneObject()
193 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
196 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
198 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
201 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
203 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
208 * Protected constructor.
209 * @param[in] eventThreadServices the interface to use for sending messages to the update thread
210 * @param[in] hints Geometry hints
212 ShaderEffect( EventThreadServices& eventThreadServices, 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 );
226 EventThreadServices& mEventThreadServices; ///< Event thread services, for sending messages
227 SceneGraph::Shader* mSceneObject; ///< pointer to the scene shader, should not be changed on this thread
228 Dali::Image mImage; ///< Client-side handle for the effect image
229 IntrusivePtr<Dali::ShaderEffect::Extension> mExtension;
230 std::vector<ResourceTicketPtr> mTickets; ///< Collection of shader program tickets
231 unsigned int mConnectionCount; ///< number of on-stage ImageActors using this shader effect
232 Dali::ShaderEffect::GeometryHints mGeometryHints; ///< shader geometry hints for building the geometry
233 Dali::Vector< UniformCoordinateType > mCoordinateTypes; ///< cached to avoid sending tons of unnecessary messages
237 } // namespace Internal
239 // Helpers for public-api forwarding methods
241 inline Internal::ShaderEffect& GetImplementation(Dali::ShaderEffect& effect)
243 DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
245 BaseObject& handle = effect.GetBaseObject();
247 return static_cast<Internal::ShaderEffect&>(handle);
250 inline const Internal::ShaderEffect& GetImplementation(const Dali::ShaderEffect& effect)
252 DALI_ASSERT_ALWAYS(effect && "ShaderEffect handle is empty");
254 const BaseObject& handle = effect.GetBaseObject();
256 return static_cast<const Internal::ShaderEffect&>(handle);
261 #endif // __DALI_INTERNAL_SHADER_EFFECT_H__