dali/internal/render/renderers/scene-graph-renderer.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDERER_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDERER_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  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>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Internal
  36 {
  37 class Context;
  38 class Texture;
  39 class Program;
  40
  41 namespace SceneGraph
  42 {
  43 class SceneController;
  44 class Shader;
  45 class TextureCache;
  46 class NodeDataProvider;
  47
  48 /**
  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.
  52  */
  53 class Renderer : public GlResourceOwner
  54 {
  55 public:
  56
  57   /**
  58    * Second-phase construction.
  59    * This is called when the renderer is inside render thread
  60    * @param[in] textureCache to use
  61    */
  62   void Initialize( Context& context, TextureCache& textureCache );
  63
  64   /**
  65    * Virtual destructor
  66    */
  67   virtual ~Renderer();
  68
  69   /**
  70    * Set the NodeDataProvider.
  71    * @param[in] dataProvider The node data provider.
  72    */
  73   void SetDataProvider( NodeDataProvider* dataProvider );
  74
  75   /**
  76    * Set the Shader used to render.
  77    * @param[in] shader The shader used to render.
  78    */
  79   void SetShader( Shader* shader );
  80
  81   /**
  82    * Set the face-culling mode.
  83    * @param[in] mode The face-culling mode.
  84    */
  85   void SetCullFace( CullFaceMode mode );
  86
  87   /**
  88    * Set the sampler used to render the set texture.
  89    * @param[in] samplerBitfield The packed sampler options used to render.
  90    */
  91   void SetSampler( unsigned int samplerBitfield );
  92
  93   /**
  94    * Query whether the derived type of Renderer requires depth testing.
  95    * @return True if the renderer requires depth testing.
  96    */
  97   virtual bool RequiresDepthTest() const = 0;
  98
  99   /**
 100    * Called to render during RenderManager::Render().
 101    * @param[in] context The context used for rendering
 102    * @param[in] textureCache The texture cache used to get textures
 103    * @param[in] bufferIndex The index of the previous update buffer.
 104    * @param[in] defaultShader in case there is no custom shader
 105    * @param[in] modelViewMatrix The model-view matrix.
 106    * @param[in] viewMatrix The view matrix.
 107    * @param[in] projectionMatrix The projection matrix.
 108    * @param[in] frametime The elapsed time between the last two updates.
 109    * @param[in] cull Whether to frustum cull this renderer
 110    */
 111   void Render( Context& context,
 112                TextureCache& textureCache,
 113                BufferIndex bufferIndex,
 114                Shader& defaultShader,
 115                const Matrix& modelViewMatrix,
 116                const Matrix& viewMatrix,
 117                const Matrix& projectionMatrix,
 118                float frametime,
 119                bool cull );
 120
 121 protected:
 122   /**
 123    * Protected constructor; only derived classes can be instantiated.
 124    * @param dataprovider for rendering
 125    */
 126   Renderer( NodeDataProvider& dataprovider );
 127
 128 private:
 129
 130   // Undefined
 131   Renderer( const Renderer& );
 132
 133   // Undefined
 134   Renderer& operator=( const Renderer& rhs );
 135
 136   /**
 137    * Checks if renderer's resources are ready to be used.
 138    *
 139    * @return \e true if they are. Otherwise \e false.
 140    */
 141   virtual bool CheckResources() = 0;
 142
 143   /**
 144    * Checks if renderer is culled.
 145    * @param[in] modelMatrix The model matrix.
 146    * @param[in] modelViewProjectionMatrix The MVP matrix.
 147    * @return \e true if it is. Otherwise \e false.
 148    */
 149   virtual bool IsOutsideClipSpace( Context& context, const Matrix& modelMatrix, const Matrix& modelViewProjectionMatrix ) = 0;
 150
 151   /**
 152    * Called from Render prior to DoRender().
 153    * @todo MESH_REWORK Remove after merge
 154    */
 155   virtual void DoSetUniforms( Context& context, BufferIndex bufferIndex, Shader* shader, Program* program );
 156
 157   /**
 158    * Called from Render prior to DoRender(). Default method to set CullFaceMode
 159    * @todo MESH_REWORK Remove after merge
 160    */
 161   virtual void DoSetCullFaceMode( Context& context, BufferIndex bufferIndex );
 162
 163   /**
 164    * Called from Render prior to DoRender(). Default method to set blending options
 165    * @todo MESH_REWORK Remove after merge
 166    */
 167   virtual void DoSetBlending( Context& context, BufferIndex bufferIndex ) = 0;
 168
 169   /**
 170    * Called from Render; implemented in derived classes.
 171    * @param[in] context The context used for rendering
 172    * @param[in] textureCache The texture cache used to get textures
 173    * @param[in] bufferIndex The index of the previous update buffer.
 174    * @param[in] program to use.
 175    * @param[in] modelViewMatrix The model-view matrix.
 176    * @param[in] viewMatrix The view matrix.
 177    */
 178   virtual void DoRender( Context& context, TextureCache& textureCache, BufferIndex bufferIndex, Program& program, const Matrix& modelViewMatrix, const Matrix& viewMatrix ) = 0;
 179
 180 protected:
 181
 182   NodeDataProvider* mDataProvider;        // @todo MESH_REWORK rename to mNodeDataProvider. Shouldn't it be const?
 183
 184   Context* mContextDELETEME; // TODO: MESH_REWORK DELETE THIS
 185   TextureCache* mTextureCacheDELETEME; // TODO: MESH_REWORK DELETE THIS
 186   Shader* mShader;
 187   unsigned int mSamplerBitfield;          ///< Sampler options used for texture filtering
 188
 189 private:
 190
 191   CullFaceMode mCullFaceMode:3;     ///< cullface enum, 3 bits is enough
 192 };
 193
 194 } // namespace SceneGraph
 195
 196 } // namespace Internal
 197
 198 } // namespace Dali
 199
 200 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDERER_H__