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) 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/internal/common/buffer-index.h>
  23 #include <dali/internal/update/manager/sorted-layers.h>
  24 #include <dali/integration-api/resource-declarations.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31
  32 namespace Render
  33 {
  34 class Geometry;
  35 }
  36
  37 namespace SceneGraph
  38 {
  39 class RenderTracker;
  40 struct RenderItem;
  41 class Shader;
  42
  43 /**
  44  * Structure to store information for sorting the renderers.
  45  * (Note, depthIndex is stored within the renderItem).
  46  */
  47 struct RendererWithSortAttributes
  48 {
  49   RendererWithSortAttributes()
  50   : renderItem( NULL ),
  51     shader(NULL),
  52     textureResourceId( Integration::InvalidResourceId ),
  53     geometry(NULL),
  54     zValue(0.0f)
  55   {
  56   }
  57
  58   RenderItem*                   renderItem;       ///< The render item that is being sorted (includes depth index)
  59   const Shader*                 shader;           ///< The shader instance
  60   Integration::ResourceId       textureResourceId;///< The first texture resource ID of the texture set instance, is InvalidResourceId if the texture set doesn't have any textures
  61   const Render::Geometry*       geometry;         ///< The geometry instance
  62   float                         zValue;           ///< The zValue of the given renderer (either distance from camera, or a custom calculated value)
  63 };
  64
  65 typedef std::vector< RendererWithSortAttributes > RendererSortingHelper;
  66
  67 class RenderTask;
  68 class RenderInstructionContainer;
  69
  70 /**
  71  * Sorts and prepares the list of opaque/transparent renderers for each layer.
  72  * Whilst iterating through each layer, update the renderitems ModelView matrices
  73  *
  74  * The opaque and transparent render lists are sorted first by depth
  75  * index, then by Z (for transparent only), then by shader, texture
  76  * and geometry. The render algorithm should then work through both
  77  * lists simultaneously, working through opaque then transparent
  78  * items at each depth index, resetting the flags appropriately.
  79  *
  80  * @param[in] updateBufferIndex The current update buffer index.
  81  * @param[in] sortedLayers The layers containing lists of opaque/transparent renderables.
  82  * @param[in] renderTask The rendering task information.
  83  * @param[in] sortingHelper to avoid allocating containers for sorting every frame
  84  * @param[in] cull Whether frustum culling is enabled or not
  85  * @param[out] instructions The rendering instructions for the next frame.
  86  */
  87 void PrepareRenderInstruction( BufferIndex updateBufferIndex,
  88                                SortedLayerPointers& sortedLayers,
  89                                RenderTask& renderTask,
  90                                RendererSortingHelper& sortingHelper,
  91                                bool cull,
  92                                RenderInstructionContainer& instructions );
  93
  94 } // namespace SceneGraph
  95
  96 } // namespace Internal
  97
  98 } // namespace Dali
  99
 100 #endif // __DALI_INTERNAL_SCENE_GRAPH_PREPARE_RENDER_INSTRUCTIONS_H__