KHR_image_pixmap

EGL_KHR_image_pixmap

Jeff Juliano
Gary King
Jon Leech
Jonathan Grant
Barthold Lichtenbelt
Aaftab Munshi
Acorn Pooley
Chris Wynn
Ray Smith

Jon Leech (jon 'at' alumni.caltech.edu)
Gary King, NVIDIA Corporation (gking 'at' nvidia.com)

Copyright (c) 2008-2013 The Khronos Group Inc. Copyright terms at
    http://www.khronos.org/registry/speccopyright.html

Complete. Functionality approved (as part of KHR_image) by the
Khronos Board of Promoters on February 11, 2008.

Split into KHR_image_base and KHR_image_pixmap approved by the
Khronos Technical Working Group on November 19, 2008.

Version 5, November 13, 2013

EGL Extension #9

EGL 1.2 is required.

EGL_KHR_image_base is required.

The EGL implementation must define an EGLNativePixmapType (although it
is not required either to export any EGLConfigs supporting rendering to
native pixmaps, or to support eglCreatePixmapSurface).

This extension is written against the wording of the EGL 1.4
Specification.

This extension allows creating an EGLImage from a native pixmap
image.

None

None

Accepted by the <target> parameter of eglCreateImageKHR:

    EGL_NATIVE_PIXMAP_KHR                          0x30B0

Rename section 2.2.2.1 "Native Surface Coordinate Systems" to "Native
Surface and EGLImage Pixmap Coordinate Systems" and add to the end of
the section:

Add to section 2.5.1 "EGLImage Specification" (as defined by the
EGL_KHR_image_base specification), in the description of
eglCreateImageKHR:

  +-------------------------+--------------------------------------------+
  |  <target>               |  Notes                                     |
  +-------------------------+--------------------------------------------+
  |  EGL_NATIVE_PIXMAP_KHR  |   Used for EGLNativePixmapType objects     |
  +-------------------------+--------------------------------------------+
   Table aaa.  Legal values for eglCreateImageKHR <target> parameter

...

If <target> is EGL_NATIVE_PIXMAP_KHR, <dpy> must be a valid display, <ctx>
must be EGL_NO_CONTEXT; <buffer> must be a handle to a valid
NativePixmapType object, cast into the type EGLClientBuffer; and
attributes other than EGL_IMAGE_PRESERVED_KHR are ignored."

Add to the list of error conditions for eglCreateImageKHR:

  "* If <target> is EGL_NATIVE_PIXMAP_KHR and <buffer> is not a
     valid native pixmap handle, or if <buffer> is a native pixmap
     whose color buffer format is incompatible with the system's
     EGLImage implementation, the error EGL_BAD_PARAMETER is
     generated.

   * If <target> is EGL_NATIVE_PIXMAP_KHR, and <dpy> is not a valid
     EGLDisplay object the error EGL_BAD_DISPLAY is generated.

   * If <target> is EGL_NATIVE_PIXMAP_KHR, and <ctx> is not EGL_NO_CONTEXT,
     the error EGL_BAD_PARAMETER is generated.

   * If <target> is EGL_NATIVE_PIXMAP_KHR, and <buffer> is not a handle
     to a valid NativePixmapType object, the error EGL_BAD_PARAMETER
     is generated."

1) Should this specification allow EGLImages to be created from native
   pixmaps which already have a pixmap surface associated with them, and
   vice versa?

   RESOLVED: Yes. There are practical usecases for this, and it is
   already the application's responsibility to handle any format
   mismatch or synchronization issues that this may allow.