src/egl/main/eglsurface.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010 LunarG, Inc.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26  * DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30
  31 /**
  32  * Surface-related functions.
  33  */
  34
  35
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include "egldisplay.h"
  40 #include "egldriver.h"
  41 #include "eglcontext.h"
  42 #include "eglconfig.h"
  43 #include "eglcurrent.h"
  44 #include "egllog.h"
  45 #include "eglsurface.h"
  46
  47
  48 static void
  49 _eglClampSwapInterval(_EGLSurface *surf, EGLint interval)
  50 {
  51    EGLint bound = surf->Config->MaxSwapInterval;
  52    if (interval >= bound) {
  53       interval = bound;
  54    }
  55    else {
  56       bound = surf->Config->MinSwapInterval;
  57       if (interval < bound)
  58          interval = bound;
  59    }
  60    surf->SwapInterval = interval;
  61 }
  62
  63
  64 /**
  65  * Parse the list of surface attributes and return the proper error code.
  66  */
  67 static EGLint
  68 _eglParseSurfaceAttribList(_EGLSurface *surf, const EGLint *attrib_list)
  69 {
  70    _EGLDisplay *dpy = surf->Resource.Display;
  71    EGLint type = surf->Type;
  72    EGLint texture_type = EGL_PBUFFER_BIT;
  73    EGLint i, err = EGL_SUCCESS;
  74
  75    if (!attrib_list)
  76       return EGL_SUCCESS;
  77
  78    if (dpy->Extensions.NOK_texture_from_pixmap)
  79       texture_type |= EGL_PIXMAP_BIT;
  80
  81    for (i = 0; attrib_list[i] != EGL_NONE; i++) {
  82       EGLint attr = attrib_list[i++];
  83       EGLint val = attrib_list[i];
  84
  85       switch (attr) {
  86       /* common attributes */
  87       case EGL_GL_COLORSPACE_KHR:
  88          if (!dpy->Extensions.KHR_gl_colorspace) {
  89             err = EGL_BAD_ATTRIBUTE;
  90             break;
  91          }
  92          switch (val) {
  93          case EGL_GL_COLORSPACE_SRGB_KHR:
  94          case EGL_GL_COLORSPACE_LINEAR_KHR:
  95             break;
  96          default:
  97             err = EGL_BAD_ATTRIBUTE;
  98          }
  99          if (err != EGL_SUCCESS)
 100             break;
 101          surf->GLColorspace = val;
 102          break;
 103       case EGL_VG_COLORSPACE:
 104          switch (val) {
 105          case EGL_VG_COLORSPACE_sRGB:
 106          case EGL_VG_COLORSPACE_LINEAR:
 107             break;
 108          default:
 109             err = EGL_BAD_ATTRIBUTE;
 110             break;
 111          }
 112          if (err != EGL_SUCCESS)
 113             break;
 114          surf->VGColorspace = val;
 115          break;
 116       case EGL_VG_ALPHA_FORMAT:
 117          switch (val) {
 118          case EGL_VG_ALPHA_FORMAT_NONPRE:
 119          case EGL_VG_ALPHA_FORMAT_PRE:
 120             break;
 121          default:
 122             err = EGL_BAD_ATTRIBUTE;
 123             break;
 124          }
 125          if (err != EGL_SUCCESS)
 126             break;
 127          surf->VGAlphaFormat = val;
 128          break;
 129       /* window surface attributes */
 130       case EGL_RENDER_BUFFER:
 131          if (type != EGL_WINDOW_BIT) {
 132             err = EGL_BAD_ATTRIBUTE;
 133             break;
 134          }
 135          if (val != EGL_BACK_BUFFER && val != EGL_SINGLE_BUFFER) {
 136             err = EGL_BAD_ATTRIBUTE;
 137             break;
 138          }
 139          surf->RenderBuffer = val;
 140          break;
 141       case EGL_POST_SUB_BUFFER_SUPPORTED_NV:
 142          if (!dpy->Extensions.NV_post_sub_buffer ||
 143              type != EGL_WINDOW_BIT) {
 144             err = EGL_BAD_ATTRIBUTE;
 145             break;
 146          }
 147          if (val != EGL_TRUE && val != EGL_FALSE) {
 148             err = EGL_BAD_PARAMETER;
 149             break;
 150          }
 151          surf->PostSubBufferSupportedNV = val;
 152          break;
 153       /* pbuffer surface attributes */
 154       case EGL_WIDTH:
 155          if (type != EGL_PBUFFER_BIT) {
 156             err = EGL_BAD_ATTRIBUTE;
 157             break;
 158          }
 159          if (val < 0) {
 160             err = EGL_BAD_PARAMETER;
 161             break;
 162          }
 163          surf->Width = val;
 164          break;
 165       case EGL_HEIGHT:
 166          if (type != EGL_PBUFFER_BIT) {
 167             err = EGL_BAD_ATTRIBUTE;
 168             break;
 169          }
 170          if (val < 0) {
 171             err = EGL_BAD_PARAMETER;
 172             break;
 173          }
 174          surf->Height = val;
 175          break;
 176       case EGL_LARGEST_PBUFFER:
 177          if (type != EGL_PBUFFER_BIT) {
 178             err = EGL_BAD_ATTRIBUTE;
 179             break;
 180          }
 181          surf->LargestPbuffer = !!val;
 182          break;
 183       /* for eglBindTexImage */
 184       case EGL_TEXTURE_FORMAT:
 185          if (!(type & texture_type)) {
 186             err = EGL_BAD_ATTRIBUTE;
 187             break;
 188          }
 189          switch (val) {
 190          case EGL_TEXTURE_RGB:
 191          case EGL_TEXTURE_RGBA:
 192          case EGL_NO_TEXTURE:
 193             break;
 194          default:
 195             err = EGL_BAD_ATTRIBUTE;
 196             break;
 197          }
 198          if (err != EGL_SUCCESS)
 199             break;
 200          surf->TextureFormat = val;
 201          break;
 202       case EGL_TEXTURE_TARGET:
 203          if (!(type & texture_type)) {
 204             err = EGL_BAD_ATTRIBUTE;
 205             break;
 206          }
 207          switch (val) {
 208          case EGL_TEXTURE_2D:
 209          case EGL_NO_TEXTURE:
 210             break;
 211          default:
 212             err = EGL_BAD_ATTRIBUTE;
 213             break;
 214          }
 215          if (err != EGL_SUCCESS)
 216             break;
 217          surf->TextureTarget = val;
 218          break;
 219       case EGL_MIPMAP_TEXTURE:
 220          if (!(type & texture_type)) {
 221             err = EGL_BAD_ATTRIBUTE;
 222             break;
 223          }
 224          surf->MipmapTexture = !!val;
 225          break;
 226       /* no pixmap surface specific attributes */
 227       default:
 228          err = EGL_BAD_ATTRIBUTE;
 229          break;
 230       }
 231
 232       if (err != EGL_SUCCESS) {
 233          _eglLog(_EGL_WARNING, "bad surface attribute 0x%04x", attr);
 234          break;
 235       }
 236    }
 237
 238    return err;
 239 }
 240
 241
 242 /**
 243  * Do error check on parameters and initialize the given _EGLSurface object.
 244  * \return EGL_TRUE if no errors, EGL_FALSE otherwise.
 245  */
 246 EGLBoolean
 247 _eglInitSurface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
 248                 _EGLConfig *conf, const EGLint *attrib_list)
 249 {
 250    const char *func;
 251    EGLint renderBuffer = EGL_BACK_BUFFER;
 252    EGLint swapBehavior = EGL_BUFFER_PRESERVED;
 253    EGLint err;
 254
 255    switch (type) {
 256    case EGL_WINDOW_BIT:
 257       func = "eglCreateWindowSurface";
 258       swapBehavior = EGL_BUFFER_DESTROYED;
 259       break;
 260    case EGL_PIXMAP_BIT:
 261       func = "eglCreatePixmapSurface";
 262       renderBuffer = EGL_SINGLE_BUFFER;
 263       break;
 264    case EGL_PBUFFER_BIT:
 265       func = "eglCreatePBufferSurface";
 266       break;
 267    default:
 268       _eglLog(_EGL_WARNING, "Bad type in _eglInitSurface");
 269       return EGL_FALSE;
 270    }
 271
 272    if ((conf->SurfaceType & type) == 0) {
 273       /* The config can't be used to create a surface of this type */
 274       _eglError(EGL_BAD_CONFIG, func);
 275       return EGL_FALSE;
 276    }
 277
 278    _eglInitResource(&surf->Resource, sizeof(*surf), dpy);
 279    surf->Type = type;
 280    surf->Config = conf;
 281
 282    surf->Width = 0;
 283    surf->Height = 0;
 284    surf->TextureFormat = EGL_NO_TEXTURE;
 285    surf->TextureTarget = EGL_NO_TEXTURE;
 286    surf->MipmapTexture = EGL_FALSE;
 287    surf->LargestPbuffer = EGL_FALSE;
 288    surf->RenderBuffer = renderBuffer;
 289    surf->VGAlphaFormat = EGL_VG_ALPHA_FORMAT_NONPRE;
 290    surf->VGColorspace = EGL_VG_COLORSPACE_sRGB;
 291    surf->GLColorspace = EGL_GL_COLORSPACE_LINEAR_KHR;
 292
 293    surf->MipmapLevel = 0;
 294    surf->MultisampleResolve = EGL_MULTISAMPLE_RESOLVE_DEFAULT;
 295    surf->SwapBehavior = swapBehavior;
 296
 297    surf->HorizontalResolution = EGL_UNKNOWN;
 298    surf->VerticalResolution = EGL_UNKNOWN;
 299    surf->AspectRatio = EGL_UNKNOWN;
 300
 301    surf->PostSubBufferSupportedNV = EGL_FALSE;
 302
 303    /* the default swap interval is 1 */
 304    _eglClampSwapInterval(surf, 1);
 305
 306    err = _eglParseSurfaceAttribList(surf, attrib_list);
 307    if (err != EGL_SUCCESS)
 308       return _eglError(err, func);
 309
 310    return EGL_TRUE;
 311 }
 312
 313
 314 EGLBoolean
 315 _eglQuerySurface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 316                  EGLint attribute, EGLint *value)
 317 {
 318    switch (attribute) {
 319    case EGL_WIDTH:
 320       *value = surface->Width;
 321       break;
 322    case EGL_HEIGHT:
 323       *value = surface->Height;
 324       break;
 325    case EGL_CONFIG_ID:
 326       *value = surface->Config->ConfigID;
 327       break;
 328    case EGL_LARGEST_PBUFFER:
 329       *value = surface->LargestPbuffer;
 330       break;
 331    case EGL_TEXTURE_FORMAT:
 332       /* texture attributes: only for pbuffers, no error otherwise */
 333       if (surface->Type == EGL_PBUFFER_BIT)
 334          *value = surface->TextureFormat;
 335       break;
 336    case EGL_TEXTURE_TARGET:
 337       if (surface->Type == EGL_PBUFFER_BIT)
 338          *value = surface->TextureTarget;
 339       break;
 340    case EGL_MIPMAP_TEXTURE:
 341       if (surface->Type == EGL_PBUFFER_BIT)
 342          *value = surface->MipmapTexture;
 343       break;
 344    case EGL_MIPMAP_LEVEL:
 345       if (surface->Type == EGL_PBUFFER_BIT)
 346          *value = surface->MipmapLevel;
 347       break;
 348    case EGL_SWAP_BEHAVIOR:
 349       *value = surface->SwapBehavior;
 350       break;
 351    case EGL_RENDER_BUFFER:
 352       *value = surface->RenderBuffer;
 353       break;
 354    case EGL_PIXEL_ASPECT_RATIO:
 355       *value = surface->AspectRatio;
 356       break;
 357    case EGL_HORIZONTAL_RESOLUTION:
 358       *value = surface->HorizontalResolution;
 359       break;
 360    case EGL_VERTICAL_RESOLUTION:
 361       *value = surface->VerticalResolution;
 362       break;
 363    case EGL_MULTISAMPLE_RESOLVE:
 364       *value = surface->MultisampleResolve;
 365       break;
 366    case EGL_VG_ALPHA_FORMAT:
 367       *value = surface->VGAlphaFormat;
 368       break;
 369    case EGL_VG_COLORSPACE:
 370       *value = surface->VGColorspace;
 371       break;
 372    case EGL_GL_COLORSPACE_KHR:
 373       if (!dpy->Extensions.KHR_gl_colorspace) {
 374          _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 375          return EGL_FALSE;
 376       }
 377       *value = surface->GLColorspace;
 378       break;
 379    case EGL_POST_SUB_BUFFER_SUPPORTED_NV:
 380       *value = surface->PostSubBufferSupportedNV;
 381       break;
 382    case EGL_BUFFER_AGE_EXT:
 383       if (!dpy->Extensions.EXT_buffer_age) {
 384          _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 385          return EGL_FALSE;
 386       }
 387       *value = drv->API.QueryBufferAge(drv, dpy, surface);
 388       break;
 389    default:
 390       _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 391       return EGL_FALSE;
 392    }
 393
 394    return EGL_TRUE;
 395 }
 396
 397
 398 /**
 399  * Default fallback routine - drivers might override this.
 400  */
 401 EGLBoolean
 402 _eglSurfaceAttrib(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 403                   EGLint attribute, EGLint value)
 404 {
 405    EGLint confval;
 406    EGLint err = EGL_SUCCESS;
 407    EGLint all_es_bits = EGL_OPENGL_ES_BIT |
 408                         EGL_OPENGL_ES2_BIT |
 409                         EGL_OPENGL_ES3_BIT_KHR;
 410
 411    switch (attribute) {
 412    case EGL_MIPMAP_LEVEL:
 413       confval = surface->Config->RenderableType;
 414       if (!(confval & all_es_bits)) {
 415          err = EGL_BAD_PARAMETER;
 416          break;
 417       }
 418       surface->MipmapLevel = value;
 419       break;
 420    case EGL_MULTISAMPLE_RESOLVE:
 421       switch (value) {
 422       case EGL_MULTISAMPLE_RESOLVE_DEFAULT:
 423          break;
 424       case EGL_MULTISAMPLE_RESOLVE_BOX:
 425          confval = surface->Config->SurfaceType;
 426          if (!(confval & EGL_MULTISAMPLE_RESOLVE_BOX_BIT))
 427             err = EGL_BAD_MATCH;
 428          break;
 429       default:
 430          err = EGL_BAD_ATTRIBUTE;
 431          break;
 432       }
 433       if (err != EGL_SUCCESS)
 434          break;
 435       surface->MultisampleResolve = value;
 436       break;
 437    case EGL_SWAP_BEHAVIOR:
 438       switch (value) {
 439       case EGL_BUFFER_DESTROYED:
 440          break;
 441       case EGL_BUFFER_PRESERVED:
 442          confval = surface->Config->SurfaceType;
 443          if (!(confval & EGL_SWAP_BEHAVIOR_PRESERVED_BIT))
 444             err = EGL_BAD_MATCH;
 445          break;
 446       default:
 447          err = EGL_BAD_ATTRIBUTE;
 448          break;
 449       }
 450       if (err != EGL_SUCCESS)
 451          break;
 452       surface->SwapBehavior = value;
 453       break;
 454    default:
 455       err = EGL_BAD_ATTRIBUTE;
 456       break;
 457    }
 458
 459    if (err != EGL_SUCCESS)
 460       return _eglError(err, "eglSurfaceAttrib");
 461    return EGL_TRUE;
 462 }
 463
 464
 465 EGLBoolean
 466 _eglBindTexImage(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 467                  EGLint buffer)
 468 {
 469    EGLint texture_type = EGL_PBUFFER_BIT;
 470
 471    /* Just do basic error checking and return success/fail.
 472     * Drivers must implement the real stuff.
 473     */
 474
 475    if (dpy->Extensions.NOK_texture_from_pixmap)
 476       texture_type |= EGL_PIXMAP_BIT;
 477
 478    if (!(surface->Type & texture_type)) {
 479       _eglError(EGL_BAD_SURFACE, "eglBindTexImage");
 480       return EGL_FALSE;
 481    }
 482
 483    if (surface->TextureFormat == EGL_NO_TEXTURE) {
 484       _eglError(EGL_BAD_MATCH, "eglBindTexImage");
 485       return EGL_FALSE;
 486    }
 487
 488    if (surface->TextureTarget == EGL_NO_TEXTURE) {
 489       _eglError(EGL_BAD_MATCH, "eglBindTexImage");
 490       return EGL_FALSE;
 491    }
 492
 493    if (buffer != EGL_BACK_BUFFER) {
 494       _eglError(EGL_BAD_PARAMETER, "eglBindTexImage");
 495       return EGL_FALSE;
 496    }
 497
 498    surface->BoundToTexture = EGL_TRUE;
 499
 500    return EGL_TRUE;
 501 }
 502
 503 EGLBoolean
 504 _eglReleaseTexImage(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
 505                     EGLint buffer)
 506 {
 507    /* TODO: do basic error checking and return success/fail.
 508     * Drivers must implement the real stuff.
 509     */
 510
 511   return EGL_TRUE;
 512 }
 513
 514
 515 EGLBoolean
 516 _eglSwapInterval(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf,
 517                  EGLint interval)
 518 {
 519    _eglClampSwapInterval(surf, interval);
 520    return EGL_TRUE;
 521 }