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 VMWARE 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 * Software rasterizer winsys. 31 */ 32 33 34 #ifndef SW_WINSYS_H 35 #define SW_WINSYS_H 36 37 38 #include "util/format/u_formats.h" 39 #include "frontend/winsys_handle.h" 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 46 struct pipe_screen; 47 struct pipe_context; 48 struct pipe_resource; 49 struct pipe_box; 50 51 /** 52 * Opaque pointer. 53 */ 54 struct sw_displaytarget; 55 56 57 /** 58 * This is the interface that sw expects any window system 59 * hosting it to implement. 60 * 61 * sw 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 sw_winsys 65 { 66 void 67 (*destroy)( struct sw_winsys *ws ); 68 69 int 70 (*get_fd)( struct sw_winsys *ws ); 71 72 bool 73 (*is_displaytarget_format_supported)( struct sw_winsys *ws, 74 unsigned tex_usage, 75 enum pipe_format format ); 76 77 /** 78 * Allocate storage for a render target. 79 * 80 * Often surfaces which are meant to be blitted to the front screen (i.e., 81 * display targets) must be allocated with special characteristics, memory 82 * pools, or obtained directly from the windowing system. 83 * 84 * This callback is invoked by the pipe_screen when creating a texture marked 85 * with the PIPE_BIND_DISPLAY_TARGET flag to get the underlying 86 * storage. 87 */ 88 struct sw_displaytarget * 89 (*displaytarget_create)( struct sw_winsys *ws, 90 unsigned tex_usage, 91 enum pipe_format format, 92 unsigned width, unsigned height, 93 unsigned alignment, 94 const void *front_private, 95 unsigned *stride ); 96 97 /** 98 * Used to implement texture_from_handle. 99 */ 100 struct sw_displaytarget * 101 (*displaytarget_from_handle)( struct sw_winsys *ws, 102 const struct pipe_resource *templat, 103 struct winsys_handle *whandle, 104 unsigned *stride ); 105 106 /** 107 * Used to implement texture_get_handle. 108 */ 109 bool 110 (*displaytarget_get_handle)( struct sw_winsys *ws, 111 struct sw_displaytarget *dt, 112 struct winsys_handle *whandle ); 113 114 /** 115 * \param flags bitmask of PIPE_MAP_x flags 116 */ 117 void * 118 (*displaytarget_map)( struct sw_winsys *ws, 119 struct sw_displaytarget *dt, 120 unsigned flags ); 121 122 void 123 (*displaytarget_unmap)( struct sw_winsys *ws, 124 struct sw_displaytarget *dt ); 125 126 /** 127 * @sa pipe_screen:flush_frontbuffer. 128 * 129 * This call will likely become asynchronous eventually. 130 */ 131 void 132 (*displaytarget_display)( struct sw_winsys *ws, 133 struct sw_displaytarget *dt, 134 void *context_private, 135 unsigned nboxes, 136 struct pipe_box *box ); 137 138 void 139 (*displaytarget_destroy)( struct sw_winsys *ws, 140 struct sw_displaytarget *dt ); 141 142 struct sw_displaytarget * 143 (*displaytarget_create_mapped)( struct sw_winsys *ws, 144 unsigned tex_usage, 145 enum pipe_format format, 146 unsigned width, unsigned height, 147 unsigned stride, 148 void *data ); 149 }; 150 151 152 153 #ifdef __cplusplus 154 } 155 #endif 156 157 #endif /* SW_WINSYS_H */ 158