SDL  2.0
SDL_cocoavideo.m
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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_cocoametalview.h"
31 #include "SDL_assert.h"
32 
33 /* Initialization/Query functions */
34 static int Cocoa_VideoInit(_THIS);
35 static void Cocoa_VideoQuit(_THIS);
36 
37 /* Cocoa driver bootstrap functions */
38 
39 static int
40 Cocoa_Available(void)
41 {
42  return (1);
43 }
44 
45 static void
46 Cocoa_DeleteDevice(SDL_VideoDevice * device)
47 {
48  SDL_free(device->driverdata);
50 }
51 
52 static SDL_VideoDevice *
53 Cocoa_CreateDevice(int devindex)
54 {
57 
59 
60  /* Initialize all variables that we clean on shutdown */
62  if (device) {
63  data = (struct SDL_VideoData *) SDL_calloc(1, sizeof(SDL_VideoData));
64  } else {
65  data = NULL;
66  }
67  if (!data) {
70  return NULL;
71  }
72  device->driverdata = data;
73 
74  /* Set the function pointers */
75  device->VideoInit = Cocoa_VideoInit;
76  device->VideoQuit = Cocoa_VideoQuit;
77  device->GetDisplayBounds = Cocoa_GetDisplayBounds;
78  device->GetDisplayUsableBounds = Cocoa_GetDisplayUsableBounds;
79  device->GetDisplayDPI = Cocoa_GetDisplayDPI;
80  device->GetDisplayModes = Cocoa_GetDisplayModes;
81  device->SetDisplayMode = Cocoa_SetDisplayMode;
82  device->PumpEvents = Cocoa_PumpEvents;
83  device->SuspendScreenSaver = Cocoa_SuspendScreenSaver;
84 
85  device->CreateSDLWindow = Cocoa_CreateWindow;
86  device->CreateSDLWindowFrom = Cocoa_CreateWindowFrom;
87  device->SetWindowTitle = Cocoa_SetWindowTitle;
88  device->SetWindowIcon = Cocoa_SetWindowIcon;
89  device->SetWindowPosition = Cocoa_SetWindowPosition;
90  device->SetWindowSize = Cocoa_SetWindowSize;
91  device->SetWindowMinimumSize = Cocoa_SetWindowMinimumSize;
92  device->SetWindowMaximumSize = Cocoa_SetWindowMaximumSize;
93  device->SetWindowOpacity = Cocoa_SetWindowOpacity;
94  device->ShowWindow = Cocoa_ShowWindow;
95  device->HideWindow = Cocoa_HideWindow;
96  device->RaiseWindow = Cocoa_RaiseWindow;
97  device->MaximizeWindow = Cocoa_MaximizeWindow;
98  device->MinimizeWindow = Cocoa_MinimizeWindow;
99  device->RestoreWindow = Cocoa_RestoreWindow;
100  device->SetWindowBordered = Cocoa_SetWindowBordered;
101  device->SetWindowResizable = Cocoa_SetWindowResizable;
102  device->SetWindowFullscreen = Cocoa_SetWindowFullscreen;
103  device->SetWindowGammaRamp = Cocoa_SetWindowGammaRamp;
104  device->GetWindowGammaRamp = Cocoa_GetWindowGammaRamp;
105  device->SetWindowGrab = Cocoa_SetWindowGrab;
106  device->DestroyWindow = Cocoa_DestroyWindow;
107  device->GetWindowWMInfo = Cocoa_GetWindowWMInfo;
108  device->SetWindowHitTest = Cocoa_SetWindowHitTest;
109  device->AcceptDragAndDrop = Cocoa_AcceptDragAndDrop;
110 
111  device->shape_driver.CreateShaper = Cocoa_CreateShaper;
112  device->shape_driver.SetWindowShape = Cocoa_SetWindowShape;
113  device->shape_driver.ResizeWindowShape = Cocoa_ResizeWindowShape;
114 
115 #if SDL_VIDEO_OPENGL_CGL
116  device->GL_LoadLibrary = Cocoa_GL_LoadLibrary;
117  device->GL_GetProcAddress = Cocoa_GL_GetProcAddress;
118  device->GL_UnloadLibrary = Cocoa_GL_UnloadLibrary;
119  device->GL_CreateContext = Cocoa_GL_CreateContext;
120  device->GL_MakeCurrent = Cocoa_GL_MakeCurrent;
121  device->GL_GetDrawableSize = Cocoa_GL_GetDrawableSize;
122  device->GL_SetSwapInterval = Cocoa_GL_SetSwapInterval;
123  device->GL_GetSwapInterval = Cocoa_GL_GetSwapInterval;
124  device->GL_SwapWindow = Cocoa_GL_SwapWindow;
125  device->GL_DeleteContext = Cocoa_GL_DeleteContext;
126 #elif SDL_VIDEO_OPENGL_EGL
127  device->GL_LoadLibrary = Cocoa_GLES_LoadLibrary;
128  device->GL_GetProcAddress = Cocoa_GLES_GetProcAddress;
129  device->GL_UnloadLibrary = Cocoa_GLES_UnloadLibrary;
130  device->GL_CreateContext = Cocoa_GLES_CreateContext;
131  device->GL_MakeCurrent = Cocoa_GLES_MakeCurrent;
132  device->GL_SetSwapInterval = Cocoa_GLES_SetSwapInterval;
133  device->GL_GetSwapInterval = Cocoa_GLES_GetSwapInterval;
134  device->GL_SwapWindow = Cocoa_GLES_SwapWindow;
135  device->GL_DeleteContext = Cocoa_GLES_DeleteContext;
136 #endif
137 
138 #if SDL_VIDEO_VULKAN
139  device->Vulkan_LoadLibrary = Cocoa_Vulkan_LoadLibrary;
140  device->Vulkan_UnloadLibrary = Cocoa_Vulkan_UnloadLibrary;
141  device->Vulkan_GetInstanceExtensions = Cocoa_Vulkan_GetInstanceExtensions;
142  device->Vulkan_CreateSurface = Cocoa_Vulkan_CreateSurface;
143  device->Vulkan_GetDrawableSize = Cocoa_Vulkan_GetDrawableSize;
144 #endif
145 
146 #if SDL_VIDEO_METAL
147  device->Metal_CreateView = Cocoa_Metal_CreateView;
148  device->Metal_DestroyView = Cocoa_Metal_DestroyView;
149 #endif
150 
151  device->StartTextInput = Cocoa_StartTextInput;
152  device->StopTextInput = Cocoa_StopTextInput;
153  device->SetTextInputRect = Cocoa_SetTextInputRect;
154 
155  device->SetClipboardText = Cocoa_SetClipboardText;
156  device->GetClipboardText = Cocoa_GetClipboardText;
157  device->HasClipboardText = Cocoa_HasClipboardText;
158 
159  device->free = Cocoa_DeleteDevice;
160 
161  return device;
162 }
163 
165  "cocoa", "SDL Cocoa video driver",
166  Cocoa_Available, Cocoa_CreateDevice
167 };
168 
169 
170 int
171 Cocoa_VideoInit(_THIS)
172 {
174 
177  if (Cocoa_InitMouse(_this) < 0) {
178  return -1;
179  }
180 
181  data->allow_spaces = ((floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6) && SDL_GetHintBoolean(SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES, SDL_TRUE));
182 
183  /* The IOPM assertion API can disable the screensaver as of 10.7. */
184  data->screensaver_use_iopm = floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6;
185 
186  data->swaplock = SDL_CreateMutex();
187  if (!data->swaplock) {
188  return -1;
189  }
190 
191  return 0;
192 }
193 
194 void
195 Cocoa_VideoQuit(_THIS)
196 {
201  SDL_DestroyMutex(data->swaplock);
202  data->swaplock = NULL;
203 }
204 
205 /* This function assumes that it's called from within an autorelease pool */
206 NSImage *
208 {
209  SDL_Surface *converted;
210  NSBitmapImageRep *imgrep;
211  Uint8 *pixels;
212  int i;
213  NSImage *img;
214 
216  if (!converted) {
217  return nil;
218  }
219 
220  imgrep = [[[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
221  pixelsWide: converted->w
222  pixelsHigh: converted->h
223  bitsPerSample: 8
224  samplesPerPixel: 4
225  hasAlpha: YES
226  isPlanar: NO
227  colorSpaceName: NSDeviceRGBColorSpace
228  bytesPerRow: converted->pitch
229  bitsPerPixel: converted->format->BitsPerPixel] autorelease];
230  if (imgrep == nil) {
231  SDL_FreeSurface(converted);
232  return nil;
233  }
234 
235  /* Copy the pixels */
236  pixels = [imgrep bitmapData];
237  SDL_memcpy(pixels, converted->pixels, converted->h * converted->pitch);
238  SDL_FreeSurface(converted);
239 
240  /* Premultiply the alpha channel */
241  for (i = (surface->h * surface->w); i--; ) {
242  Uint8 alpha = pixels[3];
243  pixels[0] = (Uint8)(((Uint16)pixels[0] * alpha) / 255);
244  pixels[1] = (Uint8)(((Uint16)pixels[1] * alpha) / 255);
245  pixels[2] = (Uint8)(((Uint16)pixels[2] * alpha) / 255);
246  pixels += 4;
247  }
248 
249  img = [[[NSImage alloc] initWithSize: NSMakeSize(surface->w, surface->h)] autorelease];
250  if (img != nil) {
251  [img addRepresentation: imgrep];
252  }
253  return img;
254 }
255 
256 /*
257  * Mac OS X log support.
258  *
259  * This doesn't really have aything to do with the interfaces of the SDL video
260  * subsystem, but we need to stuff this into an Objective-C source code file.
261  *
262  * NOTE: This is copypasted in src/video/uikit/SDL_uikitvideo.m! Be sure both
263  * versions remain identical!
264  */
265 
266 void SDL_NSLog(const char *text)
267 {
268  NSLog(@"%s", text);
269 }
270 
271 #endif /* SDL_VIDEO_DRIVER_COCOA */
272 
273 /* vim: set ts=4 sw=4 expandtab: */
SDL.h
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179
Cocoa_CreateShaper
SDL_WindowShaper * Cocoa_CreateShaper(SDL_Window *window)
Cocoa_StartTextInput
void Cocoa_StartTextInput(_THIS)
Cocoa_SuspendScreenSaver
void Cocoa_SuspendScreenSaver(_THIS)
SDL_VideoDevice::driverdata
void * driverdata
Definition: SDL_sysvideo.h:389
Uint16
uint16_t Uint16
Definition: SDL_stdinc.h:191
SDL_Surface
A collection of pixels used in software blitting.
Definition: SDL_surface.h:71
SDL_ConvertSurfaceFormat
#define SDL_ConvertSurfaceFormat
Definition: SDL_dynapi_overrides.h:464
Cocoa_SetWindowTitle
void Cocoa_SetWindowTitle(_THIS, SDL_Window *window)
Cocoa_InitMouse
int Cocoa_InitMouse(_THIS)
NULL
#define NULL
Definition: begin_code.h:167
surface
EGLSurface surface
Definition: eglext.h:248
SDL_Surface::pixels
void * pixels
Definition: SDL_surface.h:76
Cocoa_SetClipboardText
int Cocoa_SetClipboardText(_THIS, const char *text)
Cocoa_SetWindowIcon
void Cocoa_SetWindowIcon(_THIS, SDL_Window *window, SDL_Surface *icon)
Cocoa_MaximizeWindow
void Cocoa_MaximizeWindow(_THIS, SDL_Window *window)
Cocoa_GetDisplayDPI
int Cocoa_GetDisplayDPI(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hpdi, float *vdpi)
Cocoa_SetWindowPosition
void Cocoa_SetWindowPosition(_THIS, SDL_Window *window)
Cocoa_CreateImage
NSImage * Cocoa_CreateImage(SDL_Surface *surface)
SDL_CreateMutex
#define SDL_CreateMutex
Definition: SDL_dynapi_overrides.h:259
Cocoa_StopTextInput
void Cocoa_StopTextInput(_THIS)
COCOA_bootstrap
VideoBootStrap COCOA_bootstrap
Cocoa_CreateWindow
int Cocoa_CreateWindow(_THIS, SDL_Window *window)
SDL_endian.h
Cocoa_RestoreWindow
void Cocoa_RestoreWindow(_THIS, SDL_Window *window)
Cocoa_SetWindowGammaRamp
int Cocoa_SetWindowGammaRamp(_THIS, SDL_Window *window, const Uint16 *ramp)
SDL_cocoavideo.h
Cocoa_GetDisplayBounds
int Cocoa_GetDisplayBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Cocoa_GetClipboardText
char * Cocoa_GetClipboardText(_THIS)
data
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
Cocoa_QuitMouse
void Cocoa_QuitMouse(_THIS)
Cocoa_MinimizeWindow
void Cocoa_MinimizeWindow(_THIS, SDL_Window *window)
SDL_cocoavulkan.h
Cocoa_AcceptDragAndDrop
void Cocoa_AcceptDragAndDrop(SDL_Window *window, SDL_bool accept)
Cocoa_SetWindowMaximumSize
void Cocoa_SetWindowMaximumSize(_THIS, SDL_Window *window)
alpha
GLfloat GLfloat GLfloat alpha
Definition: SDL_opengl_glext.h:415
SDL_Surface::pitch
int pitch
Definition: SDL_surface.h:75
Cocoa_InitKeyboard
void Cocoa_InitKeyboard(_THIS)
SDL_memcpy
#define SDL_memcpy
Definition: SDL_dynapi_overrides.h:387
SDL_GetHintBoolean
#define SDL_GetHintBoolean
Definition: SDL_dynapi_overrides.h:608
_this
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
Cocoa_GetDisplayUsableBounds
int Cocoa_GetDisplayUsableBounds(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect)
Cocoa_SetDisplayMode
int Cocoa_SetDisplayMode(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode)
SDL_free
#define SDL_free
Definition: SDL_dynapi_overrides.h:377
Cocoa_SetWindowSize
void Cocoa_SetWindowSize(_THIS, SDL_Window *window)
Cocoa_RaiseWindow
void Cocoa_RaiseWindow(_THIS, SDL_Window *window)
Cocoa_ResizeWindowShape
int Cocoa_ResizeWindowShape(SDL_Window *window)
Cocoa_CreateWindowFrom
int Cocoa_CreateWindowFrom(_THIS, SDL_Window *window, const void *data)
SDL_FreeSurface
#define SDL_FreeSurface
Definition: SDL_dynapi_overrides.h:446
Cocoa_GetDisplayModes
void Cocoa_GetDisplayModes(_THIS, SDL_VideoDisplay *display)
SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES
#define SDL_HINT_VIDEO_MAC_FULLSCREEN_SPACES
A variable that dictates policy for fullscreen Spaces on Mac OS X.
Definition: SDL_hints.h:897
SDL_assert.h
Cocoa_SetWindowFullscreen
void Cocoa_SetWindowFullscreen(_THIS, SDL_Window *window, SDL_VideoDisplay *display, SDL_bool fullscreen)
Cocoa_HideWindow
void Cocoa_HideWindow(_THIS, SDL_Window *window)
Cocoa_QuitModes
void Cocoa_QuitModes(_THIS)
_THIS
#define _THIS
Definition: SDL_alsa_audio.h:31
text
static char text[MAX_TEXT_LENGTH]
Definition: testime.c:47
Cocoa_QuitKeyboard
void Cocoa_QuitKeyboard(_THIS)
Cocoa_DestroyWindow
void Cocoa_DestroyWindow(_THIS, SDL_Window *window)
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
pixels
GLint GLint GLsizei GLsizei GLsizei GLint GLenum GLenum const GLvoid * pixels
Definition: SDL_opengl.h:1572
SDL_VideoDevice
Definition: SDL_sysvideo.h:150
SDL_OutOfMemory
#define SDL_OutOfMemory()
Definition: SDL_error.h:52
Cocoa_SetWindowBordered
void Cocoa_SetWindowBordered(_THIS, SDL_Window *window, SDL_bool bordered)
Cocoa_SetWindowGrab
void Cocoa_SetWindowGrab(_THIS, SDL_Window *window, SDL_bool grabbed)
SDL_Surface::h
int h
Definition: SDL_surface.h:74
SDL_calloc
#define SDL_calloc
Definition: SDL_dynapi_overrides.h:375
Cocoa_RegisterApp
void Cocoa_RegisterApp(void)
Cocoa_SetWindowMinimumSize
void Cocoa_SetWindowMinimumSize(_THIS, SDL_Window *window)
Cocoa_SetWindowShape
int Cocoa_SetWindowShape(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode)
Cocoa_SetTextInputRect
void Cocoa_SetTextInputRect(_THIS, SDL_Rect *rect)
SDL_cocoametalview.h
Cocoa_PumpEvents
void Cocoa_PumpEvents(_THIS)
SDL_DestroyMutex
#define SDL_DestroyMutex
Definition: SDL_dynapi_overrides.h:263
Cocoa_SetWindowOpacity
int Cocoa_SetWindowOpacity(_THIS, SDL_Window *window, float opacity)
Cocoa_GetWindowGammaRamp
int Cocoa_GetWindowGammaRamp(_THIS, SDL_Window *window, Uint16 *ramp)
SDL_PIXELFORMAT_RGBA32
@ SDL_PIXELFORMAT_RGBA32
Definition: SDL_pixels.h:274
Cocoa_SetWindowHitTest
int Cocoa_SetWindowHitTest(SDL_Window *window, SDL_bool enabled)
Cocoa_HasClipboardText
SDL_bool Cocoa_HasClipboardText(_THIS)
Cocoa_InitModes
void Cocoa_InitModes(_THIS)
SDL_cocoashape.h
VideoBootStrap
Definition: SDL_sysvideo.h:406
device
static SDL_AudioDeviceID device
Definition: loopwave.c:37
floor
double floor(double x)
Definition: s_floor.c:33
Cocoa_GetWindowWMInfo
SDL_bool Cocoa_GetWindowWMInfo(_THIS, SDL_Window *window, struct SDL_SysWMinfo *info)
i
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
img
GLint GLvoid * img
Definition: SDL_opengl.h:1980
Cocoa_ShowWindow
void Cocoa_ShowWindow(_THIS, SDL_Window *window)
SDL_VideoData
Definition: SDL_androidvideo.h:37
Cocoa_SetWindowResizable
void Cocoa_SetWindowResizable(_THIS, SDL_Window *window, SDL_bool resizable)