dali/internal/update/manager/prepare-render-instructions.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_PREPARE_RENDER_INSTRUCTIONS_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_PREPARE_RENDER_INSTRUCTIONS_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/internal/common/buffer-index.h>
  23 #include <dali/internal/update/manager/sorted-layers.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 namespace SceneGraph
  32 {
  33 class RenderTracker;
  34 class RenderItem;
  35 class Shader;
  36 class Material;
  37 class Geometry;
  38
  39 /**
  40  * Structure to store information for sorting the renderers.
  41  * (Note, depthIndex is stored within the renderItem).
  42  */
  43 struct RendererWithSortAttributes
  44 {
  45   RendererWithSortAttributes()
  46   : renderItem( NULL ),
  47     shader(NULL),
  48     material(NULL),
  49     geometry(NULL),
  50     zValue(0.0f)
  51   {
  52   }
  53
  54   RenderItem* renderItem;       ///< The render item that is being sorted (includes depth index)
  55   Shader*     shader;           ///< The shader instance
  56   Material*   material;         ///< The material instance
  57   Geometry*   geometry;         ///< The geometry instance
  58   float       zValue;           // The zValue of the given renderer (either distance from camera, or a custom calculated value)
  59 };
  60
  61 typedef std::vector< RendererWithSortAttributes > RendererSortingHelper;
  62
  63 class RenderTask;
  64 class RenderInstructionContainer;
  65
  66 /**
  67  * Sorts and prepares the list of opaque/transparent renderable
  68  * attachments for each layer.  Whilst iterating through each layer,
  69  * update the attachments ModelView matrices
  70  *
  71  * The opaque and transparent render lists are sorted first by depth
  72  * index, then by Z (for transparent only), then by shader, material
  73  * and geometry. The render algorithm should then work through both
  74  * lists simultaneously, working through opaque then transparent
  75  * items at each depth index, resetting the flags appropriately.
  76  *
  77  * @param[in] updateBufferIndex The current update buffer index.
  78  * @param[in] sortedLayers The layers containing lists of opaque/transparent renderables.
  79  * @param[in] renderTask The rendering task information.
  80  * @param[in] renderTracker A tracker object if we need to know when this render instruction has actually rendered, or NULL if tracking is not required
  81  * @param[out] instructions The rendering instructions for the next frame.
  82  */
  83 void PrepareRenderInstruction( BufferIndex updateBufferIndex,
  84                                SortedLayerPointers& sortedLayers,
  85                                RenderTask& renderTask,
  86                                RendererSortingHelper& sortingHelper,
  87                                RenderTracker* renderTracker,
  88                                RenderInstructionContainer& instructions );
  89
  90 } // namespace SceneGraph
  91
  92 } // namespace Internal
  93
  94 } // namespace Dali
  95
  96 #endif // __DALI_INTERNAL_SCENE_GRAPH_PREPARE_RENDER_INSTRUCTIONS_H__