src/tbm_surface_queue.h

   1 /**************************************************************************
   2
   3 libtbm
   4
   5 Copyright 2014 Samsung Electronics co., Ltd. All Rights Reserved.
   6
   7 Contact: SooChan Lim <sc1.lim@samsung.com>, Sangjin Lee <lsj119@samsung.com>
   8 Boram Park <boram1288.park@samsung.com>, Changyeon Lee <cyeon.lee@samsung.com>
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a
  11 copy of this software and associated documentation files (the
  12 "Software"), to deal in the Software without restriction, including
  13 without limitation the rights to use, copy, modify, merge, publish,
  14 distribute, sub license, and/or sell copies of the Software, and to
  15 permit persons to whom the Software is furnished to do so, subject to
  16 the following conditions:
  17
  18 The above copyright notice and this permission notice (including the
  19 next paragraph) shall be included in all copies or substantial portions
  20 of the Software.
  21
  22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  25 IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  26 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  27 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  28 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30 **************************************************************************/
  31
  32 #ifndef _TBM_SURFACE_QUEUE_H_
  33 #define _TBM_SURFACE_QUEUE_H_
  34
  35 #include <tbm_surface.h>
  36
  37 typedef enum
  38 {
  39     TBM_SURFACE_QUEUE_ERROR_NONE  = 0,                    /**< Successful */
  40     TBM_SURFACE_QUEUE_ERROR_INVALID_SURFACE  = -1,
  41     TBM_SURFACE_QUEUE_ERROR_INVALID_QUEUE  = -2,
  42     TBM_SURFACE_QUEUE_ERROR_EMPTY  = -3,
  43     TBM_SURFACE_QUEUE_ERROR_INVALID_PARAMETER  = -4,
  44     TBM_SURFACE_QUEUE_ERROR_SURFACE_ALLOC_FAILED   = -5,
  45 } tbm_surface_queue_error_e;
  46
  47 typedef struct _tbm_surface_queue *tbm_surface_queue_h;
  48
  49 typedef void (* tbm_surface_queue_notify_cb) (tbm_surface_queue_h surface_queue, void* data);
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 tbm_surface_queue_error_e tbm_surface_queue_enqueue(tbm_surface_queue_h surface_queue, tbm_surface_h surface);
  56
  57 tbm_surface_queue_error_e tbm_surface_queue_dequeue(tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
  58
  59 tbm_surface_queue_error_e tbm_surface_queue_release(tbm_surface_queue_h surface_queue, tbm_surface_h surface);
  60
  61 tbm_surface_queue_error_e tbm_surface_queue_acquire(tbm_surface_queue_h surface_queue, tbm_surface_h *surface);
  62
  63 int tbm_surface_queue_can_dequeue(tbm_surface_queue_h surface_queue, int wait);
  64
  65 int tbm_surface_queue_can_acquire(tbm_surface_queue_h surface_queue, int wait);
  66
  67 tbm_surface_queue_h tbm_surface_queue_create(int queue_size, int width, int height, int format, int flags);
  68
  69 tbm_surface_queue_error_e tbm_surface_queue_set_destroy_cb(tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb destroy_cb, void *data);
  70
  71 tbm_surface_queue_error_e tbm_surface_queue_set_dequeuable_cb(tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb dequeuable_cb, void *data);
  72
  73 tbm_surface_queue_error_e tbm_surface_queue_set_acquirable_cb(tbm_surface_queue_h surface_queue, tbm_surface_queue_notify_cb acquirable_cb, void *data);
  74
  75 void tbm_surface_queue_destroy(tbm_surface_queue_h surface_queue);
  76
  77 int tbm_surface_queue_get_queue_size(tbm_surface_queue_h surface_queue);
  78
  79 int tbm_surface_queue_get_width(tbm_surface_queue_h surface_queue);
  80
  81 int tbm_surface_queue_get_height(tbm_surface_queue_h surface_queue);
  82
  83 int tbm_surface_queue_get_format(tbm_surface_queue_h surface_queue);
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif /* _TBM_SURFACE_H_ */
  89