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 struct _egl_image_attrib_int
  39 {
  40    EGLint Value;
  41    EGLBoolean IsPresent;
  42 };
  43
  44 struct _egl_image_attribs
  45 {
  46    /* EGL_KHR_image_base */
  47    EGLBoolean ImagePreserved;
  48
  49    /* EGL_KHR_gl_image */
  50    EGLint GLTextureLevel;
  51    EGLint GLTextureZOffset;
  52
  53    /* EGL_MESA_drm_image */
  54    EGLint Width;
  55    EGLint Height;
  56    EGLint DRMBufferFormatMESA;
  57    EGLint DRMBufferUseMESA;
  58    EGLint DRMBufferStrideMESA;
  59
  60    /* EGL_WL_bind_wayland_display */
  61    EGLint PlaneWL;
  62
  63    /* EGL_EXT_image_dma_buf_import */
  64    struct _egl_image_attrib_int DMABufFourCC;
  65    struct _egl_image_attrib_int DMABufPlaneFds[3];
  66    struct _egl_image_attrib_int DMABufPlaneOffsets[3];
  67    struct _egl_image_attrib_int DMABufPlanePitches[3];
  68    struct _egl_image_attrib_int DMABufYuvColorSpaceHint;
  69    struct _egl_image_attrib_int DMABufSampleRangeHint;
  70    struct _egl_image_attrib_int DMABufChromaHorizontalSiting;
  71    struct _egl_image_attrib_int DMABufChromaVerticalSiting;
  72 };
  73
  74 /**
  75  * "Base" class for device driver images.
  76  */
  77 struct _egl_image
  78 {
  79    /* An image is a display resource */
  80    _EGLResource Resource;
  81 };
  82
  83
  84 PUBLIC EGLint
  85 _eglParseImageAttribList(_EGLImageAttribs *attrs, _EGLDisplay *dpy,
  86                          const EGLint *attrib_list);
  87
  88
  89 PUBLIC EGLBoolean
  90 _eglInitImage(_EGLImage *img, _EGLDisplay *dpy);
  91
  92
  93 /**
  94  * Increment reference count for the image.
  95  */
  96 static inline _EGLImage *
  97 _eglGetImage(_EGLImage *img)
  98 {
  99    if (img)
 100       _eglGetResource(&img->Resource);
 101    return img;
 102 }
 103
 104
 105 /**
 106  * Decrement reference count for the image.
 107  */
 108 static inline EGLBoolean
 109 _eglPutImage(_EGLImage *img)
 110 {
 111    return (img) ? _eglPutResource(&img->Resource) : EGL_FALSE;
 112 }
 113
 114
 115 /**
 116  * Link an image to its display and return the handle of the link.
 117  * The handle can be passed to client directly.
 118  */
 119 static inline EGLImageKHR
 120 _eglLinkImage(_EGLImage *img)
 121 {
 122    _eglLinkResource(&img->Resource, _EGL_RESOURCE_IMAGE);
 123    return (EGLImageKHR) img;
 124 }
 125
 126
 127 /**
 128  * Unlink a linked image from its display.
 129  * Accessing an unlinked image should generate EGL_BAD_PARAMETER error.
 130  */
 131 static inline void
 132 _eglUnlinkImage(_EGLImage *img)
 133 {
 134    _eglUnlinkResource(&img->Resource, _EGL_RESOURCE_IMAGE);
 135 }
 136
 137
 138 /**
 139  * Lookup a handle to find the linked image.
 140  * Return NULL if the handle has no corresponding linked image.
 141  */
 142 static inline _EGLImage *
 143 _eglLookupImage(EGLImageKHR image, _EGLDisplay *dpy)
 144 {
 145    _EGLImage *img = (_EGLImage *) image;
 146    if (!dpy || !_eglCheckResource((void *) img, _EGL_RESOURCE_IMAGE, dpy))
 147       img = NULL;
 148    return img;
 149 }
 150
 151
 152 /**
 153  * Return the handle of a linked image, or EGL_NO_IMAGE_KHR.
 154  */
 155 static inline EGLImageKHR
 156 _eglGetImageHandle(_EGLImage *img)
 157 {
 158    _EGLResource *res = (_EGLResource *) img;
 159    return (res && _eglIsResourceLinked(res)) ?
 160       (EGLImageKHR) img : EGL_NO_IMAGE_KHR;
 161 }
 162
 163
 164 #endif /* EGLIMAGE_INCLUDED */