1 #ifndef DALI_INTERNAL_RENDERER_H
2 #define DALI_INTERNAL_RENDERER_H
5 * Copyright (c) 2018 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/common/dali-common.h> // DALI_ASSERT_ALWAYS
23 #include <dali/public-api/common/intrusive-ptr.h> // Dali::IntrusivePtr
24 #include <dali/public-api/rendering/renderer.h> // Dali::Renderer
25 #include <dali/internal/common/blending-options.h>
26 #include <dali/internal/event/common/object-connector.h> // Dali::Internal::ObjectConnector
27 #include <dali/internal/event/common/object-impl.h> // Dali::Internal::Object
28 #include <dali/internal/event/rendering/texture-set-impl.h> // Dali::Internal::TextureSet
29 #include <dali/internal/event/rendering/geometry-impl.h> // Dali::Internal::Geometry
30 #include <dali/internal/render/renderers/render-renderer.h> // Dali::Render::Renderer::StencilParameters
42 typedef IntrusivePtr<Renderer> RendererPtr;
45 * Renderer is an object that can be used to show content by combining a Geometry with a shader and textures.
47 class Renderer : public Object
52 * Create a new Renderer.
53 * @return A smart-pointer to the newly allocated Renderer.
55 static RendererPtr New();
58 * @copydoc Dali::Renderer::SetGeometry()
60 void SetGeometry( Geometry& geometry );
63 * @copydoc Dali::Renderer::GetGeometry()
65 Geometry* GetGeometry() const;
68 * @copydoc Dali::Renderer::SetTextures()
70 void SetTextures( TextureSet& textureSet );
73 * @copydoc Dali::Renderer::GetTextures()
75 TextureSet* GetTextures() const;
78 * @copydoc Dali::Renderer::SetShader()
80 void SetShader( Shader& shader );
83 * @copydoc Dali::Renderer::GetShader()
85 Shader* GetShader() const;
88 * @copydoc Dali::Renderer::SetDepthIndex()
90 void SetDepthIndex( int depthIndex );
93 * @copydoc Dali::Renderer::GetDepthIndex()
95 int GetDepthIndex() const;
98 * @copydoc Dali::Renderer::SetBlendMode()
100 void SetBlendMode( BlendMode::Type mode );
103 * @copydoc Dali::Renderer::GetBlendMode()
105 BlendMode::Type GetBlendMode() const;
108 * @copydoc Dali::Renderer::SetBlendFunc()
110 void SetBlendFunc( BlendFactor::Type srcFactorRgba, BlendFactor::Type destFactorRgba );
113 * @copydoc Dali::Renderer::SetBlendFunc()
115 void SetBlendFunc( BlendFactor::Type srcFactorRgb, BlendFactor::Type destFactorRgb,
116 BlendFactor::Type srcFactorAlpha, BlendFactor::Type destFactorAlpha );
119 * @copydoc Dali::Renderer::GetBlendFunc()
121 void GetBlendFunc( BlendFactor::Type& srcFactorRgb, BlendFactor::Type& destFactorRgb,
122 BlendFactor::Type& srcFactorAlpha, BlendFactor::Type& destFactorAlpha ) const;
125 * @copydoc Dali::Renderer::SetBlendEquation()
127 void SetBlendEquation( BlendEquation::Type equationRgba );
130 * @copydoc Dali::Renderer::SetBlendEquation()
132 void SetBlendEquation( BlendEquation::Type equationRgb, BlendEquation::Type equationAlpha );
135 * @copydoc Dali::Renderer::GetBlendEquation()
137 void GetBlendEquation( BlendEquation::Type& equationRgb, BlendEquation::Type& equationAlpha ) const;
140 * @copydoc Dali::Renderer::SetIndexedDrawFirstElement
142 void SetIndexedDrawFirstElement( uint32_t firstElement );
145 * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
147 void SetIndexedDrawElementsCount( uint32_t elementsCount );
150 * @brief Set whether the Pre-multiplied Alpha Blending is required
152 * @param[in] preMultipled whether alpha is pre-multiplied.
154 void EnablePreMultipliedAlpha( bool preMultipled );
157 * @brief Query whether alpha is pre-multiplied.
159 * @return True is alpha is pre-multiplied, false otherwise.
161 bool IsPreMultipliedAlphaEnabled() const;
164 * @brief Get the scene graph object
166 * @return the scene object
168 SceneGraph::Renderer* GetRendererSceneObject();
170 public: // Default property extensions from Object
173 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
175 virtual unsigned int GetDefaultPropertyCount() const;
178 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
180 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
183 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
185 virtual const char* GetDefaultPropertyName(Property::Index index) const;
188 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
190 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
193 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
195 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
198 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
200 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
203 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
205 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
208 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
210 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
213 * @copydoc Dali::Internal::Object::SetDefaultProperty()
215 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
218 * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
220 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
223 * @copydoc Dali::Internal::Object::GetDefaultProperty()
225 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
228 * @copydoc Dali::Internal::Object::GetDefaultPropertyCurrentValue()
230 virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const;
233 * @copydoc Dali::Internal::Object::OnNotifyDefaultPropertyAnimation()
235 virtual void OnNotifyDefaultPropertyAnimation( Animation& animation, Property::Index index, const Property::Value& value, Animation::Type animationType );
238 * @copydoc Dali::Internal::Object::GetPropertyOwner()
240 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
243 * @copydoc Dali::Internal::Object::GetSceneObject()
245 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
248 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
250 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
253 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
255 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
258 * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
260 virtual int GetPropertyComponentIndex( Property::Index index ) const;
262 private: // implementation
265 * @brief Default constructor.
270 * @brief Initializes the Renderer.
275 * @brief Sets the blend color.
276 * @param[in] blendColor The blend color to set.
278 void SetBlendColor( const Vector4& blendColor );
281 * @brief Retrieves the blend-color.
282 * @return A const reference to the blend-color
284 const Vector4& GetBlendColor() const;
287 * @brief Retrieves the cached event side value of a default property.
288 * @param[in] index The index of the property
289 * @param[out] value Is set with the cached value of the property if found.
290 * @return True if value set, false otherwise.
292 bool GetCachedPropertyValue( Property::Index index, Property::Value& value ) const;
295 * @brief Retrieves the current value of a default property from the scene-graph.
296 * @param[in] index The index of the property
297 * @param[out] value Is set with the current scene-graph value of the property
298 * @return True if value set, false otherwise.
300 bool GetCurrentPropertyValue( Property::Index index, Property::Value& value ) const;
304 * A reference counted object may only be deleted by calling Unreference()
308 private: // unimplemented methods
309 Renderer( const Renderer& );
310 Renderer& operator=( const Renderer& );
313 SceneGraph::Renderer* mSceneObject;
314 GeometryPtr mGeometry; ///< Connector that holds the geometry used by this renderer
315 TextureSetPtr mTextureSet; ///< Connector that holds the texture set used by this renderer
316 ShaderPtr mShader; ///< Connector that holds the shader used by this renderer
320 uint32_t mIndexedDrawFirstElement; ///< Offset of first element to draw from bound index buffer
321 uint32_t mIndexedDrawElementCount; ///< Number of elements to draw
323 Render::Renderer::StencilParameters mStencilParameters; ///< Struct containing all stencil related options
324 BlendingOptions mBlendingOptions; ///< Local copy of blending options bitmask
326 float mOpacity; ///< Local copy of the opacity
327 DepthFunction::Type mDepthFunction:4; ///< Local copy of the depth function
328 FaceCullingMode::Type mFaceCullingMode:3; ///< Local copy of the mode of face culling
329 BlendMode::Type mBlendMode:3; ///< Local copy of the mode of blending
330 DepthWriteMode::Type mDepthWriteMode:3; ///< Local copy of the depth write mode
331 DepthTestMode::Type mDepthTestMode:3; ///< Local copy of the depth test mode
332 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
335 } // namespace Internal
337 // Helpers for public-api forwarding methods
338 inline Internal::Renderer& GetImplementation( Dali::Renderer& handle )
340 DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
342 BaseObject& object = handle.GetBaseObject();
344 return static_cast<Internal::Renderer&>(object);
347 inline const Internal::Renderer& GetImplementation( const Dali::Renderer& handle )
349 DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
351 const BaseObject& object = handle.GetBaseObject();
353 return static_cast<const Internal::Renderer&>(object);
358 #endif // DALI_INTERNAL_RENDERER_H