dali/internal/update/common/scene-graph-buffers.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_BUFFERS_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_BUFFERS_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/internal/common/buffer-index.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 namespace SceneGraph
  31 {
  32
  33 /**
  34  * Node values (position etc.) are double-buffered.  A SceneGraphBuffers object
  35  * can be used to keep track of which buffers are being written or read.
  36  */
  37 class SceneGraphBuffers
  38 {
  39 public:
  40
  41   static BufferIndex INITIAL_EVENT_BUFFER_INDEX;  // 0
  42   static BufferIndex INITIAL_UPDATE_BUFFER_INDEX; // 1
  43
  44   /**
  45    * Create a SceneGraphBuffers object.
  46    */
  47   SceneGraphBuffers();
  48
  49   /**
  50    * Non-virtual destructor; not intended as a base class.
  51    */
  52   ~SceneGraphBuffers();
  53
  54   /**
  55    * Retrieve the current event-buffer index.
  56    * @return The buffer index.
  57    */
  58   BufferIndex GetEventBufferIndex() const { return mEventBufferIndex; }
  59
  60   /**
  61    * Retrieve the current update-buffer index.
  62    * @return The buffer index.
  63    */
  64   BufferIndex GetUpdateBufferIndex() const { return mUpdateBufferIndex; }
  65
  66   /**
  67    * Swap the Event & Update buffer indices.
  68   */
  69   void Swap();
  70
  71 private:
  72
  73   // Undefined
  74   SceneGraphBuffers(const SceneGraphBuffers&);
  75
  76   // Undefined
  77   SceneGraphBuffers& operator=(const SceneGraphBuffers& rhs);
  78
  79 private:
  80
  81   BufferIndex mEventBufferIndex;  ///< 0 or 1 (opposite of mUpdateBufferIndex)
  82   BufferIndex mUpdateBufferIndex; ///< 0 or 1 (opposite of mEventBufferIndex)
  83 };
  84
  85 } // namespace SceneGraph
  86
  87 } // namespace Internal
  88
  89 } // namespace Dali
  90
  91 #endif // __DALI_INTERNAL_SCENE_GRAPH_BUFFERS_H__