dali/internal/render/common/render-instruction.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__
   3
   4 /*
   5  * Copyright (c) 2016 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/viewport.h>
  24 #include <dali/internal/update/render-tasks/scene-graph-camera.h>
  25 #include <dali/internal/render/common/render-list.h>
  26 #include <dali/internal/render/renderers/render-frame-buffer.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 namespace Render
  35 {
  36 class RenderTracker;
  37 }
  38
  39 namespace SceneGraph
  40 {
  41
  42 /**
  43  * A set of rendering instructions consisting of:
  44  * - The list(s) of renderers sorted in the correct rendering order.
  45  * - The camera related matrices to use when rendering.
  46  * - An optional off-screen render target.
  47  * There is one RenderInstruction per RenderTarget, all renderers of all layers
  48  * get collated onto the single list of lists (mRenderLists)
  49  */
  50 class RenderInstruction
  51 {
  52 public:
  53
  54   /**
  55    * Default constructor so this can be stored in STL containers
  56    */
  57   RenderInstruction();
  58
  59   /**
  60    * Destructor
  61    */
  62   ~RenderInstruction();
  63
  64   /**
  65    * Get the next free Renderlist
  66    * @param capacityRequired in this list
  67    * @return the renderlist
  68    */
  69   RenderList& GetNextFreeRenderList( size_t capacityRequired );
  70
  71   /**
  72    * Inform the RenderInstruction that processing for this frame is complete
  73    * This method should only be called from Update thread
  74    */
  75   void UpdateCompleted();
  76
  77   /**
  78    * @return the count of active Renderlists
  79    */
  80   RenderListContainer::SizeType RenderListCount() const;
  81
  82   /**
  83    * Return the renderlist at given index
  84    * @pre index is inside the valid range of initialized lists
  85    * @param index of list to return
  86    * @return pointer to the renderlist, or null if the index is out of bounds.
  87    */
  88   const RenderList* GetRenderList( RenderListContainer::SizeType index ) const;
  89
  90   /**
  91    * Reset render-instruction
  92    * render-lists are cleared but not released, while matrices and other settings reset in
  93    * preparation for building a set of instructions for the renderer.
  94    *
  95    * @param[in] camera to use to get view and projection matrices.
  96    * @param[in] offscreenId A resource Id of an off-screen render target, or 0
  97    * @param[in] viewport A pointer to a viewport, of NULL.
  98    * @param[in] clearColor A pointer to a color to clear with, or NULL if no clear is required.
  99    */
 100   void Reset( Camera* camera,
 101               Render::FrameBuffer* frameBuffer,
 102               const Viewport* viewport,
 103               const Vector4* clearColor );
 104
 105   /**
 106    * Get the view matrix for rendering
 107    * @param index of the rendering side
 108    * @return the view matrix
 109    */
 110   const Matrix* GetViewMatrix( BufferIndex index ) const
 111   {
 112     // inlined as this is called once per frame per render instruction
 113     return &mCamera->GetViewMatrix( index );
 114   }
 115
 116   /**
 117    * Get the projection matrix for rendering
 118    * @param index of the rendering side
 119    * @return the projection matrix
 120    */
 121   const Matrix* GetProjectionMatrix( BufferIndex index ) const
 122   {
 123     // inlined as this is called once per frame per render instruction
 124     return &mCamera->GetProjectionMatrix( index );
 125   }
 126
 127 private:
 128
 129   // Undefined
 130   RenderInstruction(const RenderInstruction&);
 131   // Undefined
 132   RenderInstruction& operator=(const RenderInstruction& rhs);
 133
 134 public: // Data
 135
 136   Render::RenderTracker* mRenderTracker;        ///< Pointer to an optional tracker object (not owned)
 137
 138   Viewport mViewport;                   ///< Optional viewport
 139   Vector4  mClearColor;                 ///< Optional color to clear with
 140   bool     mIsViewportSet:1;            ///< Flag to determine whether the viewport is set
 141   bool     mIsClearColorSet:1;          ///< Flag to determine whether the clearColor is set
 142
 143   Render::FrameBuffer* mFrameBuffer;
 144
 145 private: // Data
 146
 147   Camera* mCamera;  ///< camera that is used
 148   RenderListContainer mRenderLists;     ///< container of all render lists
 149   RenderListContainer::SizeType mNextFreeRenderList;     ///< index for the next free render list
 150
 151 };
 152
 153 } // namespace SceneGraph
 154
 155 } // namespace Internal
 156
 157 } // namespace Dali
 158
 159 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__