src/gl-renderer.h

   1 /*
   2  * Copyright © 2012 John Kåre Alsaker
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation for any purpose is hereby granted without fee, provided
   6  * that the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of the copyright holders not be used in
   9  * advertising or publicity pertaining to distribution of the software
  10  * without specific, written prior permission.  The copyright holders make
  11  * no representations about the suitability of this software for any
  12  * purpose.  It is provided "as is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  15  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  16  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  17  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  18  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  19  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21  */
  22
  23 #include "config.h"
  24
  25 #include "compositor.h"
  26
  27 #ifdef ENABLE_EGL
  28
  29 #include <EGL/egl.h>
  30
  31 #else
  32
  33 typedef int EGLint;
  34 typedef void *EGLDisplay;
  35 typedef void *EGLSurface;
  36 typedef intptr_t EGLNativeDisplayType;
  37 typedef intptr_t EGLNativeWindowType;
  38 #define EGL_DEFAULT_DISPLAY ((EGLNativeDisplayType)0)
  39
  40 #endif
  41
  42 enum gl_renderer_border_side {
  43         GL_RENDERER_BORDER_TOP = 0,
  44         GL_RENDERER_BORDER_LEFT = 1,
  45         GL_RENDERER_BORDER_RIGHT = 2,
  46         GL_RENDERER_BORDER_BOTTOM = 3,
  47 };
  48
  49 struct gl_renderer_interface {
  50         const EGLint *opaque_attribs;
  51         const EGLint *alpha_attribs;
  52
  53         int (*create)(struct weston_compositor *ec,
  54                       EGLNativeDisplayType display,
  55                       const EGLint *attribs,
  56                       const EGLint *visual_id);
  57
  58         EGLDisplay (*display)(struct weston_compositor *ec);
  59
  60         int (*output_create)(struct weston_output *output,
  61                              EGLNativeWindowType window,
  62                              const EGLint *attribs,
  63                              const EGLint *visual_id);
  64
  65         void (*output_destroy)(struct weston_output *output);
  66
  67         EGLSurface (*output_surface)(struct weston_output *output);
  68
  69         /* Sets the output border.
  70          *
  71          * The side specifies the side for which we are setting the border.
  72          * The width and height are the width and height of the border.
  73          * The tex_width patemeter specifies the width of the actual
  74          * texture; this may be larger than width if the data is not
  75          * tightly packed.
  76          *
  77          * The top and bottom textures will extend over the sides to the
  78          * full width of the bordered window.  The right and left edges,
  79          * however, will extend only to the top and bottom of the
  80          * compositor surface.  This is demonstrated by the picture below:
  81          *
  82          * +-----------------------+
  83          * |          TOP          |
  84          * +-+-------------------+-+
  85          * | |                   | |
  86          * |L|                   |R|
  87          * |E|                   |I|
  88          * |F|                   |G|
  89          * |T|                   |H|
  90          * | |                   |T|
  91          * | |                   | |
  92          * +-+-------------------+-+
  93          * |        BOTTOM         |
  94          * +-----------------------+
  95          */
  96         void (*output_set_border)(struct weston_output *output,
  97                                   enum gl_renderer_border_side side,
  98                                   int32_t width, int32_t height,
  99                                   int32_t tex_width, unsigned char *data);
 100
 101         void (*print_egl_error_state)(void);
 102 };
 103