tests/util/piglit-framework-gl/piglit_winsys_framework.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #pragma once
  25
  26 #include "piglit_wfl_framework.h"
  27
  28 /**
  29  * Abstract class. Use winsys_framework_factory() to create a concrete
  30  * instance.
  31  */
  32 struct piglit_winsys_framework {
  33         struct piglit_wfl_framework wfl_fw;
  34
  35         /**
  36          * Has the user requested a redisplay with
  37          * piglit_gl_framework::post_redisplay?
  38          */
  39         bool need_redisplay;
  40
  41         /**
  42          * Must be implemented by subclasses.
  43          *
  44          * TODO(chad): This could be removed.
  45          */
  46         void
  47         (*show_window)(struct piglit_winsys_framework *winsys_fw);
  48
  49         void
  50         (*enter_event_loop)(struct piglit_winsys_framework *winsys_fw);
  51
  52         /**
  53          * Set with piglit_gl_framework::set_keyboard_func. May be null.
  54          */
  55         void
  56         (*user_keyboard_func)(unsigned char key, int x, int y);
  57
  58         /**
  59          * Set with piglit_gl_framework::user_reshape_func. May be null.
  60          */
  61         void
  62         (*user_reshape_func)(int width, int height);
  63 };
  64
  65 /**
  66  * Typesafe cast.
  67  */
  68 struct piglit_winsys_framework*
  69 piglit_winsys_framework(struct piglit_gl_framework *gl_fw);
  70
  71 struct piglit_gl_framework*
  72 piglit_winsys_framework_factory(const struct piglit_gl_test_config *test_config);
  73
  74 /**
  75  * @param platform must be one of WAFFLE_PLATFORM_*.
  76  */
  77 bool
  78 piglit_winsys_framework_init(struct piglit_winsys_framework *winsys_fw,
  79                              const struct piglit_gl_test_config *test_config,
  80                              int32_t platform);
  81
  82 void
  83 piglit_winsys_framework_teardown(struct piglit_winsys_framework *winsys_fw);