1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDERER_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDERER_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/math/matrix.h>
23 #include <dali/public-api/math/vector4.h>
24 #include <dali/internal/common/blending-options.h>
25 #include <dali/internal/common/message.h>
26 #include <dali/internal/event/effects/shader-declarations.h>
27 #include <dali/internal/render/gl-resources/gl-resource-owner.h>
28 #include <dali/internal/render/renderers/scene-graph-renderer-declarations.h>
29 #include <dali/integration-api/debug.h>
30 #include <dali/internal/common/type-abstraction-enums.h>
43 class SceneController;
46 class NodeDataProvider;
49 * Renderers are used to render images, text, & meshes etc.
50 * These objects are used during RenderManager::Render(), so properties modified during
51 * the Update must either be double-buffered, or set via a message added to the RenderQueue.
53 class Renderer : public GlResourceOwner
58 * Second-phase construction.
59 * This is called when the renderer is inside render thread
60 * @param[in] textureCache to use
62 void Initialize( Context& context, TextureCache& textureCache );
70 * Set the Shader used to render.
71 * @param[in] shader The shader used to render.
73 void SetShader( Shader* shader );
76 * Set whether the ImageRenderer should use blending
77 * @param[in] useBlend True if blending should be used.
79 void SetUseBlend( bool useBlend );
82 * Set the blending options.
83 * @param[in] options A bitmask of blending options.
85 void SetBlendingOptions( unsigned int options );
88 * Set the blend color.
89 * @param[in] color The new blend-color.
91 void SetBlendColor( const Vector4& color );
94 * Set the face-culling mode.
95 * @param[in] mode The face-culling mode.
97 void SetCullFace( CullFaceMode mode );
100 * Set the sampler used to render the set texture.
101 * @param[in] samplerBitfield The packed sampler options used to render.
103 void SetSampler( unsigned int samplerBitfield );
106 * Query whether the derived type of Renderer requires depth testing.
107 * @return True if the renderer requires depth testing.
109 virtual bool RequiresDepthTest() const = 0;
112 * Called to render during RenderManager::Render().
113 * @param[in] context The context used for rendering
114 * @param[in] textureCache The texture cache used to get textures
115 * @param[in] bufferIndex The index of the previous update buffer.
116 * @param[in] defaultShader in case there is no custom shader
117 * @param[in] modelViewMatrix The model-view matrix.
118 * @param[in] viewMatrix The view matrix.
119 * @param[in] projectionMatrix The projection matrix.
120 * @param[in] frametime The elapsed time between the last two updates.
121 * @param[in] cull Whether to frustum cull this renderer
123 void Render( Context& context,
124 TextureCache& textureCache,
125 BufferIndex bufferIndex,
126 Shader& defaultShader,
127 const Matrix& modelViewMatrix,
128 const Matrix& viewMatrix,
129 const Matrix& projectionMatrix,
135 * Protected constructor; only derived classes can be instantiated.
136 * @param dataprovider for rendering
138 Renderer( NodeDataProvider& dataprovider );
143 Renderer( const Renderer& );
146 Renderer& operator=( const Renderer& rhs );
149 * Checks if renderer's resources are ready to be used.
151 * @return \e true if they are. Otherwise \e false.
153 virtual bool CheckResources() = 0;
156 * Checks if renderer is culled.
157 * @param[in] modelMatrix The model matrix.
158 * @param[in] modelViewProjectionMatrix The MVP matrix.
159 * @return \e true if it is. Otherwise \e false.
161 virtual bool IsOutsideClipSpace( Context& context, const Matrix& modelMatrix, const Matrix& modelViewProjectionMatrix ) = 0;
164 * Called from Render prior to DoRender().
165 * @todo MESH_REWORK Remove after merge
167 virtual void DoSetUniforms( Context& context, BufferIndex bufferIndex, Shader* shader, Program* program );
170 * Called from Render prior to DoRender(). Default method to set CullFaceMode
171 * @todo MESH_REWORK Remove after merge
173 virtual void DoSetCullFaceMode( Context& context, BufferIndex bufferIndex );
176 * Called from Render prior to DoRender(). Default method to set blending options
177 * @todo MESH_REWORK Remove after merge
179 virtual void DoSetBlending( Context& context, BufferIndex bufferIndex );
182 * Called from Render; implemented in derived classes.
183 * @param[in] context The context used for rendering
184 * @param[in] textureCache The texture cache used to get textures
185 * @param[in] bufferIndex The index of the previous update buffer.
186 * @param[in] program to use.
187 * @param[in] modelViewMatrix The model-view matrix.
188 * @param[in] viewMatrix The view matrix.
190 virtual void DoRender( Context& context, TextureCache& textureCache, BufferIndex bufferIndex, Program& program, const Matrix& modelViewMatrix, const Matrix& viewMatrix ) = 0;
194 NodeDataProvider& mDataProvider; // @todo MESH_REWORK rename to mNodeDataProvider. Shouldn't it be const?
196 Context* mContextDELETEME; // TODO: MESH_REWORK DELETE THIS
197 TextureCache* mTextureCacheDELETEME; // TODO: MESH_REWORK DELETE THIS
199 unsigned int mSamplerBitfield; ///< Sampler options used for texture filtering
201 bool mUseBlend:1; ///< True if blending should be enabled, 1 bit is enough
204 BlendingOptions mBlendingOptions;
205 CullFaceMode mCullFaceMode:3; ///< cullface enum, 3 bits is enough
208 } // namespace SceneGraph
210 } // namespace Internal
214 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDERER_H__