src/egl/main/eglimage.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   4  * Copyright 2010-2011 LunarG, Inc.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29
  30 #ifndef EGLIMAGE_INCLUDED
  31 #define EGLIMAGE_INCLUDED
  32
  33 #include "c99_compat.h"
  34
  35 #include "egltypedefs.h"
  36 #include "egldisplay.h"
  37
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 struct _egl_image_attrib_int
  44 {
  45    EGLint Value;
  46    EGLBoolean IsPresent;
  47 };
  48
  49 #define DMA_BUF_MAX_PLANES 3
  50
  51 struct _egl_image_attribs
  52 {
  53    /* EGL_KHR_image_base */
  54    EGLBoolean ImagePreserved;
  55
  56    /* EGL_KHR_gl_image */
  57    EGLint GLTextureLevel;
  58    EGLint GLTextureZOffset;
  59
  60    /* EGL_MESA_drm_image */
  61    EGLint Width;
  62    EGLint Height;
  63    EGLint DRMBufferFormatMESA;
  64    EGLint DRMBufferUseMESA;
  65    EGLint DRMBufferStrideMESA;
  66
  67    /* EGL_WL_bind_wayland_display */
  68    EGLint PlaneWL;
  69
  70    /* EGL_EXT_image_dma_buf_import */
  71    struct _egl_image_attrib_int DMABufFourCC;
  72    struct _egl_image_attrib_int DMABufPlaneFds[DMA_BUF_MAX_PLANES];
  73    struct _egl_image_attrib_int DMABufPlaneOffsets[DMA_BUF_MAX_PLANES];
  74    struct _egl_image_attrib_int DMABufPlanePitches[DMA_BUF_MAX_PLANES];
  75    struct _egl_image_attrib_int DMABufYuvColorSpaceHint;
  76    struct _egl_image_attrib_int DMABufSampleRangeHint;
  77    struct _egl_image_attrib_int DMABufChromaHorizontalSiting;
  78    struct _egl_image_attrib_int DMABufChromaVerticalSiting;
  79 };
  80
  81 /**
  82  * "Base" class for device driver images.
  83  */
  84 struct _egl_image
  85 {
  86    /* An image is a display resource */
  87    _EGLResource Resource;
  88 };
  89
  90
  91 extern EGLint
  92 _eglParseImageAttribList(_EGLImageAttribs *attrs, _EGLDisplay *dpy,
  93                          const EGLint *attrib_list);
  94
  95
  96 extern EGLBoolean
  97 _eglInitImage(_EGLImage *img, _EGLDisplay *dpy);
  98
  99
 100 /**
 101  * Increment reference count for the image.
 102  */
 103 static inline _EGLImage *
 104 _eglGetImage(_EGLImage *img)
 105 {
 106    if (img)
 107       _eglGetResource(&img->Resource);
 108    return img;
 109 }
 110
 111
 112 /**
 113  * Decrement reference count for the image.
 114  */
 115 static inline EGLBoolean
 116 _eglPutImage(_EGLImage *img)
 117 {
 118    return (img) ? _eglPutResource(&img->Resource) : EGL_FALSE;
 119 }
 120
 121
 122 /**
 123  * Link an image to its display and return the handle of the link.
 124  * The handle can be passed to client directly.
 125  */
 126 static inline EGLImage
 127 _eglLinkImage(_EGLImage *img)
 128 {
 129    _eglLinkResource(&img->Resource, _EGL_RESOURCE_IMAGE);
 130    return (EGLImage) img;
 131 }
 132
 133
 134 /**
 135  * Unlink a linked image from its display.
 136  * Accessing an unlinked image should generate EGL_BAD_PARAMETER error.
 137  */
 138 static inline void
 139 _eglUnlinkImage(_EGLImage *img)
 140 {
 141    _eglUnlinkResource(&img->Resource, _EGL_RESOURCE_IMAGE);
 142 }
 143
 144
 145 /**
 146  * Lookup a handle to find the linked image.
 147  * Return NULL if the handle has no corresponding linked image.
 148  */
 149 static inline _EGLImage *
 150 _eglLookupImage(EGLImage image, _EGLDisplay *dpy)
 151 {
 152    _EGLImage *img = (_EGLImage *) image;
 153    if (!dpy || !_eglCheckResource((void *) img, _EGL_RESOURCE_IMAGE, dpy))
 154       img = NULL;
 155    return img;
 156 }
 157
 158
 159 /**
 160  * Return the handle of a linked image, or EGL_NO_IMAGE_KHR.
 161  */
 162 static inline EGLImage
 163 _eglGetImageHandle(_EGLImage *img)
 164 {
 165    _EGLResource *res = (_EGLResource *) img;
 166    return (res && _eglIsResourceLinked(res)) ?
 167       (EGLImage) img : EGL_NO_IMAGE_KHR;
 168 }
 169
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif /* EGLIMAGE_INCLUDED */