1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_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/actors/image-actor.h>
23 #include <dali/internal/common/owner-pointer.h>
24 #include <dali/internal/update/resources/resource-manager-declarations.h>
25 #include <dali/internal/render/gl-resources/context.h>
26 #include <dali/internal/render/gl-resources/texture-observer.h>
27 #include <dali/internal/render/renderers/scene-graph-renderer.h>
38 class NodeDataProvider;
41 * Used to render an image.
43 class ImageRenderer : public Renderer, public TextureObserver
47 typedef Dali::ImageActor::PixelArea PixelArea;
56 GRID_NINE_PATCH_NO_CENTER ///< Not supported yet.
60 * Create a new ImageRenderer.
61 * @param dataprovider to render
62 * @return The newly allocated ImageRenderer.
64 static ImageRenderer* New( NodeDataProvider& dataprovider );
69 virtual ~ImageRenderer();
72 * Set the texture used to render.
73 * @param[in] textureId The id of the texture used to render.
75 void SetTextureId( ResourceId textureId );
78 * Set the pixel area for the renderer
79 * @param[in] pixelArea An area within the texture, used when building UV coordinates.
81 void SetPixelArea( const ImageRenderer::PixelArea& pixelArea );
84 * Set 9 patch border for the image renderer
85 * @param[in] border The border for nine-patch meshes.
86 * @param[in] borderInPixels True if border is in pixels instead of percentages.
88 void SetNinePatchBorder( const Vector4& border, bool inPixels );
91 * Calculate the mesh data used by the ImageRenderer.
92 * @param[in] type The type of mesh data required; either quad, nine-patch or grid.
93 * @param[in] targetSize The size which the mesh data should fit inside.
94 * @param[in] usePixelArea whether to use pixel area or not
96 void CalculateMeshData( MeshType type, const Vector2& targetSize, bool usePixelArea );
99 * @copydoc Dali::Internal::GlResourceOwner::GlContextDestroyed()
101 virtual void GlContextDestroyed();
104 * @copydoc Dali::Internal::GlResourceOwner::GlCleanup()
106 virtual void GlCleanup();
109 * @copydoc Dali::Internal::SceneGraph::Renderer::RequiresDepthTest()
111 virtual bool RequiresDepthTest() const;
114 * @copydoc Dali::Internal::SceneGraph::Renderer::CheckResources()
116 virtual bool CheckResources();
119 * @copydoc Dali::Internal::SceneGraph::Renderer::ResolveGeometryTypes()
121 virtual void ResolveGeometryTypes( BufferIndex bufferIndex, GeometryType& outType, ShaderSubTypes& outSubType );
124 * @copydoc Dali::Internal::SceneGraph::Renderer::IsOutsideClipSpace()
126 virtual bool IsOutsideClipSpace( Context& context, const Matrix& modelMatrix, const Matrix& modelViewProjectionMatrix );
129 * @copydoc Dali::Internal::SceneGraph::Renderer::DoRender()
131 virtual void DoRender( Context& context, TextureCache& textureCache, BufferIndex bufferIndex, Program& program, const Matrix& modelViewMatrix, const Matrix& viewMatrix );
133 protected: // TextureObserver implementation
136 * @copydoc Dali::Internal::TextureObserver::TextureDiscarded()
138 virtual void TextureDiscarded( ResourceId textureId );
142 * Helper to update the vertex buffer.
144 void UpdateVertexBuffer( Context& context, GLsizeiptr size, const GLvoid *data );
147 * Helper to update the index buffer.
149 void UpdateIndexBuffer( Context& context, GLsizeiptr size, const GLvoid *data );
152 * Helper to generate mesh data when required
153 * @param[in] texture Texture from which to get UV data
155 void GenerateMeshData( Texture* texture );
158 * Helper to fill vertex/index buffers with quad data.
159 * (Quads are simple meshes, and thus have a specialised mesh generation method)
161 * @param[in] texture Texture from which to get UV data
163 * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
165 void SetQuadMeshData( Texture* texture, const Vector2& size, const PixelArea* pixelArea );
168 * Helper to fill vertex/index buffers with nine-patch data.
169 * (9-Patches are simple meshes, and thus have a specialised mesh generation method)
171 * @param[in] texture Texture from which to get UV data
172 * @param[in] size The target size.
173 * @param[in] border 9 patch border information.
174 * @param[in] borderInPixels True if border is in pixels instead of percentages.
175 * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
176 * @param[in] noCenter True if the center section of nine patch should not be rendered.
178 void SetNinePatchMeshData( Texture* texture, const Vector2& size, const Vector4& border, bool borderInPixels, const PixelArea* pixelArea, bool noCenter );
181 * Helper to fill vertex/index buffers with grid data.
182 * This can build grid meshes that are either of type Quad or type 9-Patch
184 * @param[in] size The target size.
185 * @param[in] border 9 patch border information (pass NULL for no border i.e. a standard Quad)
186 * @param[in] borderInPixels True if border is in pixels instead of percentages.
187 * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
189 void SetGridMeshData( Texture* texture, const Vector2& size, const Vector4* border, bool borderInPixels, const PixelArea* pixelArea );
192 * Helper to fill index buffer with uniform grid data.
193 * @param[in] indices pointer to indices buffer to be filled
194 * @param[in] rectanglesX number of columns for rectangles in grid
195 * @param[in] rectanglesY number of rows for rectangles in grid
197 void GenerateMeshIndices(GLushort* indices, int rectanglesX, int rectanglesY);
200 * Private constructor. @see New()
202 ImageRenderer( NodeDataProvider& dataprovider );
205 ImageRenderer( const ImageRenderer& );
208 ImageRenderer& operator=( const ImageRenderer& rhs );
214 OwnerPointer< GpuBuffer > mVertexBuffer;
215 OwnerPointer< GpuBuffer > mIndexBuffer;
218 PixelArea mPixelArea;
219 Vector2 mGeometrySize;
220 ResourceId mTextureId;
223 MeshType mMeshType : 3; // 4 values fits in 3 bits just fine
224 bool mIsMeshGenerated : 1;
225 bool mBorderInPixels : 1;
226 bool mUsePixelArea : 1;
230 } // namespace SceneGraph
232 } // namespace Internal
236 #endif // __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_H__