1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/math/matrix.h>
23 #include <dali/public-api/math/viewport.h>
24 #include <dali/internal/render/common/render-list.h>
37 * A set of rendering instructions consisting of:
38 * - The list(s) of renderers sorted in the correct rendering order.
39 * - The camera related matrices to use when rendering.
40 * - An optional off-screen render target.
41 * There is one RenderInstruction per RenderTarget, all renderers of all layers
42 * get collated onto the single list of lists (mRenderLists)
44 class RenderInstruction
49 * Default constructor so this can be stored in STL containers
59 * Get the next free Renderlist
60 * @param capacityRequired in this list
61 * @return the renderlist
63 RenderList& GetNextFreeRenderList( size_t capacityRequired );
66 * Inform the RenderInstruction that processing for this frame is complete
67 * This method should only be called from Update thread
69 void UpdateCompleted();
72 * @return the count of active Renderlists
74 RenderListContainer::SizeType RenderListCount() const;
77 * Return the renderlist at given index
78 * @pre index is inside the valid range of initialized lists
79 * @param index of list to return
80 * @return pointer to the renderlist
82 const RenderList* GetRenderList( RenderListContainer::SizeType index ) const;
85 * Reset render-instruction
86 * render-lists are cleared but not released, while matrices and other settings reset in
87 * preparation for building a set of instructions for the renderer.
89 * @param[in] viewMatrix The view matrix.
90 * @param[in] projectionMatrix The projection matrix.
91 * @param[in] offscreenId A resource Id of an off-screen render target, or 0
92 * @param[in] viewport A pointer to a viewport, of NULL.
93 * @param[in] clearColor A pointer to a color to clear with, or NULL if no clear is required.
95 void Reset( const Matrix* viewMatrix,
96 const Matrix* projectionMatrix,
97 unsigned int offscreenId,
98 const Viewport* viewport,
99 const Vector4* clearColor );
104 RenderInstruction(const RenderInstruction&);
106 RenderInstruction& operator=(const RenderInstruction& rhs);
108 public: // Data, TODO hide these
110 const Matrix* mViewMatrix; ///< Pointer to a View Matrix (owned by camera)
111 const Matrix* mProjectionMatrix; ///< Pointer to a Projection Matrix (owned by camera)
112 RenderTracker* mRenderTracker; ///< Pointer to an optional tracker object (not owned)
114 Viewport mViewport; ///< Optional viewport
115 Vector4 mClearColor; ///< Optional color to clear with
116 bool mIsViewportSet:1; ///< Flag to determine whether the viewport is set
117 bool mIsClearColorSet:1; ///< Flag to determine whether the clear-color is set
119 unsigned int mOffscreenTextureId; ///< Optional offscreen target
123 RenderListContainer mRenderLists; ///< container of all render lists
124 RenderListContainer::SizeType mNextFreeRenderList; ///< index for the next free render list
128 } // namespace SceneGraph
130 } // namespace Internal
134 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_INSTRUCTION_H__