/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __UNIQUE__STRET_H__
#define __UNIQUE__STRET_H__

#include <directfb.h>

#include <unique/types.h>

/*
 * A 'StReT' is a Stack Region Tree.
 */


typedef enum {
     SRF_NONE       = 0x00000000,

     SRF_INPUT      = 0x00000001,
     SRF_OUTPUT     = 0x00000002,
     SRF_ACTIVE     = 0x00000004,

     SRF_OPAQUE     = 0x00000010,
     SRF_SHAPED     = 0x00000020,

     SRF_ALL        = 0x00000037
} StretRegionFlags;


typedef struct {
     DFBResult (*GetInput)( StretRegion         *region,
                            void                *region_data,
                            unsigned long        arg,
                            int                  index,
                            int                  x,
                            int                  y,
                            UniqueInputChannel **ret_channel );

     void      (*Update)  ( StretRegion         *region,
                            void                *region_data,
                            void                *update_data,
                            unsigned long        arg,
                            int                  x,
                            int                  y,
                            const DFBRegion     *updates,
                            int                  num );
} StretRegionClass;

typedef int StretRegionClassID;

#define SRCID_UNKNOWN    -1
#define SRCID_DEFAULT     0


DFBResult stret_class_register  ( const StretRegionClass *clazz,
                                  StretRegionClassID     *ret_id );

DFBResult stret_class_unregister( StretRegionClassID      id );



DFBResult stret_region_create   ( StretRegionClassID   class_id,
                                  void                *data,
                                  unsigned long        arg,
                                  StretRegionFlags     flags,
                                  int                  levels,
                                  int                  x,
                                  int                  y,
                                  int                  width,
                                  int                  height,
                                  StretRegion         *parent,
                                  int                  level,
                                  FusionSHMPoolShared *pool,
                                  StretRegion        **ret_region );

DFBResult stret_region_destroy  ( StretRegion         *region );


DFBResult stret_region_enable   ( StretRegion         *region,
                                  StretRegionFlags     flags );

DFBResult stret_region_disable  ( StretRegion         *region,
                                  StretRegionFlags     flags );


DFBResult stret_region_move     ( StretRegion         *region,
                                  int                  dx,
                                  int                  dy );

DFBResult stret_region_resize   ( StretRegion         *region,
                                  int                  width,
                                  int                  height );

DFBResult stret_region_restack  ( StretRegion         *region,
                                  int                  index );


void      stret_region_get_abs  ( StretRegion         *region,
                                  DFBRegion           *ret_bounds );

void      stret_region_get_size ( StretRegion         *region,
                                  DFBDimension        *ret_size );

DFBResult stret_region_get_input( StretRegion         *region,
                                  int                  index,
                                  int                  x,
                                  int                  y,
                                  UniqueInputChannel **ret_channel );

DFBResult stret_region_visible  ( StretRegion         *region,
                                  const DFBRegion     *base,
                                  bool                 children,
                                  DFBRegion           *ret_regions,
                                  int                  max_num,
                                  int                 *ret_num );

DFBResult stret_region_update   ( StretRegion         *region,
                                  const DFBRegion     *update,
                                  void                *update_data );

StretRegion *stret_region_at    ( StretRegion         *region,
                                  int                  x,
                                  int                  y,
                                  StretRegionFlags     flags,
                                  StretRegionClassID   class_id );

void        *stret_region_data  ( const StretRegion   *region );

#endif