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 "pipe/p_format.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    bool
70    (*is_displaytarget_format_supported)( struct sw_winsys *ws,
71                                          unsigned tex_usage,
72                                          enum pipe_format format );
73 
74    /**
75     * Allocate storage for a render target.
76     *
77     * Often surfaces which are meant to be blitted to the front screen (i.e.,
78     * display targets) must be allocated with special characteristics, memory
79     * pools, or obtained directly from the windowing system.
80     *
81     * This callback is invoked by the pipe_screen when creating a texture marked
82     * with the PIPE_BIND_DISPLAY_TARGET flag to get the underlying
83     * storage.
84     */
85    struct sw_displaytarget *
86    (*displaytarget_create)( struct sw_winsys *ws,
87                             unsigned tex_usage,
88                             enum pipe_format format,
89                             unsigned width, unsigned height,
90                             unsigned alignment,
91                             const void *front_private,
92                             unsigned *stride );
93 
94    /**
95     * Used to implement texture_from_handle.
96     */
97    struct sw_displaytarget *
98    (*displaytarget_from_handle)( struct sw_winsys *ws,
99                                  const struct pipe_resource *templat,
100                                  struct winsys_handle *whandle,
101                                  unsigned *stride );
102 
103    /**
104     * Used to implement texture_get_handle.
105     */
106    bool
107    (*displaytarget_get_handle)( struct sw_winsys *ws,
108                                 struct sw_displaytarget *dt,
109                                 struct winsys_handle *whandle );
110 
111    /**
112     * \param flags  bitmask of PIPE_MAP_x flags
113     */
114    void *
115    (*displaytarget_map)( struct sw_winsys *ws,
116                          struct sw_displaytarget *dt,
117                          unsigned flags );
118 
119    void
120    (*displaytarget_unmap)( struct sw_winsys *ws,
121                            struct sw_displaytarget *dt );
122 
123    /**
124     * @sa pipe_screen:flush_frontbuffer.
125     *
126     * This call will likely become asynchronous eventually.
127     */
128    void
129    (*displaytarget_display)( struct sw_winsys *ws,
130                              struct sw_displaytarget *dt,
131                              void *context_private,
132                              struct pipe_box *box );
133 
134    void
135    (*displaytarget_destroy)( struct sw_winsys *ws,
136                              struct sw_displaytarget *dt );
137 };
138 
139 
140 
141 #ifdef __cplusplus
142 }
143 #endif
144 
145 #endif /* SW_WINSYS_H */
146