1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
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 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.
26 **************************************************************************/
28 #ifndef STW_FRAMEBUFFER_H
29 #define STW_FRAMEBUFFER_H
33 #include "util/u_debug.h"
37 struct st_framebuffer_iface
;
38 struct stw_pixelformat_info
;
41 * Windows framebuffer.
43 struct stw_framebuffer
46 * This mutex has two purposes:
47 * - protect the access to the mutable data members below
48 * - prevent the framebuffer from being deleted while being accessed.
50 * Note: if both this mutex and the stw_device::fb_mutex need to be locked,
51 * the stw_device::fb_mutex needs to be locked first.
53 CRITICAL_SECTION mutex
;
58 * Note that even access to immutable members implies acquiring the mutex
59 * 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 */
83 boolean minimized
; /**< Is the window currently minimized? */
89 * Client area rectangle, relative to the window upper-left corner.
91 * @sa GLCBPRESENTBUFFERSDATA::rect.
95 HANDLE hSharedSurface
;
96 struct stw_shared_surface
*shared_surface
;
99 * This is protected by stw_device::fb_mutex, not the mutex above.
101 * Deletions must be done by first acquiring stw_device::fb_mutex, and then
102 * acquiring the stw_framebuffer::mutex of the framebuffer to be deleted.
103 * This ensures that nobody else is reading/writing to the.
105 * It is not necessary to acquire the mutex above to navigate the linked list
106 * given that deletions are done with stw_device::fb_mutex held, so no other
109 struct stw_framebuffer
*next
;
114 * Create a new framebuffer object which will correspond to the given HDC.
116 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
117 * must be called when done
119 struct stw_framebuffer
*
120 stw_framebuffer_create(HDC hdc
, int iPixelFormat
);
123 stw_framebuffer_reference(struct stw_framebuffer
**ptr
,
124 struct stw_framebuffer
*fb
);
127 * Search a framebuffer with a matching HWND.
129 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
130 * must be called when done
132 struct stw_framebuffer
*
133 stw_framebuffer_from_hwnd(HWND hwnd
);
136 * Search a framebuffer with a matching HDC.
138 * This function will acquire stw_framebuffer::mutex. stw_framebuffer_release
139 * must be called when done
141 struct stw_framebuffer
*
142 stw_framebuffer_from_hdc(HDC hdc
);
145 stw_framebuffer_present_locked(HDC hdc
,
146 struct stw_framebuffer
*fb
,
147 struct pipe_resource
*res
);
150 stw_framebuffer_update(struct stw_framebuffer
*fb
);
154 stw_framebuffer_lock(struct stw_framebuffer
*fb
)
157 EnterCriticalSection(&fb
->mutex
);
162 * Release stw_framebuffer::mutex lock. This framebuffer must not be accessed
163 * after calling this function, as it may have been deleted by another thread
167 stw_framebuffer_release(struct stw_framebuffer
*fb
)
170 LeaveCriticalSection(&fb
->mutex
);
175 * Cleanup any existing framebuffers when exiting application.
178 stw_framebuffer_cleanup(void);
180 #endif /* STW_FRAMEBUFFER_H */