SDL  2.0
SDL_cocoavideo.m
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../../SDL_internal.h"
22 
23 #if SDL_VIDEO_DRIVER_COCOA
24 
25 #include "SDL.h"
26 #include "SDL_endian.h"
27 #include "SDL_cocoavideo.h"
28 #include "SDL_cocoashape.h"
29 #include "SDL_cocoavulkan.h"
30 #include "SDL_assert.h"
31 
32 /* Initialization/Query functions */
33 static int Cocoa_VideoInit(_THIS);
34 static void Cocoa_VideoQuit(_THIS);
35 
36 /* Cocoa driver bootstrap functions */
37 
38 static int
39 Cocoa_Available(void)
40 {
41  return (1);
42 }
43 
44 static void
45 Cocoa_DeleteDevice(SDL_VideoDevice * device)
46 {
47  SDL_free(device->driverdata);
48  SDL_free(device);
49 }
50 
51 static SDL_VideoDevice *
52 Cocoa_CreateDevice(int devindex)
53 {
56 
58 
59  /* Initialize all variables that we clean on shutdown */
60  device = (SDL_VideoDevice *) SDL_calloc(1, sizeof(SDL_VideoDevice));
61  if (device) {
62  data = (struct SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
63  } else {
64  data = NULL;
65  }
66  if (!data) {
68  SDL_free(device);
69  return NULL;
70  }
71  device->driverdata = data;
72 
73  /* Set the function pointers */
74  device->VideoInit = Cocoa_VideoInit;
75  device->VideoQuit = Cocoa_VideoQuit;
81  device->PumpEvents = Cocoa_PumpEvents;
83 
93  device->ShowWindow = Cocoa_ShowWindow;
94  device->HideWindow = Cocoa_HideWindow;
108 
112 
113 #if SDL_VIDEO_OPENGL_CGL
114  device->GL_LoadLibrary = Cocoa_GL_LoadLibrary;
115  device->GL_GetProcAddress = Cocoa_GL_GetProcAddress;
116  device->GL_UnloadLibrary = Cocoa_GL_UnloadLibrary;
117  device->GL_CreateContext = Cocoa_GL_CreateContext;
118  device->GL_MakeCurrent = Cocoa_GL_MakeCurrent;
119  device->GL_GetDrawableSize = Cocoa_GL_GetDrawableSize;
120  device->GL_SetSwapInterval = Cocoa_GL_SetSwapInterval;
121  device->GL_GetSwapInterval = Cocoa_GL_GetSwapInterval;
122  device->GL_SwapWindow = Cocoa_GL_SwapWindow;
123  device->GL_DeleteContext = Cocoa_GL_DeleteContext;
124 #elif SDL_VIDEO_OPENGL_EGL
125  device->GL_LoadLibrary = Cocoa_GLES_LoadLibrary;
126  device->GL_GetProcAddress = Cocoa_GLES_GetProcAddress;
127  device->GL_UnloadLibrary = Cocoa_GLES_UnloadLibrary;
128  device->GL_CreateContext = Cocoa_GLES_CreateContext;
129  device->GL_MakeCurrent = Cocoa_GLES_MakeCurrent;
130  device->GL_SetSwapInterval = Cocoa_GLES_SetSwapInterval;
131  device->GL_GetSwapInterval = Cocoa_GLES_GetSwapInterval;
132  device->GL_SwapWindow = Cocoa_GLES_SwapWindow;
133  device->GL_DeleteContext = Cocoa_GLES_DeleteContext;
134 #endif
135 
136 #if SDL_VIDEO_VULKAN
137  device->Vulkan_LoadLibrary = Cocoa_Vulkan_LoadLibrary;
138  device->Vulkan_UnloadLibrary = Cocoa_Vulkan_UnloadLibrary;
139  device->Vulkan_GetInstanceExtensions = Cocoa_Vulkan_GetInstanceExtensions;
140  device->Vulkan_CreateSurface = Cocoa_Vulkan_CreateSurface;
141  device->Vulkan_GetDrawableSize = Cocoa_Vulkan_GetDrawableSize;
142 #endif
143 
147 
151 
152  device->free = Cocoa_DeleteDevice;
153 
154  return device;
155 }
156 
158  "cocoa", "SDL Cocoa video driver",
159  Cocoa_Available, Cocoa_CreateDevice
160 };
161 
162 
163 int
164 Cocoa_VideoInit(_THIS)
165 {
167 
171 
172  data->allow_spaces = ((floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6) && SDL_GetHintBoolean(SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES, SDL_TRUE));
173 
174  /* The IOPM assertion API can disable the screensaver as of 10.7. */
175  data->screensaver_use_iopm = floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6;
176 
177  return 0;
178 }
179 
180 void
181 Cocoa_VideoQuit(_THIS)
182 {
186 }
187 
188 /* This function assumes that it's called from within an autorelease pool */
189 NSImage *
191 {
192  SDL_Surface *converted;
193  NSBitmapImageRep *imgrep;
194  Uint8 *pixels;
195  int i;
196  NSImage *img;
197 
198  converted = SDL_ConvertSurfaceFormat(surface, SDL_PIXELFORMAT_RGBA32, 0);
199  if (!converted) {
200  return nil;
201  }
202 
203  imgrep = [[[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
204  pixelsWide: converted->w
205  pixelsHigh: converted->h
206  bitsPerSample: 8
207  samplesPerPixel: 4
208  hasAlpha: YES
209  isPlanar: NO
210  colorSpaceName: NSDeviceRGBColorSpace
211  bytesPerRow: converted->pitch
212  bitsPerPixel: converted->format->BitsPerPixel] autorelease];
213  if (imgrep == nil) {
214  SDL_FreeSurface(converted);
215  return nil;
216  }
217 
218  /* Copy the pixels */
219  pixels = [imgrep bitmapData];
220  SDL_memcpy(pixels, converted->pixels, converted->h * converted->pitch);
221  SDL_FreeSurface(converted);
222 
223  /* Premultiply the alpha channel */
224  for (i = (surface->h * surface->w); i--; ) {
225  Uint8 alpha = pixels[3];
226  pixels[0] = (Uint8)(((Uint16)pixels[0] * alpha) / 255);
227  pixels[1] = (Uint8)(((Uint16)pixels[1] * alpha) / 255);
228  pixels[2] = (Uint8)(((Uint16)pixels[2] * alpha) / 255);
229  pixels += 4;
230  }
231 
232  img = [[[NSImage alloc] initWithSize: NSMakeSize(surface->w, surface->h)] autorelease];
233  if (img != nil) {
234  [img addRepresentation: imgrep];
235  }
236  return img;
237 }
238 
239 /*
240  * Mac OS X log support.
241  *
242  * This doesn't really have aything to do with the interfaces of the SDL video
243  * subsystem, but we need to stuff this into an Objective-C source code file.
244  */
245 
246 void SDL_NSLog(const char *text)
247 {
248  NSLog(@"%s", text);
249 }
250 
251 #endif /* SDL_VIDEO_DRIVER_COCOA */
252 
253 /* vim: set ts=4 sw=4 expandtab: */
void Cocoa_GetDisplayModes(_THIS, SDL_VideoDisplay *display)
int(* Vulkan_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:270
int Cocoa_CreateWindowFrom(_THIS, SDL_Window *window, const void *data)
void Cocoa_SetTextInputRect(_THIS, SDL_Rect *rect)
void Cocoa_RegisterApp(void)
int(* GetDisplayDPI)(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi)
Definition: SDL_sysvideo.h:186
void Cocoa_InitMouse(_THIS)
#define SDL_ConvertSurfaceFormat
void(* RestoreWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:227
char * Cocoa_GetClipboardText(_THIS)
void Cocoa_MinimizeWindow(_THIS, SDL_Window *window)
int(* SetWindowHitTest)(SDL_Window *window, SDL_bool enabled)
Definition: SDL_sysvideo.h:305
void Cocoa_SetWindowIcon(_THIS, SDL_Window *window, SDL_Surface *icon)
void Cocoa_SetWindowMaximumSize(_THIS, SDL_Window *window)
void Cocoa_SetWindowResizable(_THIS, SDL_Window *window, SDL_bool resizable)
void Cocoa_SetWindowBordered(_THIS, SDL_Window *window, SDL_bool bordered)
void(* free)(_THIS)
Definition: SDL_sysvideo.h:390
EGLSurface surface
Definition: eglext.h:248
A collection of pixels used in software blitting.
Definition: SDL_surface.h:69
int(* GL_SetSwapInterval)(_THIS, int interval)
Definition: SDL_sysvideo.h:260
void(* ShowWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:222
void(* StartTextInput)(_THIS)
Definition: SDL_sysvideo.h:286
void(* SetWindowSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:215
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
void Cocoa_SuspendScreenSaver(_THIS)
void Cocoa_SetWindowTitle(_THIS, SDL_Window *window)
void Cocoa_SetWindowPosition(_THIS, SDL_Window *window)
void Cocoa_StartTextInput(_THIS)
int(* GL_LoadLibrary)(_THIS, const char *path)
Definition: SDL_sysvideo.h:254
GLfloat GLfloat GLfloat alpha
int Cocoa_GetDisplayUsableBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
int(* SetDisplayMode)(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
Definition: SDL_sysvideo.h:204
#define SDL_GetHintBoolean
void(* SetWindowBordered)(_THIS, SDL_Window *window, SDL_bool bordered)
Definition: SDL_sysvideo.h:228
void(* GL_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h)
Definition: SDL_sysvideo.h:259
void Cocoa_QuitKeyboard(_THIS)
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
void Cocoa_RestoreWindow(_THIS, SDL_Window *window)
int Cocoa_SetClipboardText(_THIS, const char *text)
SDL_bool Cocoa_HasClipboardText(_THIS)
void(* HideWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:223
static SDL_AudioDeviceID device
Definition: loopwave.c:37
int Cocoa_SetWindowShape(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
void(* RaiseWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:224
int(* SetWindowShape)(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
Definition: SDL_sysvideo.h:61
void Cocoa_ShowWindow(_THIS, SDL_Window *window)
void(* SetTextInputRect)(_THIS, SDL_Rect *rect)
Definition: SDL_sysvideo.h:288
#define SDL_memcpy
SDL_bool(* Vulkan_GetInstanceExtensions)(_THIS, SDL_Window *window, unsigned *count, const char **names)
Definition: SDL_sysvideo.h:272
GLint GLvoid * img
Definition: SDL_opengl.h:1980
SDL_bool(* GetWindowWMInfo)(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
Definition: SDL_sysvideo.h:247
int Cocoa_SetDisplayMode(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
NSImage * Cocoa_CreateImage(SDL_Surface *surface)
SDL_GLContext(* GL_CreateContext)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:257
void(* Vulkan_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h)
Definition: SDL_sysvideo.h:274
SDL_bool(* Vulkan_CreateSurface)(_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface)
Definition: SDL_sysvideo.h:273
void * pixels
Definition: SDL_surface.h:75
#define SDL_FreeSurface
void Cocoa_QuitMouse(_THIS)
#define _THIS
int(* GL_MakeCurrent)(_THIS, SDL_Window *window, SDL_GLContext context)
Definition: SDL_sysvideo.h:258
uint8_t Uint8
Definition: SDL_stdinc.h:157
#define SDL_free
void Cocoa_PumpEvents(_THIS)
int Cocoa_SetWindowGammaRamp(_THIS, SDL_Window *window, const Uint16 *ramp)
void Cocoa_DestroyWindow(_THIS, SDL_Window *window)
#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES
A variable that dictates policy for fullscreen Spaces on Mac OS X.
Definition: SDL_hints.h:697
void Cocoa_RaiseWindow(_THIS, SDL_Window *window)
void(* Vulkan_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:271
SDL_bool Cocoa_GetWindowWMInfo(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
BOOL screensaver_use_iopm
void(* SetWindowMinimumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:216
int Cocoa_GetDisplayDPI(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hpdi, float *vdpi)
int(* GetDisplayBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:181
void(* DestroyWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:234
void(* StopTextInput)(_THIS)
Definition: SDL_sysvideo.h:287
SDL_WindowShaper * Cocoa_CreateShaper(SDL_Window *window)
void(* SetWindowIcon)(_THIS, SDL_Window *window, SDL_Surface *icon)
Definition: SDL_sysvideo.h:213
int Cocoa_SetWindowOpacity(_THIS, SDL_Window *window, float opacity)
GLint GLint GLsizei GLsizei GLsizei GLint GLenum GLenum const GLvoid * pixels
Definition: SDL_opengl.h:1572
double floor(double x)
Definition: s_floor.c:29
void Cocoa_SetWindowFullscreen(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
void(* GL_UnloadLibrary)(_THIS)
Definition: SDL_sysvideo.h:256
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display Drawable _Xconst char unsigned int unsigned int return Display Pixmap Pixmap XColor XColor unsigned int unsigned int return Display _Xconst char char int char return Display Visual unsigned int int int char unsigned int unsigned int in i)
Definition: SDL_x11sym.h:50
void(* GetDisplayModes)(_THIS, SDL_VideoDisplay *display)
Definition: SDL_sysvideo.h:196
void(* SetWindowMaximumSize)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:217
#define NULL
Definition: begin_code.h:164
int(* CreateSDLWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:210
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
void(* VideoQuit)(_THIS)
Definition: SDL_sysvideo.h:166
int Cocoa_CreateWindow(_THIS, SDL_Window *window)
SDL_WindowShaper *(* CreateShaper)(SDL_Window *window)
Definition: SDL_sysvideo.h:60
int Cocoa_GetWindowGammaRamp(_THIS, SDL_Window *window, Uint16 *ramp)
static char text[MAX_TEXT_LENGTH]
Definition: testime.c:47
#define SDL_calloc
int(* ResizeWindowShape)(SDL_Window *window)
Definition: SDL_sysvideo.h:62
int(* SetWindowOpacity)(_THIS, SDL_Window *window, float opacity)
Definition: SDL_sysvideo.h:219
void(* SetWindowPosition)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:214
int(* GL_SwapWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:262
int(* GetWindowGammaRamp)(_THIS, SDL_Window *window, Uint16 *ramp)
Definition: SDL_sysvideo.h:232
void Cocoa_SetWindowSize(_THIS, SDL_Window *window)
void(* MinimizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:226
void Cocoa_InitKeyboard(_THIS)
int Cocoa_ResizeWindowShape(SDL_Window *window)
void Cocoa_StopTextInput(_THIS)
VideoBootStrap COCOA_bootstrap
uint16_t Uint16
Definition: SDL_stdinc.h:169
SDL_bool(* HasClipboardText)(_THIS)
Definition: SDL_sysvideo.h:299
SDL_ShapeDriver shape_driver
Definition: SDL_sysvideo.h:244
int(* VideoInit)(_THIS)
Definition: SDL_sysvideo.h:160
int(* CreateSDLWindowFrom)(_THIS, SDL_Window *window, const void *data)
Definition: SDL_sysvideo.h:211
void(* SetWindowFullscreen)(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
Definition: SDL_sysvideo.h:230
void Cocoa_HideWindow(_THIS, SDL_Window *window)
int Cocoa_GetDisplayBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
void(* GL_DeleteContext)(_THIS, SDL_GLContext context)
Definition: SDL_sysvideo.h:263
void Cocoa_SetWindowGrab(_THIS, SDL_Window *window, SDL_bool grabbed)
char *(* GetClipboardText)(_THIS)
Definition: SDL_sysvideo.h:298
void(* SetWindowTitle)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:212
void(* SetWindowResizable)(_THIS, SDL_Window *window, SDL_bool resizable)
Definition: SDL_sysvideo.h:229
int(* GetDisplayUsableBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Definition: SDL_sysvideo.h:191
int(* GL_GetSwapInterval)(_THIS)
Definition: SDL_sysvideo.h:261
void(* MaximizeWindow)(_THIS, SDL_Window *window)
Definition: SDL_sysvideo.h:225
int(* SetClipboardText)(_THIS, const char *text)
Definition: SDL_sysvideo.h:297
void Cocoa_QuitModes(_THIS)
int(* SetWindowGammaRamp)(_THIS, SDL_Window *window, const Uint16 *ramp)
Definition: SDL_sysvideo.h:231
void(* SuspendScreenSaver)(_THIS)
Definition: SDL_sysvideo.h:283
void Cocoa_InitModes(_THIS)
void(* SetWindowGrab)(_THIS, SDL_Window *window, SDL_bool grabbed)
Definition: SDL_sysvideo.h:233
void *(* GL_GetProcAddress)(_THIS, const char *proc)
Definition: SDL_sysvideo.h:255
void Cocoa_MaximizeWindow(_THIS, SDL_Window *window)
void(* PumpEvents)(_THIS)
Definition: SDL_sysvideo.h:280
int Cocoa_SetWindowHitTest(SDL_Window *window, SDL_bool enabled)
void Cocoa_SetWindowMinimumSize(_THIS, SDL_Window *window)