directfb-renderer.h

/***********************************************************************
    filename:   directfb-renderer.h
    author:     Keith Mok
*************************************************************************/
/***************************************************************************
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _directfbrenderer_h_
#define _directfbrenderer_h_

#include "CEGUIBase.h"
#include <directfb.h>

#include <vector>
#include <list>

#include "CEGUIRenderer.h"
#include "CEGUITexture.h"


// Start of CEGUI namespace section
namespace CEGUI
{
  /*************************************************************************
    Forward refs
  *************************************************************************/
  class DirectfbTexture;
  class ImageCodec;
  class DynamicModule;

  class DirectfbRenderer : public Renderer
  {
  public:
    DirectfbRenderer(IDirectFB *device, IDirectFBSurface *surface, ImageCodec* codec = 0);

    virtual ~DirectfbRenderer(void);

    // add's a quad to the list to be rendered
    virtual    void    addQuad(const Rect& dest_rect, float z, const Texture* tex, const Rect& texture_rect, const ColourRect& colours, QuadSplitMode quad_split_mode);

    // perform final rendering for all queued renderable quads.
    virtual    void    doRender(void);

    // clear the queue
    virtual    void    clearRenderList(void);


    virtual void    setQueueingEnabled(bool setting)        {d_queueing = setting;}


    // create an empty texture
    virtual    Texture*    createTexture(void);

    // create a texture and load it with the specified file.
    virtual    Texture*    createTexture(const String& filename, const String& resourceGroup);

    // create a texture and set it to the specified size
    virtual    Texture*    createTexture(float size);

    // destroy the given texture
    virtual    void        destroyTexture(Texture* texture);

    // destroy all textures still active
    virtual void        destroyAllTextures(void);

    // return ptr to device
    IDirectFB*    getDevice(void) const           {return d_device;}


    virtual bool    isQueueingEnabled(void) const    {return d_queueing;}


    virtual float    getWidth(void) const        {return d_display_area.getWidth();}


    virtual float    getHeight(void) const        {return d_display_area.getHeight();}


    virtual Size    getSize(void) const            {return d_display_area.getSize();}


    virtual Rect    getRect(void) const            {return d_display_area;}


    virtual    uint    getMaxTextureSize(void) const        {return d_maxTextureSize;}


    virtual    uint    getHorzScreenDPI(void) const    {return 96;}


    virtual    uint    getVertScreenDPI(void) const    {return 96;}

    ImageCodec& getImageCodec(void);


    void setImageCodec(const String& codecName);

    void setImageCodec(ImageCodec* codec);


    static void setDefaultImageCodecName(const String& codecName);

    static const String& getDefaultImageCodecName();


  private:
    /************************************************************************
        Implementation Constants
    ************************************************************************/

    /*************************************************************************
        Implementation Structs & classes
    *************************************************************************/
    struct RenderQuad
    {
      IDirectFBSurface    *tex;
      Rect        position;
      float        z;
      Rect        texPosition;
      ColourRect    colours;
    };


    /*************************************************************************
        Implementation Methods
    *************************************************************************/
    // render a quad directly to the display
    void     doRender(RenderQuad *quad);
    void     sortQuads(void);

    // setup image codec
    void setupImageCodec(const String& codecName);

    // cleanup image codec
    void cleanupImageCodec();


    /*************************************************************************
        Implementation Data
    *************************************************************************/
    // std sorting RenderQuad class
    struct quadsorter
        : public std::binary_function<RenderQuad*, RenderQuad*, bool>
    {
        bool operator()(const RenderQuad& _Left, const RenderQuad& _Right) const
        {return (_Left.z > _Right.z);}
    };

    // list ot quads we want to render
    std::vector<RenderQuad> d_quadlist;


    IDirectFBSurface    *d_surface;
    IDirectFB        *d_device;
    Rect        d_display_area;
    bool        d_queueing;            

    std::list<DirectfbTexture*>    d_texturelist;        
    uint    d_maxTextureSize;        

    ImageCodec* d_imageCodec;           
    DynamicModule* d_imageCodecModule; 

    static String d_defaultImageCodecName; 

  };

} // End of  CEGUI namespace section

#endif    // end of guard _openglrenderer_h_