comctl32: Fix a typo in comment.
[wine.git] / dlls / winemac.drv / surface.c
blob1230bbed7361088810f702e5d42b15841b5263ee
1 /*
2 * Mac driver window surface implementation
4 * Copyright 1993, 1994, 2011 Alexandre Julliard
5 * Copyright 2006 Damjan Jovanovic
6 * Copyright 2012, 2013 Ken Thomases for CodeWeavers, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "config.h"
25 #include "macdrv.h"
26 #include "winuser.h"
28 WINE_DEFAULT_DEBUG_CHANNEL(macdrv);
31 /* only for use on sanitized BITMAPINFO structures */
32 static inline int get_dib_info_size(const BITMAPINFO *info, UINT coloruse)
34 if (info->bmiHeader.biCompression == BI_BITFIELDS)
35 return sizeof(BITMAPINFOHEADER) + 3 * sizeof(DWORD);
36 if (coloruse == DIB_PAL_COLORS)
37 return sizeof(BITMAPINFOHEADER) + info->bmiHeader.biClrUsed * sizeof(WORD);
38 return FIELD_OFFSET(BITMAPINFO, bmiColors[info->bmiHeader.biClrUsed]);
41 static inline int get_dib_stride(int width, int bpp)
43 return ((width * bpp + 31) >> 3) & ~3;
46 static inline int get_dib_image_size(const BITMAPINFO *info)
48 return get_dib_stride(info->bmiHeader.biWidth, info->bmiHeader.biBitCount)
49 * abs(info->bmiHeader.biHeight);
52 static inline void reset_bounds(RECT *bounds)
54 bounds->left = bounds->top = INT_MAX;
55 bounds->right = bounds->bottom = INT_MIN;
59 struct macdrv_window_surface
61 struct window_surface header;
62 macdrv_window window;
63 RECT bounds;
64 HRGN region;
65 HRGN drawn;
66 BOOL use_alpha;
67 RGNDATA *blit_data;
68 BYTE *bits;
69 pthread_mutex_t mutex;
70 BITMAPINFO info; /* variable size, must be last */
73 static struct macdrv_window_surface *get_mac_surface(struct window_surface *surface)
75 return (struct macdrv_window_surface *)surface;
78 /***********************************************************************
79 * update_blit_data
81 static void update_blit_data(struct macdrv_window_surface *surface)
83 HeapFree(GetProcessHeap(), 0, surface->blit_data);
84 surface->blit_data = NULL;
86 if (surface->drawn)
88 HRGN blit = CreateRectRgn(0, 0, 0, 0);
90 if (CombineRgn(blit, surface->drawn, 0, RGN_COPY) > NULLREGION &&
91 (!surface->region || CombineRgn(blit, blit, surface->region, RGN_AND) > NULLREGION) &&
92 OffsetRgn(blit, surface->header.rect.left, surface->header.rect.top) > NULLREGION)
93 surface->blit_data = get_region_data(blit, 0);
95 DeleteObject(blit);
99 /***********************************************************************
100 * macdrv_surface_lock
102 static void macdrv_surface_lock(struct window_surface *window_surface)
104 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
106 pthread_mutex_lock(&surface->mutex);
109 /***********************************************************************
110 * macdrv_surface_unlock
112 static void macdrv_surface_unlock(struct window_surface *window_surface)
114 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
116 pthread_mutex_unlock(&surface->mutex);
119 /***********************************************************************
120 * macdrv_surface_get_bitmap_info
122 static void *macdrv_surface_get_bitmap_info(struct window_surface *window_surface,
123 BITMAPINFO *info)
125 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
127 memcpy(info, &surface->info, get_dib_info_size(&surface->info, DIB_RGB_COLORS));
128 return surface->bits;
131 /***********************************************************************
132 * macdrv_surface_get_bounds
134 static RECT *macdrv_surface_get_bounds(struct window_surface *window_surface)
136 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
138 return &surface->bounds;
141 /***********************************************************************
142 * macdrv_surface_set_region
144 static void macdrv_surface_set_region(struct window_surface *window_surface, HRGN region)
146 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
148 TRACE("updating surface %p with %p\n", surface, region);
150 window_surface->funcs->lock(window_surface);
152 if (region)
154 if (!surface->region) surface->region = CreateRectRgn(0, 0, 0, 0);
155 CombineRgn(surface->region, region, 0, RGN_COPY);
157 else
159 if (surface->region) DeleteObject(surface->region);
160 surface->region = 0;
162 update_blit_data(surface);
164 window_surface->funcs->unlock(window_surface);
167 /***********************************************************************
168 * macdrv_surface_flush
170 static void macdrv_surface_flush(struct window_surface *window_surface)
172 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
173 CGRect rect;
174 HRGN region;
176 window_surface->funcs->lock(window_surface);
178 TRACE("flushing %p %s bounds %s bits %p\n", surface, wine_dbgstr_rect(&surface->header.rect),
179 wine_dbgstr_rect(&surface->bounds), surface->bits);
181 rect = cgrect_from_rect(surface->bounds);
182 rect = CGRectOffset(rect, surface->header.rect.left, surface->header.rect.top);
184 if (!IsRectEmpty(&surface->bounds) && (region = CreateRectRgnIndirect(&surface->bounds)))
186 if (surface->drawn)
188 CombineRgn(surface->drawn, surface->drawn, region, RGN_OR);
189 DeleteObject(region);
191 else
192 surface->drawn = region;
194 update_blit_data(surface);
195 reset_bounds(&surface->bounds);
197 window_surface->funcs->unlock(window_surface);
199 if (!CGRectIsEmpty(rect))
200 macdrv_window_needs_display(surface->window, rect);
203 /***********************************************************************
204 * macdrv_surface_destroy
206 static void macdrv_surface_destroy(struct window_surface *window_surface)
208 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
210 TRACE("freeing %p bits %p\n", surface, surface->bits);
211 HeapFree(GetProcessHeap(), 0, surface->bits);
212 pthread_mutex_destroy(&surface->mutex);
213 HeapFree(GetProcessHeap(), 0, surface);
216 static const struct window_surface_funcs macdrv_surface_funcs =
218 macdrv_surface_lock,
219 macdrv_surface_unlock,
220 macdrv_surface_get_bitmap_info,
221 macdrv_surface_get_bounds,
222 macdrv_surface_set_region,
223 macdrv_surface_flush,
224 macdrv_surface_destroy,
227 /***********************************************************************
228 * create_surface
230 struct window_surface *create_surface(macdrv_window window, const RECT *rect,
231 struct window_surface *old_surface, BOOL use_alpha)
233 struct macdrv_window_surface *surface;
234 struct macdrv_window_surface *old_mac_surface = get_mac_surface(old_surface);
235 int width = rect->right - rect->left, height = rect->bottom - rect->top;
236 DWORD *colors;
237 pthread_mutexattr_t attr;
238 int err;
239 DWORD window_background;
241 surface = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
242 FIELD_OFFSET(struct macdrv_window_surface, info.bmiColors[3]));
243 if (!surface) return NULL;
245 err = pthread_mutexattr_init(&attr);
246 if (!err)
248 err = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
249 if (!err)
250 err = pthread_mutex_init(&surface->mutex, &attr);
251 pthread_mutexattr_destroy(&attr);
253 if (err)
255 HeapFree(GetProcessHeap(), 0, surface);
256 return NULL;
259 surface->info.bmiHeader.biSize = sizeof(surface->info.bmiHeader);
260 surface->info.bmiHeader.biWidth = width;
261 surface->info.bmiHeader.biHeight = height; /* bottom-up */
262 surface->info.bmiHeader.biPlanes = 1;
263 surface->info.bmiHeader.biBitCount = 32;
264 surface->info.bmiHeader.biSizeImage = get_dib_image_size(&surface->info);
265 surface->info.bmiHeader.biCompression = BI_RGB;
266 surface->info.bmiHeader.biClrUsed = 0;
268 colors = (DWORD *)((char *)&surface->info + surface->info.bmiHeader.biSize);
269 colors[0] = 0x00ff0000;
270 colors[1] = 0x0000ff00;
271 colors[2] = 0x000000ff;
273 surface->header.funcs = &macdrv_surface_funcs;
274 surface->header.rect = *rect;
275 surface->header.ref = 1;
276 surface->window = window;
277 reset_bounds(&surface->bounds);
278 if (old_mac_surface && old_mac_surface->drawn)
280 surface->drawn = CreateRectRgnIndirect(rect);
281 OffsetRgn(surface->drawn, -rect->left, -rect->top);
282 if (CombineRgn(surface->drawn, surface->drawn, old_mac_surface->drawn, RGN_AND) <= NULLREGION)
284 DeleteObject(surface->drawn);
285 surface->drawn = 0;
288 update_blit_data(surface);
289 surface->use_alpha = use_alpha;
290 surface->bits = HeapAlloc(GetProcessHeap(), 0, surface->info.bmiHeader.biSizeImage);
291 if (!surface->bits) goto failed;
292 window_background = macdrv_window_background_color();
293 memset_pattern4(surface->bits, &window_background, surface->info.bmiHeader.biSizeImage);
295 TRACE("created %p for %p %s bits %p-%p\n", surface, window, wine_dbgstr_rect(rect),
296 surface->bits, surface->bits + surface->info.bmiHeader.biSizeImage);
298 return &surface->header;
300 failed:
301 macdrv_surface_destroy(&surface->header);
302 return NULL;
305 /***********************************************************************
306 * set_surface_use_alpha
308 void set_surface_use_alpha(struct window_surface *window_surface, BOOL use_alpha)
310 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
311 surface->use_alpha = use_alpha;
314 /***********************************************************************
315 * set_window_surface
317 void set_window_surface(macdrv_window window, struct window_surface *window_surface)
319 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
320 macdrv_set_window_surface(window, window_surface, surface ? &surface->mutex : NULL);
323 /***********************************************************************
324 * get_surface_blit_rects
326 * Caller must hold the surface lock. Indirectly returns the surface
327 * blit region rects. Returns zero if the surface has nothing to blit;
328 * returns non-zero if the surface does have rects to blit (drawn area
329 * which isn't clipped away by a surface region).
331 * IMPORTANT: This function is called from non-Wine threads, so it
332 * must not use Win32 or Wine functions, including debug
333 * logging.
335 int get_surface_blit_rects(void *window_surface, const CGRect **rects, int *count)
337 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
339 if (surface->blit_data)
341 *rects = (const CGRect*)surface->blit_data->Buffer;
342 *count = surface->blit_data->rdh.nCount;
344 else
346 *rects = NULL;
347 *count = 0;
350 return (surface->blit_data != NULL);
353 /***********************************************************************
354 * create_surface_image
356 * Caller must hold the surface lock. On input, *rect is the requested
357 * image rect, relative to the window whole_rect, a.k.a. visible_rect.
358 * On output, it's been intersected with that part backed by the surface
359 * and is the actual size of the returned image. copy_data indicates if
360 * the caller will keep the returned image beyond the point where the
361 * surface bits can be guaranteed to remain valid and unchanged. If so,
362 * the bits are copied instead of merely referenced by the image.
364 * IMPORTANT: This function is called from non-Wine threads, so it
365 * must not use Win32 or Wine functions, including debug
366 * logging.
368 CGImageRef create_surface_image(void *window_surface, CGRect *rect, int copy_data)
370 CGImageRef cgimage = NULL;
371 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
372 int width, height;
374 width = surface->header.rect.right - surface->header.rect.left;
375 height = surface->header.rect.bottom - surface->header.rect.top;
376 *rect = CGRectIntersection(cgrect_from_rect(surface->header.rect), *rect);
377 if (!CGRectIsEmpty(*rect))
379 CGRect visrect;
380 CGColorSpaceRef colorspace;
381 CGDataProviderRef provider;
382 int bytes_per_row, offset, size;
383 CGImageAlphaInfo alphaInfo;
385 visrect = CGRectOffset(*rect, -surface->header.rect.left, -surface->header.rect.top);
387 colorspace = CGColorSpaceCreateWithName(kCGColorSpaceGenericRGB);
388 bytes_per_row = get_dib_stride(width, 32);
389 offset = CGRectGetMinX(visrect) * 4 + (height - CGRectGetMaxY(visrect)) * bytes_per_row;
390 size = min(CGRectGetHeight(visrect) * bytes_per_row,
391 surface->info.bmiHeader.biSizeImage - offset);
393 if (copy_data)
395 CFDataRef data = CFDataCreate(NULL, (UInt8*)surface->bits + offset, size);
396 provider = CGDataProviderCreateWithCFData(data);
397 CFRelease(data);
399 else
400 provider = CGDataProviderCreateWithData(NULL, surface->bits + offset, size, NULL);
402 alphaInfo = surface->use_alpha ? kCGImageAlphaPremultipliedFirst : kCGImageAlphaNoneSkipFirst;
403 cgimage = CGImageCreate(CGRectGetWidth(visrect), CGRectGetHeight(visrect),
404 8, 32, bytes_per_row, colorspace,
405 alphaInfo | kCGBitmapByteOrder32Little,
406 provider, NULL, retina_on, kCGRenderingIntentDefault);
407 CGDataProviderRelease(provider);
408 CGColorSpaceRelease(colorspace);
411 return cgimage;
414 /***********************************************************************
415 * surface_clip_to_visible_rect
417 * Intersect the accumulated drawn region with a new visible rect,
418 * effectively discarding stale drawing in the surface slack area.
420 void surface_clip_to_visible_rect(struct window_surface *window_surface, const RECT *visible_rect)
422 struct macdrv_window_surface *surface = get_mac_surface(window_surface);
424 window_surface->funcs->lock(window_surface);
426 if (surface->drawn)
428 RECT rect;
429 HRGN region;
431 rect = *visible_rect;
432 OffsetRect(&rect, -rect.left, -rect.top);
434 if ((region = CreateRectRgnIndirect(&rect)))
436 CombineRgn(surface->drawn, surface->drawn, region, RGN_AND);
437 DeleteObject(region);
439 update_blit_data(surface);
443 window_surface->funcs->unlock(window_surface);