dali/internal/render/renderers/scene-graph-image-renderer.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_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/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>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34 class GpuBuffer;
  35
  36 namespace SceneGraph
  37 {
  38 class NodeDataProvider;
  39
  40 /**
  41  * Used to render an image.
  42  */
  43 class ImageRenderer : public Renderer, public TextureObserver
  44 {
  45 public:
  46
  47   typedef Dali::ImageActor::PixelArea PixelArea;
  48
  49   enum MeshType
  50   {
  51     QUAD,
  52     NINE_PATCH,
  53     NINE_PATCH_NO_CENTER,
  54     GRID_QUAD,
  55     GRID_NINE_PATCH,
  56     GRID_NINE_PATCH_NO_CENTER ///< Not supported yet.
  57   };
  58
  59   /**
  60    * Create a new ImageRenderer.
  61    * @param dataprovider to render
  62    * @return The newly allocated ImageRenderer.
  63    */
  64   static ImageRenderer* New( NodeDataProvider& dataprovider );
  65
  66   /**
  67    * Virtual destructor
  68    */
  69   virtual ~ImageRenderer();
  70
  71   /**
  72    * Set the texture used to render.
  73    * @param[in] textureId The id of the texture used to render.
  74    */
  75   void SetTextureId( ResourceId textureId );
  76
  77   /**
  78    * Set the pixel area for the renderer
  79    * @param[in] pixelArea An area within the texture, used when building UV coordinates.
  80    */
  81   void SetPixelArea( const ImageRenderer::PixelArea& pixelArea );
  82
  83   /**
  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.
  87    */
  88   void SetNinePatchBorder( const Vector4& border, bool inPixels );
  89
  90   /**
  91    * Set whether the ImageRenderer should use blending
  92    * @param[in] useBlend True if blending should be used.
  93    */
  94   void SetUseBlend( bool useBlend );
  95
  96   /**
  97    * Set the blending options.
  98    * @param[in] options A bitmask of blending options.
  99    */
 100   void SetBlendingOptions( unsigned int options );
 101
 102   /**
 103    * Set the blend color.
 104    * @param[in] color The new blend-color.
 105    */
 106   void SetBlendColor( const Vector4& color );
 107
 108   /**
 109    * Calculate the mesh data used by the ImageRenderer.
 110    * @param[in] type The type of mesh data required; either quad, nine-patch or grid.
 111    * @param[in] targetSize The size which the mesh data should fit inside.
 112    * @param[in] usePixelArea whether to use pixel area or not
 113    */
 114   void CalculateMeshData( MeshType type, const Vector2& targetSize, bool usePixelArea );
 115
 116   /**
 117    * @copydoc Dali::Internal::GlResourceOwner::GlContextDestroyed()
 118    */
 119   virtual void GlContextDestroyed();
 120
 121   /**
 122    * @copydoc Dali::Internal::GlResourceOwner::GlCleanup()
 123    */
 124   virtual void GlCleanup();
 125
 126   /**
 127    * @copydoc Dali::Internal::SceneGraph::Renderer::RequiresDepthTest()
 128    */
 129   virtual bool RequiresDepthTest() const;
 130
 131   /**
 132    * @copydoc Dali::Internal::SceneGraph::Renderer::CheckResources()
 133    */
 134   virtual bool CheckResources();
 135
 136   /**
 137    * @copydoc Dali::Internal::SceneGraph::Renderer::IsOutsideClipSpace()
 138    */
 139   virtual bool IsOutsideClipSpace( Context& context, const Matrix& modelMatrix, const Matrix& modelViewProjectionMatrix );
 140
 141   /**
 142    * @copydoc Dali::Internal::SceneGraph::Renderer::DoRender()
 143    */
 144   virtual void DoRender( Context& context, TextureCache& textureCache, BufferIndex bufferIndex, Program& program, const Matrix& modelViewMatrix, const Matrix& viewMatrix );
 145
 146   /**
 147    * @copydoc Dali::Internal::SceneGraph::Renderer::DoSetBlending()
 148    */
 149   virtual void DoSetBlending( Context& context, BufferIndex bufferIndex );
 150
 151 protected: // TextureObserver implementation
 152
 153   /**
 154    * @copydoc Dali::Internal::TextureObserver::TextureDiscarded()
 155    */
 156   virtual void TextureDiscarded( ResourceId textureId );
 157
 158 private:
 159   /**
 160    * Helper to update the vertex buffer.
 161    */
 162   void UpdateVertexBuffer( Context& context, GLsizeiptr size, const GLvoid *data );
 163
 164   /**
 165    * Helper to update the index buffer.
 166    */
 167   void UpdateIndexBuffer( Context& context, GLsizeiptr size, const GLvoid *data );
 168
 169   /**
 170    * Helper to generate mesh data when required
 171    * @param[in] texture Texture from which to get UV data
 172    */
 173   void GenerateMeshData( Texture* texture );
 174
 175   /**
 176    * Helper to fill vertex/index buffers with quad data.
 177    * (Quads are simple meshes, and thus have a specialised mesh generation method)
 178    *
 179    * @param[in] texture Texture from which to get UV data
 180    * @param[in] size
 181    * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
 182    */
 183   void SetQuadMeshData( Texture* texture, const Vector2& size, const PixelArea* pixelArea );
 184
 185   /**
 186    * Helper to fill vertex/index buffers with nine-patch data.
 187    * (9-Patches are simple meshes, and thus have a specialised mesh generation method)
 188    *
 189    * @param[in] texture Texture from which to get UV data
 190    * @param[in] size The target size.
 191    * @param[in] border 9 patch border information.
 192    * @param[in] borderInPixels True if border is in pixels instead of percentages.
 193    * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
 194    * @param[in] noCenter True if the center section of nine patch should not be rendered.
 195    */
 196   void SetNinePatchMeshData( Texture* texture, const Vector2& size, const Vector4& border, bool borderInPixels, const PixelArea* pixelArea, bool noCenter );
 197
 198   /**
 199    * Helper to fill vertex/index buffers with grid data.
 200    * This can build grid meshes that are either of type Quad or type 9-Patch
 201    *
 202    * @param[in] size The target size.
 203    * @param[in] border 9 patch border information (pass NULL for no border i.e. a standard Quad)
 204    * @param[in] borderInPixels True if border is in pixels instead of percentages.
 205    * @param[in] pixelArea An area within the texture, used when building UV coordinates. A value of NULL means use default image size.
 206    */
 207   void SetGridMeshData( Texture* texture, const Vector2& size, const Vector4* border, bool borderInPixels, const PixelArea* pixelArea );
 208
 209   /**
 210    * Helper to fill index buffer with uniform grid data.
 211    * @param[in] indices pointer to indices buffer to be filled
 212    * @param[in] rectanglesX number of columns for rectangles in grid
 213    * @param[in] rectanglesY number of rows for rectangles in grid
 214    */
 215   void GenerateMeshIndices(GLushort* indices, int rectanglesX, int rectanglesY);
 216
 217   /**
 218    * Private constructor. @see New()
 219    */
 220   ImageRenderer( NodeDataProvider& dataprovider );
 221
 222   // Undefined
 223   ImageRenderer( const ImageRenderer& );
 224
 225   // Undefined
 226   ImageRenderer& operator=( const ImageRenderer& rhs );
 227
 228 private:
 229
 230   Texture*    mTexture;
 231
 232   OwnerPointer< GpuBuffer > mVertexBuffer;
 233   OwnerPointer< GpuBuffer > mIndexBuffer;
 234
 235   Vector4   mBorder;
 236   PixelArea mPixelArea;
 237   Vector2   mGeometrySize;
 238   ResourceId  mTextureId;
 239
 240   BlendingOptions mBlendingOptions;
 241
 242   // flags
 243   MeshType  mMeshType        : 3; // 4 values fits in 3 bits just fine
 244   bool      mIsMeshGenerated : 1;
 245   bool      mBorderInPixels  : 1;
 246   bool      mUseBlend        : 1; ///< True if blending should be enabled, 1 bit is enough
 247   bool      mUsePixelArea    : 1;
 248
 249 };
 250
 251 } // namespace SceneGraph
 252
 253 } // namespace Internal
 254
 255 } // namespace Dali
 256
 257 #endif // __DALI_INTERNAL_SCENE_GRAPH_IMAGE_RENDERER_H__