src/video/cocoa/SDL_cocoawindow.h
author Alex Szpakowski <slime73@gmail.com>
Sat, 13 Jul 2019 17:04:02 -0300
changeset 12940 1e6980ce45c0
parent 12503 806492103856
permissions -rw-r--r--
macOS: Fix SDL_GL_CreateContext/MakeCurrent on non-main threads causing a Main Thread Checker warning when built with Xcode 11 / the macOS 10.15 SDK.

Fixes bug #4714.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 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 #ifndef SDL_cocoawindow_h_
    24 #define SDL_cocoawindow_h_
    25 
    26 #import <Cocoa/Cocoa.h>
    27 
    28 #if SDL_VIDEO_OPENGL_EGL
    29 #include "../SDL_egl_c.h"
    30 #endif
    31 
    32 typedef struct SDL_WindowData SDL_WindowData;
    33 
    34 typedef enum
    35 {
    36     PENDING_OPERATION_NONE,
    37     PENDING_OPERATION_ENTER_FULLSCREEN,
    38     PENDING_OPERATION_LEAVE_FULLSCREEN,
    39     PENDING_OPERATION_MINIMIZE
    40 } PendingWindowOperation;
    41 
    42 @interface Cocoa_WindowListener : NSResponder <NSWindowDelegate> {
    43     SDL_WindowData *_data;
    44     BOOL observingVisible;
    45     BOOL wasCtrlLeft;
    46     BOOL wasVisible;
    47     BOOL isFullscreenSpace;
    48     BOOL inFullscreenTransition;
    49     PendingWindowOperation pendingWindowOperation;
    50     BOOL isMoving;
    51     int pendingWindowWarpX, pendingWindowWarpY;
    52     BOOL isDragAreaRunning;
    53 }
    54 
    55 -(void) listen:(SDL_WindowData *) data;
    56 -(void) pauseVisibleObservation;
    57 -(void) resumeVisibleObservation;
    58 -(BOOL) setFullscreenSpace:(BOOL) state;
    59 -(BOOL) isInFullscreenSpace;
    60 -(BOOL) isInFullscreenSpaceTransition;
    61 -(void) addPendingWindowOperation:(PendingWindowOperation) operation;
    62 -(void) close;
    63 
    64 -(BOOL) isMoving;
    65 -(void) setPendingMoveX:(int)x Y:(int)y;
    66 -(void) windowDidFinishMoving;
    67 
    68 /* Window delegate functionality */
    69 -(BOOL) windowShouldClose:(id) sender;
    70 -(void) windowDidExpose:(NSNotification *) aNotification;
    71 -(void) windowDidMove:(NSNotification *) aNotification;
    72 -(void) windowDidResize:(NSNotification *) aNotification;
    73 -(void) windowDidMiniaturize:(NSNotification *) aNotification;
    74 -(void) windowDidDeminiaturize:(NSNotification *) aNotification;
    75 -(void) windowDidBecomeKey:(NSNotification *) aNotification;
    76 -(void) windowDidResignKey:(NSNotification *) aNotification;
    77 -(void) windowDidChangeBackingProperties:(NSNotification *) aNotification;
    78 -(void) windowWillEnterFullScreen:(NSNotification *) aNotification;
    79 -(void) windowDidEnterFullScreen:(NSNotification *) aNotification;
    80 -(void) windowWillExitFullScreen:(NSNotification *) aNotification;
    81 -(void) windowDidExitFullScreen:(NSNotification *) aNotification;
    82 -(NSApplicationPresentationOptions)window:(NSWindow *)window willUseFullScreenPresentationOptions:(NSApplicationPresentationOptions)proposedOptions;
    83 
    84 /* See if event is in a drag area, toggle on window dragging. */
    85 -(BOOL) processHitTest:(NSEvent *)theEvent;
    86 
    87 /* Window event handling */
    88 -(void) mouseDown:(NSEvent *) theEvent;
    89 -(void) rightMouseDown:(NSEvent *) theEvent;
    90 -(void) otherMouseDown:(NSEvent *) theEvent;
    91 -(void) mouseUp:(NSEvent *) theEvent;
    92 -(void) rightMouseUp:(NSEvent *) theEvent;
    93 -(void) otherMouseUp:(NSEvent *) theEvent;
    94 -(void) mouseMoved:(NSEvent *) theEvent;
    95 -(void) mouseDragged:(NSEvent *) theEvent;
    96 -(void) rightMouseDragged:(NSEvent *) theEvent;
    97 -(void) otherMouseDragged:(NSEvent *) theEvent;
    98 -(void) scrollWheel:(NSEvent *) theEvent;
    99 -(void) touchesBeganWithEvent:(NSEvent *) theEvent;
   100 -(void) touchesMovedWithEvent:(NSEvent *) theEvent;
   101 -(void) touchesEndedWithEvent:(NSEvent *) theEvent;
   102 -(void) touchesCancelledWithEvent:(NSEvent *) theEvent;
   103 
   104 /* Touch event handling */
   105 -(void) handleTouches:(NSTouchPhase) phase withEvent:(NSEvent*) theEvent;
   106 
   107 @end
   108 /* *INDENT-ON* */
   109 
   110 @class SDLOpenGLContext;
   111 
   112 struct SDL_WindowData
   113 {
   114     SDL_Window *window;
   115     NSWindow *nswindow;
   116     NSView *sdlContentView; /* nil if window is created via CreateWindowFrom */
   117     NSMutableArray *nscontexts;
   118     SDL_bool created;
   119     SDL_bool inWindowMove;
   120     Cocoa_WindowListener *listener;
   121     struct SDL_VideoData *videodata;
   122 #if SDL_VIDEO_OPENGL_EGL
   123     EGLSurface egl_surface;
   124 #endif
   125 };
   126 
   127 extern int Cocoa_CreateWindow(_THIS, SDL_Window * window);
   128 extern int Cocoa_CreateWindowFrom(_THIS, SDL_Window * window,
   129                                   const void *data);
   130 extern void Cocoa_SetWindowTitle(_THIS, SDL_Window * window);
   131 extern void Cocoa_SetWindowIcon(_THIS, SDL_Window * window, SDL_Surface * icon);
   132 extern void Cocoa_SetWindowPosition(_THIS, SDL_Window * window);
   133 extern void Cocoa_SetWindowSize(_THIS, SDL_Window * window);
   134 extern void Cocoa_SetWindowMinimumSize(_THIS, SDL_Window * window);
   135 extern void Cocoa_SetWindowMaximumSize(_THIS, SDL_Window * window);
   136 extern int Cocoa_SetWindowOpacity(_THIS, SDL_Window * window, float opacity);
   137 extern void Cocoa_ShowWindow(_THIS, SDL_Window * window);
   138 extern void Cocoa_HideWindow(_THIS, SDL_Window * window);
   139 extern void Cocoa_RaiseWindow(_THIS, SDL_Window * window);
   140 extern void Cocoa_MaximizeWindow(_THIS, SDL_Window * window);
   141 extern void Cocoa_MinimizeWindow(_THIS, SDL_Window * window);
   142 extern void Cocoa_RestoreWindow(_THIS, SDL_Window * window);
   143 extern void Cocoa_SetWindowBordered(_THIS, SDL_Window * window, SDL_bool bordered);
   144 extern void Cocoa_SetWindowResizable(_THIS, SDL_Window * window, SDL_bool resizable);
   145 extern void Cocoa_SetWindowFullscreen(_THIS, SDL_Window * window, SDL_VideoDisplay * display, SDL_bool fullscreen);
   146 extern int Cocoa_SetWindowGammaRamp(_THIS, SDL_Window * window, const Uint16 * ramp);
   147 extern int Cocoa_GetWindowGammaRamp(_THIS, SDL_Window * window, Uint16 * ramp);
   148 extern void Cocoa_SetWindowGrab(_THIS, SDL_Window * window, SDL_bool grabbed);
   149 extern void Cocoa_DestroyWindow(_THIS, SDL_Window * window);
   150 extern SDL_bool Cocoa_GetWindowWMInfo(_THIS, SDL_Window * window, struct SDL_SysWMinfo *info);
   151 extern int Cocoa_SetWindowHitTest(SDL_Window *window, SDL_bool enabled);
   152 extern void Cocoa_AcceptDragAndDrop(SDL_Window * window, SDL_bool accept);
   153 
   154 #endif /* SDL_cocoawindow_h_ */
   155 
   156 /* vi: set ts=4 sw=4 expandtab: */