1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #ifndef STW_FRAMEBUFFER_H
29 #define STW_FRAMEBUFFER_H
33 #include "os/os_thread.h"
36 struct st_framebuffer_iface
;
37 struct stw_pixelformat_info
;
40 * Windows framebuffer, derived from gl_framebuffer.
42 struct stw_framebuffer
45 * This mutex has two purposes:
46 * - protect the access to the mutable data members below
47 * - prevent the framebuffer from being deleted while being accessed.
49 * It is OK to lock this mutex while holding the stw_device::fb_mutex lock,
50 * but the opposite must never happen.
57 * Note that even access to immutable members implies acquiring the mutex
58 * above, to prevent the framebuffer from being destroyed.
65 const struct stw_pixelformat_info
*pfi
;
67 /* A pixel format that can be used by GDI */
68 int iDisplayablePixelFormat
;
71 struct st_framebuffer_iface
*stfb
;
80 /* FIXME: Make this work for multiple contexts bound to the same framebuffer */
87 * Client area rectangle, relative to the window upper-left corner.
89 * @sa GLCBPRESENTBUFFERSDATA::rect.
93 HANDLE hSharedSurface
;
94 struct stw_shared_surface
*shared_surface
;
97 * This is protected by stw_device::fb_mutex, not the mutex above.
99 * Deletions must be done by first acquiring stw_device::fb_mutex, and then
100 * acquiring the stw_framebuffer::mutex of the framebuffer to be deleted.
101 * This ensures that nobody else is reading/writing to the.
103 * It is not necessary to aquire the mutex above to navigate the linked list
104 * given that deletions are done with stw_device::fb_mutex held, so no other
107 struct stw_framebuffer
*next
;
112 * Create a new framebuffer object which will correspond to the given HDC.
114 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
115 * must be called when done
117 struct stw_framebuffer
*
118 stw_framebuffer_create(
123 stw_framebuffer_reference(
124 struct stw_framebuffer
**ptr
,
125 struct stw_framebuffer
*fb
);
128 * Search a framebuffer with a matching HWND.
130 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
131 * must be called when done
133 struct stw_framebuffer
*
134 stw_framebuffer_from_hwnd(
138 * Search a framebuffer with a matching HDC.
140 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
141 * must be called when done
143 struct stw_framebuffer
*
144 stw_framebuffer_from_hdc(
148 stw_framebuffer_present_locked(HDC hdc
,
149 struct stw_framebuffer
*fb
,
150 struct pipe_resource
*res
);
153 stw_framebuffer_update(
154 struct stw_framebuffer
*fb
);
157 * Release stw_framebuffer::mutex lock. This framebuffer must not be accessed
158 * after calling this function, as it may have been deleted by another thread
162 stw_framebuffer_release(
163 struct stw_framebuffer
*fb
);
166 * Cleanup any existing framebuffers when exiting application.
169 stw_framebuffer_cleanup(void);
171 #endif /* STW_FRAMEBUFFER_H */