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    EGLint attr = EGL_NONE;
  75    EGLint val = EGL_NONE;
  76
  77    if (!attrib_list)
  78       return EGL_SUCCESS;
  79
  80    if (dpy->Extensions.NOK_texture_from_pixmap)
  81       texture_type |= EGL_PIXMAP_BIT;
  82
  83    for (i = 0; attrib_list[i] != EGL_NONE; i++) {
  84       attr = attrib_list[i++];
  85       val = attrib_list[i];
  86
  87       switch (attr) {
  88       /* common attributes */
  89       case EGL_GL_COLORSPACE_KHR:
  90          if (!dpy->Extensions.KHR_gl_colorspace) {
  91             err = EGL_BAD_ATTRIBUTE;
  92             break;
  93          }
  94          switch (val) {
  95          case EGL_GL_COLORSPACE_SRGB_KHR:
  96          case EGL_GL_COLORSPACE_LINEAR_KHR:
  97             break;
  98          default:
  99             err = EGL_BAD_ATTRIBUTE;
 100          }
 101          if (err != EGL_SUCCESS)
 102             break;
 103          surf->GLColorspace = val;
 104          break;
 105       case EGL_VG_COLORSPACE:
 106          switch (val) {
 107          case EGL_VG_COLORSPACE_sRGB:
 108          case EGL_VG_COLORSPACE_LINEAR:
 109             break;
 110          default:
 111             err = EGL_BAD_ATTRIBUTE;
 112             break;
 113          }
 114          if (err != EGL_SUCCESS)
 115             break;
 116          surf->VGColorspace = val;
 117          break;
 118       case EGL_VG_ALPHA_FORMAT:
 119          switch (val) {
 120          case EGL_VG_ALPHA_FORMAT_NONPRE:
 121          case EGL_VG_ALPHA_FORMAT_PRE:
 122             break;
 123          default:
 124             err = EGL_BAD_ATTRIBUTE;
 125             break;
 126          }
 127          if (err != EGL_SUCCESS)
 128             break;
 129          surf->VGAlphaFormat = val;
 130          break;
 131       /* window surface attributes */
 132       case EGL_RENDER_BUFFER:
 133          if (type != EGL_WINDOW_BIT) {
 134             err = EGL_BAD_ATTRIBUTE;
 135             break;
 136          }
 137          if (val != EGL_BACK_BUFFER && val != EGL_SINGLE_BUFFER) {
 138             err = EGL_BAD_ATTRIBUTE;
 139             break;
 140          }
 141          surf->RenderBuffer = val;
 142          break;
 143       case EGL_POST_SUB_BUFFER_SUPPORTED_NV:
 144          if (!dpy->Extensions.NV_post_sub_buffer ||
 145              type != EGL_WINDOW_BIT) {
 146             err = EGL_BAD_ATTRIBUTE;
 147             break;
 148          }
 149          if (val != EGL_TRUE && val != EGL_FALSE) {
 150             err = EGL_BAD_PARAMETER;
 151             break;
 152          }
 153          surf->PostSubBufferSupportedNV = val;
 154          break;
 155       /* pbuffer surface attributes */
 156       case EGL_WIDTH:
 157          if (type != EGL_PBUFFER_BIT) {
 158             err = EGL_BAD_ATTRIBUTE;
 159             break;
 160          }
 161          if (val < 0) {
 162             err = EGL_BAD_PARAMETER;
 163             break;
 164          }
 165          surf->Width = val;
 166          break;
 167       case EGL_HEIGHT:
 168          if (type != EGL_PBUFFER_BIT) {
 169             err = EGL_BAD_ATTRIBUTE;
 170             break;
 171          }
 172          if (val < 0) {
 173             err = EGL_BAD_PARAMETER;
 174             break;
 175          }
 176          surf->Height = val;
 177          break;
 178       case EGL_LARGEST_PBUFFER:
 179          if (type != EGL_PBUFFER_BIT) {
 180             err = EGL_BAD_ATTRIBUTE;
 181             break;
 182          }
 183          surf->LargestPbuffer = !!val;
 184          break;
 185       /* for eglBindTexImage */
 186       case EGL_TEXTURE_FORMAT:
 187          if (!(type & texture_type)) {
 188             err = EGL_BAD_ATTRIBUTE;
 189             break;
 190          }
 191
 192          switch (val) {
 193          case EGL_TEXTURE_RGB:
 194          case EGL_TEXTURE_RGBA:
 195          case EGL_NO_TEXTURE:
 196             break;
 197          default:
 198             err = EGL_BAD_ATTRIBUTE;
 199             break;
 200          }
 201          if (err != EGL_SUCCESS)
 202             break;
 203          surf->TextureFormat = val;
 204          break;
 205       case EGL_TEXTURE_TARGET:
 206          if (!(type & texture_type)) {
 207             err = EGL_BAD_ATTRIBUTE;
 208             break;
 209          }
 210
 211          switch (val) {
 212          case EGL_TEXTURE_2D:
 213          case EGL_NO_TEXTURE:
 214             break;
 215          default:
 216             err = EGL_BAD_ATTRIBUTE;
 217             break;
 218          }
 219          if (err != EGL_SUCCESS)
 220             break;
 221          surf->TextureTarget = val;
 222          break;
 223       case EGL_MIPMAP_TEXTURE:
 224          if (!(type & texture_type)) {
 225             err = EGL_BAD_ATTRIBUTE;
 226             break;
 227          }
 228          surf->MipmapTexture = !!val;
 229          break;
 230       /* no pixmap surface specific attributes */
 231       default:
 232          err = EGL_BAD_ATTRIBUTE;
 233          break;
 234       }
 235
 236       if (err != EGL_SUCCESS)
 237          break;
 238    }
 239
 240    if (err == EGL_SUCCESS && type == EGL_PBUFFER_BIT) {
 241       if ((surf->TextureTarget == EGL_NO_TEXTURE && surf->TextureFormat != EGL_NO_TEXTURE) ||
 242           (surf->TextureFormat == EGL_NO_TEXTURE && surf->TextureTarget != EGL_NO_TEXTURE)) {
 243          attr = surf->TextureTarget == EGL_NO_TEXTURE ? EGL_TEXTURE_TARGET : EGL_TEXTURE_FORMAT;
 244          err = EGL_BAD_MATCH;
 245       }
 246    }
 247
 248    if (err != EGL_SUCCESS)
 249       _eglLog(_EGL_WARNING, "bad surface attribute 0x%04x", attr);
 250
 251    return err;
 252 }
 253
 254
 255 /**
 256  * Do error check on parameters and initialize the given _EGLSurface object.
 257  * \return EGL_TRUE if no errors, EGL_FALSE otherwise.
 258  */
 259 EGLBoolean
 260 _eglInitSurface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
 261                 _EGLConfig *conf, const EGLint *attrib_list)
 262 {
 263    const char *func;
 264    EGLint renderBuffer = EGL_BACK_BUFFER;
 265    EGLint swapBehavior = EGL_BUFFER_PRESERVED;
 266    EGLint err;
 267
 268    switch (type) {
 269    case EGL_WINDOW_BIT:
 270       func = "eglCreateWindowSurface";
 271       swapBehavior = EGL_BUFFER_DESTROYED;
 272       break;
 273    case EGL_PIXMAP_BIT:
 274       func = "eglCreatePixmapSurface";
 275       renderBuffer = EGL_SINGLE_BUFFER;
 276       break;
 277    case EGL_PBUFFER_BIT:
 278       func = "eglCreatePBufferSurface";
 279       break;
 280    default:
 281       _eglLog(_EGL_WARNING, "Bad type in _eglInitSurface");
 282       return EGL_FALSE;
 283    }
 284
 285    if ((conf->SurfaceType & type) == 0) {
 286       /* The config can't be used to create a surface of this type */
 287       _eglError(EGL_BAD_CONFIG, func);
 288       return EGL_FALSE;
 289    }
 290
 291    _eglInitResource(&surf->Resource, sizeof(*surf), dpy);
 292    surf->Type = type;
 293    surf->Config = conf;
 294
 295    surf->Width = 0;
 296    surf->Height = 0;
 297    surf->TextureFormat = EGL_NO_TEXTURE;
 298    surf->TextureTarget = EGL_NO_TEXTURE;
 299    surf->MipmapTexture = EGL_FALSE;
 300    surf->LargestPbuffer = EGL_FALSE;
 301    surf->RenderBuffer = renderBuffer;
 302    surf->VGAlphaFormat = EGL_VG_ALPHA_FORMAT_NONPRE;
 303    surf->VGColorspace = EGL_VG_COLORSPACE_sRGB;
 304    surf->GLColorspace = EGL_GL_COLORSPACE_LINEAR_KHR;
 305
 306    surf->MipmapLevel = 0;
 307    surf->MultisampleResolve = EGL_MULTISAMPLE_RESOLVE_DEFAULT;
 308    surf->SwapBehavior = swapBehavior;
 309
 310    surf->HorizontalResolution = EGL_UNKNOWN;
 311    surf->VerticalResolution = EGL_UNKNOWN;
 312    surf->AspectRatio = EGL_UNKNOWN;
 313
 314    surf->PostSubBufferSupportedNV = EGL_FALSE;
 315
 316    /* the default swap interval is 1 */
 317    _eglClampSwapInterval(surf, 1);
 318
 319    err = _eglParseSurfaceAttribList(surf, attrib_list);
 320    if (err != EGL_SUCCESS)
 321       return _eglError(err, func);
 322
 323    /* if EGL_LARGEST_PBUFFER in use, clamp width and height */
 324    if (surf->LargestPbuffer) {
 325       surf->Width = MIN2(surf->Width, _EGL_MAX_PBUFFER_WIDTH);
 326       surf->Height = MIN2(surf->Height, _EGL_MAX_PBUFFER_HEIGHT);
 327    }
 328
 329    return EGL_TRUE;
 330 }
 331
 332
 333 EGLBoolean
 334 _eglQuerySurface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 335                  EGLint attribute, EGLint *value)
 336 {
 337    switch (attribute) {
 338    case EGL_WIDTH:
 339       *value = surface->Width;
 340       break;
 341    case EGL_HEIGHT:
 342       *value = surface->Height;
 343       break;
 344    case EGL_CONFIG_ID:
 345       *value = surface->Config->ConfigID;
 346       break;
 347    case EGL_LARGEST_PBUFFER:
 348       if (surface->Type == EGL_PBUFFER_BIT)
 349          *value = surface->LargestPbuffer;
 350       break;
 351    case EGL_TEXTURE_FORMAT:
 352       /* texture attributes: only for pbuffers, no error otherwise */
 353       if (surface->Type == EGL_PBUFFER_BIT)
 354          *value = surface->TextureFormat;
 355       break;
 356    case EGL_TEXTURE_TARGET:
 357       if (surface->Type == EGL_PBUFFER_BIT)
 358          *value = surface->TextureTarget;
 359       break;
 360    case EGL_MIPMAP_TEXTURE:
 361       if (surface->Type == EGL_PBUFFER_BIT)
 362          *value = surface->MipmapTexture;
 363       break;
 364    case EGL_MIPMAP_LEVEL:
 365       if (surface->Type == EGL_PBUFFER_BIT)
 366          *value = surface->MipmapLevel;
 367       break;
 368    case EGL_SWAP_BEHAVIOR:
 369       *value = surface->SwapBehavior;
 370       break;
 371    case EGL_RENDER_BUFFER:
 372       *value = surface->RenderBuffer;
 373       break;
 374    case EGL_PIXEL_ASPECT_RATIO:
 375       *value = surface->AspectRatio;
 376       break;
 377    case EGL_HORIZONTAL_RESOLUTION:
 378       *value = surface->HorizontalResolution;
 379       break;
 380    case EGL_VERTICAL_RESOLUTION:
 381       *value = surface->VerticalResolution;
 382       break;
 383    case EGL_MULTISAMPLE_RESOLVE:
 384       *value = surface->MultisampleResolve;
 385       break;
 386    case EGL_VG_ALPHA_FORMAT:
 387       *value = surface->VGAlphaFormat;
 388       break;
 389    case EGL_VG_COLORSPACE:
 390       *value = surface->VGColorspace;
 391       break;
 392    case EGL_GL_COLORSPACE_KHR:
 393       if (!dpy->Extensions.KHR_gl_colorspace) {
 394          _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 395          return EGL_FALSE;
 396       }
 397       *value = surface->GLColorspace;
 398       break;
 399    case EGL_POST_SUB_BUFFER_SUPPORTED_NV:
 400       *value = surface->PostSubBufferSupportedNV;
 401       break;
 402    case EGL_BUFFER_AGE_EXT:
 403       if (!dpy->Extensions.EXT_buffer_age) {
 404          _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 405          return EGL_FALSE;
 406       }
 407       *value = drv->API.QueryBufferAge(drv, dpy, surface);
 408       break;
 409    default:
 410       _eglError(EGL_BAD_ATTRIBUTE, "eglQuerySurface");
 411       return EGL_FALSE;
 412    }
 413
 414    return EGL_TRUE;
 415 }
 416
 417
 418 /**
 419  * Default fallback routine - drivers might override this.
 420  */
 421 EGLBoolean
 422 _eglSurfaceAttrib(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 423                   EGLint attribute, EGLint value)
 424 {
 425    EGLint confval;
 426    EGLint err = EGL_SUCCESS;
 427    EGLint all_es_bits = EGL_OPENGL_ES_BIT |
 428                         EGL_OPENGL_ES2_BIT |
 429                         EGL_OPENGL_ES3_BIT_KHR;
 430
 431    switch (attribute) {
 432    case EGL_MIPMAP_LEVEL:
 433       confval = surface->Config->RenderableType;
 434       if (!(confval & all_es_bits)) {
 435          err = EGL_BAD_PARAMETER;
 436          break;
 437       }
 438       surface->MipmapLevel = value;
 439       break;
 440    case EGL_MULTISAMPLE_RESOLVE:
 441       switch (value) {
 442       case EGL_MULTISAMPLE_RESOLVE_DEFAULT:
 443          break;
 444       case EGL_MULTISAMPLE_RESOLVE_BOX:
 445          confval = surface->Config->SurfaceType;
 446          if (!(confval & EGL_MULTISAMPLE_RESOLVE_BOX_BIT))
 447             err = EGL_BAD_MATCH;
 448          break;
 449       default:
 450          err = EGL_BAD_ATTRIBUTE;
 451          break;
 452       }
 453       if (err != EGL_SUCCESS)
 454          break;
 455       surface->MultisampleResolve = value;
 456       break;
 457    case EGL_SWAP_BEHAVIOR:
 458       switch (value) {
 459       case EGL_BUFFER_DESTROYED:
 460          break;
 461       case EGL_BUFFER_PRESERVED:
 462          confval = surface->Config->SurfaceType;
 463          if (!(confval & EGL_SWAP_BEHAVIOR_PRESERVED_BIT))
 464             err = EGL_BAD_MATCH;
 465          break;
 466       default:
 467          err = EGL_BAD_ATTRIBUTE;
 468          break;
 469       }
 470       if (err != EGL_SUCCESS)
 471          break;
 472       surface->SwapBehavior = value;
 473       break;
 474    default:
 475       err = EGL_BAD_ATTRIBUTE;
 476       break;
 477    }
 478
 479    if (err != EGL_SUCCESS)
 480       return _eglError(err, "eglSurfaceAttrib");
 481    return EGL_TRUE;
 482 }
 483
 484
 485 EGLBoolean
 486 _eglBindTexImage(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface,
 487                  EGLint buffer)
 488 {
 489    EGLint texture_type = EGL_PBUFFER_BIT;
 490
 491    /* Just do basic error checking and return success/fail.
 492     * Drivers must implement the real stuff.
 493     */
 494
 495    if (dpy->Extensions.NOK_texture_from_pixmap)
 496       texture_type |= EGL_PIXMAP_BIT;
 497
 498    if (!(surface->Type & texture_type)) {
 499       _eglError(EGL_BAD_SURFACE, "eglBindTexImage");
 500       return EGL_FALSE;
 501    }
 502
 503    if (surface->TextureFormat == EGL_NO_TEXTURE) {
 504       _eglError(EGL_BAD_MATCH, "eglBindTexImage");
 505       return EGL_FALSE;
 506    }
 507
 508    if (surface->TextureTarget == EGL_NO_TEXTURE) {
 509       _eglError(EGL_BAD_MATCH, "eglBindTexImage");
 510       return EGL_FALSE;
 511    }
 512
 513    if (buffer != EGL_BACK_BUFFER) {
 514       _eglError(EGL_BAD_PARAMETER, "eglBindTexImage");
 515       return EGL_FALSE;
 516    }
 517
 518    surface->BoundToTexture = EGL_TRUE;
 519
 520    return EGL_TRUE;
 521 }
 522
 523 EGLBoolean
 524 _eglReleaseTexImage(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf,
 525                     EGLint buffer)
 526 {
 527    /* TODO: do basic error checking and return success/fail.
 528     * Drivers must implement the real stuff.
 529     */
 530
 531   return EGL_TRUE;
 532 }
 533
 534
 535 EGLBoolean
 536 _eglSwapInterval(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf,
 537                  EGLint interval)
 538 {
 539    _eglClampSwapInterval(surf, interval);
 540    return EGL_TRUE;
 541 }