src/gallium/drivers/llvmpipe/lp_winsys.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * llvmpipe public interface.
  31  */
  32
  33
  34 #ifndef LP_WINSYS_H
  35 #define LP_WINSYS_H
  36
  37
  38 #include "pipe/p_compiler.h" /* for boolean */
  39 #include "pipe/p_format.h"
  40
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46
  47 struct pipe_screen;
  48 struct pipe_context;
  49
  50
  51 /**
  52  * Opaque pointer.
  53  */
  54 struct llvmpipe_displaytarget;
  55
  56
  57 /**
  58  * This is the interface that llvmpipe expects any window system
  59  * hosting it to implement.
  60  *
  61  * llvmpipe is for the most part a self sufficient driver. The only thing it
  62  * does not know is how to display a surface.
  63  */
  64 struct llvmpipe_winsys
  65 {
  66    void
  67    (*destroy)( struct llvmpipe_winsys *ws );
  68
  69    boolean
  70    (*is_displaytarget_format_supported)( struct llvmpipe_winsys *ws,
  71                                          enum pipe_format format );
  72
  73    /**
  74     * Allocate storage for a render target.
  75     *
  76     * Often surfaces which are meant to be blitted to the front screen (i.e.,
  77     * display targets) must be allocated with special characteristics, memory
  78     * pools, or obtained directly from the windowing system.
  79     *
  80     * This callback is invoked by the pipe_screen when creating a texture marked
  81     * with the PIPE_TEXTURE_USAGE_DISPLAY_TARGET flag to get the underlying
  82     * storage.
  83     */
  84    struct llvmpipe_displaytarget *
  85    (*displaytarget_create)( struct llvmpipe_winsys *ws,
  86                             enum pipe_format format,
  87                             unsigned width, unsigned height,
  88                             unsigned alignment,
  89                             unsigned *stride );
  90
  91    void *
  92    (*displaytarget_map)( struct llvmpipe_winsys *ws,
  93                          struct llvmpipe_displaytarget *dt,
  94                          unsigned flags );
  95
  96    void
  97    (*displaytarget_unmap)( struct llvmpipe_winsys *ws,
  98                            struct llvmpipe_displaytarget *dt );
  99
 100    /**
 101     * @sa pipe_screen:flush_frontbuffer.
 102     *
 103     * This call will likely become asynchronous eventually.
 104     */
 105    void
 106    (*displaytarget_display)( struct llvmpipe_winsys *ws,
 107                              struct llvmpipe_displaytarget *dt,
 108                              void *context_private );
 109
 110    void
 111    (*displaytarget_destroy)( struct llvmpipe_winsys *ws,
 112                              struct llvmpipe_displaytarget *dt );
 113 };
 114
 115
 116
 117 struct pipe_screen *
 118 llvmpipe_create_screen( struct llvmpipe_winsys * );
 119
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* LP_WINSYS_H */