src/egl/main/eglsurface.c

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