src/gbm/main/gbm.h

   1 /*
   2  * Copyright © 2011 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  19  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  20  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *    Benjamin Franzke <benjaminfranzke@googlemail.com>
  26  */
  27
  28 #ifndef _GBM_H_
  29 #define _GBM_H_
  30
  31 #define __GBM__ 1
  32
  33 #include <stdint.h>
  34
  35 struct gbm_device;
  36 struct gbm_bo;
  37
  38 union gbm_bo_handle {
  39    void *ptr;
  40    int32_t s32;
  41    uint32_t u32;
  42    int64_t s64;
  43    uint64_t u64;
  44 };
  45
  46 enum gbm_bo_format {
  47    GBM_BO_FORMAT_XRGB8888,
  48    GBM_BO_FORMAT_ARGB8888,
  49 };
  50
  51 enum gbm_bo_flags {
  52    GBM_BO_USE_SCANOUT      = (1 << 0),
  53    GBM_BO_USE_CURSOR_64X64 = (1 << 1),
  54    GBM_BO_USE_RENDERING    = (1 << 2),
  55 };
  56
  57 int
  58 gbm_device_get_fd(struct gbm_device *gbm);
  59
  60 const char *
  61 gbm_device_get_backend_name(struct gbm_device *gbm);
  62
  63 int
  64 gbm_device_is_format_supported(struct gbm_device *gbm,
  65                                enum gbm_bo_format format,
  66                                uint32_t usage);
  67
  68 void
  69 gbm_device_destroy(struct gbm_device *gbm);
  70
  71 struct gbm_device *
  72 gbm_create_device(int fd);
  73
  74 struct gbm_bo *
  75 gbm_bo_create(struct gbm_device *gbm,
  76               uint32_t width, uint32_t height,
  77               enum gbm_bo_format format, uint32_t flags);
  78
  79 struct gbm_bo *
  80 gbm_bo_create_from_egl_image(struct gbm_device *gbm,
  81                              void *egl_dpy, void *egl_img,
  82                              uint32_t width, uint32_t height,
  83                              uint32_t usage);
  84
  85 uint32_t
  86 gbm_bo_get_width(struct gbm_bo *bo);
  87
  88 uint32_t
  89 gbm_bo_get_height(struct gbm_bo *bo);
  90
  91 uint32_t
  92 gbm_bo_get_pitch(struct gbm_bo *bo);
  93
  94 union gbm_bo_handle
  95 gbm_bo_get_handle(struct gbm_bo *bo);
  96
  97 void
  98 gbm_bo_destroy(struct gbm_bo *bo);
  99
 100 #endif