2 * Copyright (c) 2015 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 <dali/internal/event/rendering/shader-impl.h> // Dali::Internal::Shader
22 #include <dali/public-api/object/type-registry.h>
23 #include <dali/public-api/shader-effects/shader-effect.h> // Dali::ShaderEffect::GeometryHints // TODO: MESH_REWORK REMOVE
24 #include <dali/devel-api/rendering/shader.h> // Dali::Shader
25 #include <dali/devel-api/scripting/scripting.h>
27 #include <dali/internal/event/common/object-impl-helper.h> // Dali::Internal::ObjectHelper
28 #include <dali/internal/event/common/property-helper.h> // DALI_PROPERTY_TABLE_BEGIN, DALI_PROPERTY, DALI_PROPERTY_TABLE_END
29 #include <dali/internal/event/common/thread-local-storage.h>
30 #include <dali/internal/event/effects/shader-factory.h>
31 #include <dali/internal/event/resources/resource-ticket.h>
32 #include <dali/internal/update/manager/update-manager.h>
43 * |name |type |writable|animatable|constraint-input|enum for index-checking|
45 DALI_PROPERTY_TABLE_BEGIN
46 DALI_PROPERTY( "program", MAP, true, false, false, Dali::Shader::Property::PROGRAM )
47 DALI_PROPERTY_TABLE_END( DEFAULT_ACTOR_PROPERTY_START_INDEX )
49 const ObjectImplHelper<DEFAULT_PROPERTY_COUNT> SHADER_IMPL = { DEFAULT_PROPERTY_DETAILS };
51 Dali::Scripting::StringEnum ShaderHintsTable[] =
52 { { "HINT_NONE", Dali::Shader::HINT_NONE},
53 { "HINT_REQUIRES_SELF_DEPTH_TEST", Dali::Shader::HINT_REQUIRES_SELF_DEPTH_TEST},
54 { "HINT_OUTPUT_IS_TRANSPARENT", Dali::Shader::HINT_OUTPUT_IS_TRANSPARENT},
55 { "HINT_OUTPUT_IS_OPAQUE", Dali::Shader::HINT_OUTPUT_IS_OPAQUE},
56 { "HINT_MODIFIES_GEOMETRY", Dali::Shader::HINT_MODIFIES_GEOMETRY}
59 const unsigned int ShaderHintsTableSize = sizeof( ShaderHintsTable ) / sizeof( ShaderHintsTable[0] );
63 return Dali::BaseHandle();
66 TypeRegistration mType( typeid( Dali::Shader ), typeid( Dali::Handle ), Create );
68 #define TOKEN_STRING(x) (#x)
70 void AppendString(std::string& to, const std::string& append)
79 Property::Value HintString(const Dali::Shader::ShaderHints& hints)
83 if(hints == Dali::Shader::HINT_NONE)
88 if(hints & Dali::Shader::HINT_REQUIRES_SELF_DEPTH_TEST)
90 AppendString(s, "HINT_REQUIRES_SELF_DEPTH_TEST");
93 if(hints & Dali::Shader::HINT_OUTPUT_IS_TRANSPARENT)
95 AppendString(s, "HINT_OUTPUT_IS_TRANSPARENT");
98 if(hints & Dali::Shader::HINT_OUTPUT_IS_OPAQUE)
100 AppendString(s, "HINT_OUTPUT_IS_OPAQUE");
103 if(hints & Dali::Shader::HINT_MODIFIES_GEOMETRY)
105 AppendString(s, "HINT_MODIFIES_GEOMETRY");
108 return Property::Value(s);
112 } // unnamed namespace
114 ShaderPtr Shader::New( const std::string& vertexShader,
115 const std::string& fragmentShader,
116 Dali::Shader::ShaderHints hints )
118 ShaderPtr shader( new Shader() );
119 shader->Initialize( vertexShader, fragmentShader, hints );
123 const SceneGraph::Shader* Shader::GetShaderSceneObject() const
128 SceneGraph::Shader* Shader::GetShaderSceneObject()
133 unsigned int Shader::GetDefaultPropertyCount() const
135 return SHADER_IMPL.GetDefaultPropertyCount();
138 void Shader::GetDefaultPropertyIndices( Property::IndexContainer& indices ) const
140 SHADER_IMPL.GetDefaultPropertyIndices( indices );
143 const char* Shader::GetDefaultPropertyName(Property::Index index) const
145 return SHADER_IMPL.GetDefaultPropertyName( index );
148 Property::Index Shader::GetDefaultPropertyIndex( const std::string& name ) const
150 return SHADER_IMPL.GetDefaultPropertyIndex( name );
153 bool Shader::IsDefaultPropertyWritable( Property::Index index ) const
155 return SHADER_IMPL.IsDefaultPropertyWritable( index );
158 bool Shader::IsDefaultPropertyAnimatable( Property::Index index ) const
160 return SHADER_IMPL.IsDefaultPropertyAnimatable( index );
163 bool Shader::IsDefaultPropertyAConstraintInput( Property::Index index ) const
165 return SHADER_IMPL.IsDefaultPropertyAConstraintInput( index );
168 Property::Type Shader::GetDefaultPropertyType( Property::Index index ) const
170 return SHADER_IMPL.GetDefaultPropertyType( index );
173 void Shader::SetDefaultProperty( Property::Index index,
174 const Property::Value& propertyValue )
178 case Dali::Shader::Property::PROGRAM:
180 if( propertyValue.GetType() == Property::MAP )
182 Dali::Property::Map* map = propertyValue.GetMap();
184 std::string fragment;
185 Dali::Shader::ShaderHints hints(Dali::Shader::HINT_NONE);
187 if( Property::Value* value = map->Find("vertex") )
189 vertex = value->Get<std::string>();
192 if( Property::Value* value = map->Find("fragment") )
194 fragment = value->Get<std::string>();
197 if( Property::Value* value = map->Find("hints") )
199 static_cast<void>( // ignore return
200 Scripting::GetEnumeration< Dali::Shader::ShaderHints >(value->Get<std::string>().c_str(),
201 ShaderHintsTable, ShaderHintsTableSize, hints)
205 Initialize(vertex, fragment, hints );
209 DALI_LOG_WARNING( "Shader program property should be a map\n" );
216 void Shader::SetSceneGraphProperty( Property::Index index,
217 const PropertyMetadata& entry,
218 const Property::Value& value )
220 SHADER_IMPL.SetSceneGraphProperty( GetEventThreadServices(), this, index, entry, value );
221 OnPropertySet(index, value);
224 Property::Value Shader::GetDefaultProperty( Property::Index index ) const
226 Property::Value value;
230 case Dali::Shader::Property::PROGRAM:
232 Dali::Property::Map map;
235 map["vertex"] = Property::Value(mShaderData->GetVertexShader());
236 map["fragment"] = Property::Value(mShaderData->GetFragmentShader());
237 map["hints"] = HintString(mShaderData->GetHints());
247 const SceneGraph::PropertyOwner* Shader::GetPropertyOwner() const
252 const SceneGraph::PropertyOwner* Shader::GetSceneObject() const
257 const SceneGraph::PropertyBase* Shader::GetSceneObjectAnimatableProperty( Property::Index index ) const
259 DALI_ASSERT_ALWAYS( IsPropertyAnimatable( index ) && "Property is not animatable" );
260 const SceneGraph::PropertyBase* property = NULL;
262 property = SHADER_IMPL.GetRegisteredSceneGraphProperty( this,
263 &Shader::FindAnimatableProperty,
264 &Shader::FindCustomProperty,
267 if( property == NULL && index < DEFAULT_PROPERTY_MAX_COUNT )
269 DALI_ASSERT_ALWAYS( 0 && "Property is not animatable" );
275 const PropertyInputImpl* Shader::GetSceneObjectInputProperty( Property::Index index ) const
277 PropertyMetadata* property = NULL;
279 if(index >= PROPERTY_CUSTOM_START_INDEX )
281 property = FindCustomProperty( index );
285 property = FindAnimatableProperty( index );
288 DALI_ASSERT_ALWAYS( property && "property index is invalid" );
289 return property->GetSceneGraphProperty();
292 int Shader::GetPropertyComponentIndex( Property::Index index ) const
294 return Property::INVALID_COMPONENT_INDEX;
298 : mSceneObject( NULL ),
303 void Shader::Initialize(
304 const std::string& vertexSource,
305 const std::string& fragmentSource,
306 Dali::Shader::ShaderHints hints )
308 EventThreadServices& eventThreadServices = GetEventThreadServices();
309 SceneGraph::UpdateManager& updateManager = eventThreadServices.GetUpdateManager();
311 // @todo MESH_REWORK - Pass hints directly to a new scene graph shader
312 int effectHint = Dali::ShaderEffect::HINT_NONE;
313 if( hints & Dali::Shader::HINT_OUTPUT_IS_TRANSPARENT )
315 effectHint |= Dali::ShaderEffect::HINT_BLENDING;
318 if( hints & Dali::Shader::HINT_REQUIRES_SELF_DEPTH_TEST )
320 effectHint |= Dali::ShaderEffect::HINT_DEPTH_BUFFER;
323 if( (hints & Dali::Shader::HINT_MODIFIES_GEOMETRY) == 0x0 )
325 effectHint |= Dali::ShaderEffect::HINT_DOESNT_MODIFY_GEOMETRY;
327 Dali::ShaderEffect::GeometryHints shaderEffectHint = static_cast<Dali::ShaderEffect::GeometryHints>( effectHint );
329 mSceneObject = new SceneGraph::Shader( shaderEffectHint );
331 // Add to update manager
332 AddShaderMessage( updateManager, *mSceneObject );
334 // Try to load a precompiled shader binary for the source pair:
335 ThreadLocalStorage& tls = ThreadLocalStorage::Get();
336 ShaderFactory& shaderFactory = tls.GetShaderFactory();
338 mShaderData = shaderFactory.Load( vertexSource, fragmentSource, hints, shaderHash );
340 // Add shader program to scene-object using a message to the UpdateManager
341 SetShaderProgramMessage( updateManager, *mSceneObject, mShaderData, (hints & Dali::Shader::HINT_MODIFIES_GEOMETRY) != 0x0 );
342 eventThreadServices.RegisterObject( this );
347 if( EventThreadServices::IsCoreRunning() )
349 EventThreadServices& eventThreadServices = GetEventThreadServices();
350 SceneGraph::UpdateManager& updateManager = eventThreadServices.GetUpdateManager();
351 RemoveShaderMessage( updateManager, *mSceneObject);
353 eventThreadServices.UnregisterObject( this );
358 } // namespace Internal