1 #ifndef DALI_INTERNAL_RENDERER_H
2 #define DALI_INTERNAL_RENDERER_H
5 * Copyright (c) 2016 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/connectable.h> // Dali::Internal::Connectable
27 #include <dali/internal/event/common/object-connector.h> // Dali::Internal::ObjectConnector
28 #include <dali/internal/event/common/object-impl.h> // Dali::Internal::Object
29 #include <dali/internal/event/rendering/texture-set-impl.h> // Dali::Internal::TextureSet
30 #include <dali/internal/event/rendering/geometry-impl.h> // Dali::Internal::Geometry
31 #include <dali/internal/render/renderers/render-renderer.h> // Dali::Render::Renderer::StencilParameters
43 typedef IntrusivePtr<Renderer> RendererPtr;
46 * Renderer is an object that can be used to show content by combining a Geometry with a shader and textures.
48 class Renderer : public Object
53 * Create a new Renderer.
54 * @return A smart-pointer to the newly allocated Renderer.
56 static RendererPtr New();
59 * @copydoc Dali::Renderer::SetGeometry()
61 void SetGeometry( Geometry& geometry );
64 * @copydoc Dali::Renderer::GetGeometry()
66 Geometry* GetGeometry() const;
69 * @copydoc Dali::Renderer::SetTextures()
71 void SetTextures( TextureSet& textureSet );
74 * @copydoc Dali::Renderer::GetTextures()
76 TextureSet* GetTextures() const;
79 * @copydoc Dali::Renderer::SetShader()
81 void SetShader( Shader& shader );
84 * @copydoc Dali::Renderer::GetShader()
86 Shader* GetShader() const;
89 * @copydoc Dali::Renderer::SetDepthIndex()
91 void SetDepthIndex( int depthIndex );
94 * @copydoc Dali::Renderer::GetDepthIndex()
96 int GetDepthIndex() const;
99 * @copydoc Dali::Renderer::SetBlendMode()
101 void SetBlendMode( BlendMode::Type mode );
104 * @copydoc Dali::Renderer::GetBlendMode()
106 BlendMode::Type GetBlendMode() const;
109 * @copydoc Dali::Renderer::SetBlendFunc()
111 void SetBlendFunc( BlendFactor::Type srcFactorRgba, BlendFactor::Type destFactorRgba );
114 * @copydoc Dali::Renderer::SetBlendFunc()
116 void SetBlendFunc( BlendFactor::Type srcFactorRgb, BlendFactor::Type destFactorRgb,
117 BlendFactor::Type srcFactorAlpha, BlendFactor::Type destFactorAlpha );
120 * @copydoc Dali::Renderer::GetBlendFunc()
122 void GetBlendFunc( BlendFactor::Type& srcFactorRgb, BlendFactor::Type& destFactorRgb,
123 BlendFactor::Type& srcFactorAlpha, BlendFactor::Type& destFactorAlpha ) const;
126 * @copydoc Dali::Renderer::SetBlendEquation()
128 void SetBlendEquation( BlendEquation::Type equationRgba );
131 * @copydoc Dali::Renderer::SetBlendEquation()
133 void SetBlendEquation( BlendEquation::Type equationRgb, BlendEquation::Type equationAlpha );
136 * @copydoc Dali::Renderer::GetBlendEquation()
138 void GetBlendEquation( BlendEquation::Type& equationRgb, BlendEquation::Type& equationAlpha ) const;
141 * @copydoc Dali::Renderer::SetBlendColor()
143 void SetBlendColor( const Vector4& color );
146 * @copydoc Dali::Renderer::GetBlendColor()
148 Vector4 GetBlendColor() const;
151 * @copydoc Dali::Renderer::SetIndexedDrawFirstElement
153 void SetIndexedDrawFirstElement( size_t firstElement );
156 * @copydoc Dali::Renderer::SetIndexedDrawElementsCount
158 void SetIndexedDrawElementsCount( size_t elementsCount );
161 * @brief Set whether the Pre-multiplied Alpha Blending is required
163 * @param[in] preMultipled whether alpha is pre-multiplied.
165 void EnablePreMultipliedAlpha( bool preMultipled );
168 * @brief Query whether alpha is pre-multiplied.
170 * @return True is alpha is pre-multiplied, false otherwise.
172 bool IsPreMultipliedAlphaEnabled() const;
175 * @brief Get the scene graph object
177 * @return the scene object
179 SceneGraph::Renderer* GetRendererSceneObject();
181 public: // Default property extensions from Object
184 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
186 virtual unsigned int GetDefaultPropertyCount() const;
189 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
191 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
194 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
196 virtual const char* GetDefaultPropertyName(Property::Index index) const;
199 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
201 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
204 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
206 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
209 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
211 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
214 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
216 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
219 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
221 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
224 * @copydoc Dali::Internal::Object::SetDefaultProperty()
226 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
229 * @copydoc Dali::Internal::Object::SetSceneGraphProperty()
231 virtual void SetSceneGraphProperty( Property::Index index, const PropertyMetadata& entry, const Property::Value& value );
234 * @copydoc Dali::Internal::Object::GetDefaultProperty()
236 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
239 * @copydoc Dali::Internal::Object::GetPropertyOwner()
241 virtual const SceneGraph::PropertyOwner* GetPropertyOwner() const;
244 * @copydoc Dali::Internal::Object::GetSceneObject()
246 virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
249 * @copydoc Dali::Internal::Object::GetSceneObjectAnimatableProperty()
251 virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
254 * @copydoc Dali::Internal::Object::GetSceneObjectInputProperty()
256 virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
259 * @copydoc Dali::Internal::Object::GetPropertyComponentIndex()
261 virtual int GetPropertyComponentIndex( Property::Index index ) const;
263 public: // Functions from Connectable
265 * @copydoc Dali::Internal::Connectable::OnStage()
267 virtual bool OnStage() const;
270 * @copydoc Dali::Internal::Connectable::Connect()
272 virtual void Connect();
275 * @copydoc Dali::Internal::Connectable::Disconnect()
277 virtual void Disconnect();
279 private: // implementation
286 * A reference counted object may only be deleted by calling Unreference()
290 private: // unimplemented methods
291 Renderer( const Renderer& );
292 Renderer& operator=( const Renderer& );
295 SceneGraph::Renderer* mSceneObject;
296 Vector4* mBlendColor; ///< Local copy of blend color, pointer only as its rarely used
297 GeometryPtr mGeometry; ///< Connector that holds the geometry used by this renderer
298 ObjectConnector<TextureSet> mTextureSetConnector; ///< Connector that holds the texture set used by this renderer
299 IntrusivePtr<Shader> mShader; ///< Connector that holds the shader used by this renderer
304 size_t mIndexedDrawFirstElement; ///< Offset of first element to draw from bound index buffer
305 size_t mIndexedDrawElementCount; ///< Number of elements to draw
307 Render::Renderer::StencilParameters mStencilParameters; ///< Struct containing all stencil related options
308 BlendingOptions mBlendingOptions; ///< Local copy of blending options bitmask
310 DepthFunction::Type mDepthFunction:3; ///< Local copy of the depth function
311 FaceCullingMode::Type mFaceCullingMode:2; ///< Local copy of the mode of face culling
312 BlendMode::Type mBlendMode:2; ///< Local copy of the mode of blending
313 DepthWriteMode::Type mDepthWriteMode:2; ///< Local copy of the depth write mode
314 DepthTestMode::Type mDepthTestMode:2; ///< Local copy of the depth test mode
315 bool mWriteToColorBuffer:1; ///< Local copy of the write to color buffer flag
316 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
319 } // namespace Internal
321 // Helpers for public-api forwarding methods
322 inline Internal::Renderer& GetImplementation( Dali::Renderer& handle )
324 DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
326 BaseObject& object = handle.GetBaseObject();
328 return static_cast<Internal::Renderer&>(object);
331 inline const Internal::Renderer& GetImplementation( const Dali::Renderer& handle )
333 DALI_ASSERT_ALWAYS(handle && "Renderer handle is empty");
335 const BaseObject& object = handle.GetBaseObject();
337 return static_cast<const Internal::Renderer&>(object);
342 #endif // DALI_INTERNAL_RENDERER_H