src/video/cocoa/cocoa_v.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file cocoa_v.h The Cocoa video driver. */
  11
  12 #ifndef VIDEO_COCOA_H
  13 #define VIDEO_COCOA_H
  14
  15 #include "../video_driver.hpp"
  16
  17 class VideoDriver_Cocoa : public VideoDriver {
  18 public:
  19         /* virtual */ const char *Start(const char * const *param);
  20
  21         /** Stop the video driver */
  22         /* virtual */ void Stop();
  23
  24         /** Mark dirty a screen region
  25          * @param left x-coordinate of left border
  26          * @param top  y-coordinate of top border
  27          * @param width width or dirty rectangle
  28          * @param height height of dirty rectangle
  29          */
  30         /* virtual */ void MakeDirty(int left, int top, int width, int height);
  31
  32         /** Programme main loop */
  33         /* virtual */ void MainLoop();
  34
  35         /** Change window resolution
  36          * @param w New window width
  37          * @param h New window height
  38          * @return Whether change was successful
  39          */
  40         /* virtual */ bool ChangeResolution(int w, int h);
  41
  42         /** Set a new window mode
  43          * @param fullscreen Whether to set fullscreen mode or not
  44          * @return Whether changing the screen mode was successful
  45          */
  46         /* virtual */ bool ToggleFullscreen(bool fullscreen);
  47
  48         /** Callback invoked after the blitter was changed.
  49          * @return True if no error.
  50          */
  51         /* virtual */ bool AfterBlitterChange();
  52
  53         /**
  54          * An edit box lost the input focus. Abort character compositing if necessary.
  55          */
  56         /* virtual */ void EditBoxLostFocus();
  57
  58         /** Return driver name
  59          * @return driver name
  60          */
  61         /* virtual */ const char *GetName() const { return "cocoa"; }
  62 };
  63
  64 class FVideoDriver_Cocoa : public DriverFactoryBase {
  65 public:
  66         FVideoDriver_Cocoa() : DriverFactoryBase(Driver::DT_VIDEO, 10, "cocoa", "Cocoa Video Driver") {}
  67         /* virtual */ Driver *CreateInstance() const { return new VideoDriver_Cocoa(); }
  68 };
  69
  70
  71 /**
  72  * Generic display driver for cocoa
  73  * On grounds to not duplicate some code, it contains a few variables
  74  * which are not used by all device drivers.
  75  */
  76 class CocoaSubdriver {
  77 public:
  78         int device_width;     ///< Width of device in pixel
  79         int device_height;    ///< Height of device in pixel
  80         int device_depth;     ///< Colour depth of device in bit
  81
  82         int window_width;     ///< Current window width in pixel
  83         int window_height;    ///< Current window height in pixel
  84         int window_pitch;
  85
  86         int buffer_depth;     ///< Colour depth of used frame buffer
  87         void *pixel_buffer;   ///< used for direct pixel access
  88         void *window_buffer;  ///< Colour translation from palette to screen
  89         id window;            ///< Pointer to window object
  90
  91 #       define MAX_DIRTY_RECTS 100
  92         Rect dirty_rects[MAX_DIRTY_RECTS]; ///< dirty rectangles
  93         int num_dirty_rects;  ///< Number of dirty rectangles
  94         uint32 palette[256];  ///< Colour Palette
  95
  96         bool active;          ///< Whether the window is visible
  97         bool setup;
  98
  99         id cocoaview;         ///< Pointer to view object
 100
 101         /* Separate driver vars for Quarz
 102          * Needed here in order to avoid much code duplication */
 103         CGContextRef cgcontext;    ///< Context reference for Quartz subdriver
 104
 105         /* Driver methods */
 106         /** Initialize driver */
 107         virtual ~CocoaSubdriver() {}
 108
 109         /** Draw window
 110          * @param force_update Whether to redraw unconditionally
 111          */
 112         virtual void Draw(bool force_update = false) = 0;
 113
 114         /** Mark dirty a screen region
 115          * @param left x-coordinate of left border
 116          * @param top  y-coordinate of top border
 117          * @param width width or dirty rectangle
 118          * @param height height of dirty rectangle
 119          */
 120         virtual void MakeDirty(int left, int top, int width, int height) = 0;
 121
 122         /** Update the palette */
 123         virtual void UpdatePalette(uint first_color, uint num_colors) = 0;
 124
 125         virtual uint ListModes(OTTD_Point *modes, uint max_modes) = 0;
 126
 127         /** Change window resolution
 128          * @param w New window width
 129          * @param h New window height
 130          * @return Whether change was successful
 131          */
 132         virtual bool ChangeResolution(int w, int h, int bpp) = 0;
 133
 134         /** Are we in fullscreen mode
 135          * @return whether fullscreen mode is currently used
 136          */
 137         virtual bool IsFullscreen() = 0;
 138
 139         /** Toggle between fullscreen and windowed mode
 140          * @return whether switch was successful
 141          */
 142         virtual bool ToggleFullscreen() { return false; };
 143
 144         /** Return the width of the current view
 145          * @return width of the current view
 146          */
 147         virtual int GetWidth() = 0;
 148
 149         /** Return the height of the current view
 150          * @return height of the current view
 151          */
 152         virtual int GetHeight() = 0;
 153
 154         /** Return the current pixel buffer
 155          * @return pixelbuffer
 156          */
 157         virtual void *GetPixelBuffer() = 0;
 158
 159         /** Convert local coordinate to window server (CoreGraphics) coordinate
 160          * @param p local coordinates
 161          * @return window driver coordinates
 162          */
 163         virtual CGPoint PrivateLocalToCG(NSPoint *p) = 0;
 164
 165         /** Return the mouse location
 166          * @param event UI event
 167          * @return mouse location as NSPoint
 168          */
 169         virtual NSPoint GetMouseLocation(NSEvent *event) = 0;
 170
 171         /** Return whether the mouse is within our view
 172          * @param pt Mouse coordinates
 173          * @return Whether mouse coordinates are within view
 174          */
 175         virtual bool MouseIsInsideView(NSPoint *pt) = 0;
 176
 177         /** Return whether the window is active (visible)
 178          * @return whether the window is visible or not
 179          */
 180         virtual bool IsActive() = 0;
 181
 182         /** Makes the *game region* of the window 100% opaque. */
 183         virtual void SetPortAlphaOpaque() { return; };
 184
 185         /** Whether the window was successfully resized
 186          * @return whether the window was successfully resized
 187          */
 188         virtual bool WindowResized() { return false; };
 189 };
 190
 191 extern CocoaSubdriver *_cocoa_subdriver;
 192
 193 CocoaSubdriver *QZ_CreateFullscreenSubdriver(int width, int height, int bpp);
 194
 195 #ifdef ENABLE_COCOA_QUICKDRAW
 196 CocoaSubdriver *QZ_CreateWindowQuickdrawSubdriver(int width, int height, int bpp);
 197 #endif
 198
 199 #ifdef ENABLE_COCOA_QUARTZ
 200 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
 201 CocoaSubdriver *QZ_CreateWindowQuartzSubdriver(int width, int height, int bpp);
 202 #endif
 203 #endif
 204
 205 void QZ_GameSizeChanged();
 206
 207 void QZ_GameLoop();
 208
 209 uint QZ_ListModes(OTTD_Point *modes, uint max_modes, CGDirectDisplayID display_id, int display_depth);
 210
 211 /** Category of NSCursor to allow cursor showing/hiding */
 212 @interface NSCursor (OTTD_QuickdrawCursor)
 213 + (NSCursor *) clearCocoaCursor;
 214 @end
 215
 216 /** Subclass of NSWindow to cater our special needs */
 217 @interface OTTD_CocoaWindow : NSWindow {
 218         CocoaSubdriver *driver;
 219 }
 220
 221 - (void)setDriver:(CocoaSubdriver*)drv;
 222
 223 - (void)miniaturize:(id)sender;
 224 - (void)display;
 225 - (void)setFrame:(NSRect)frameRect display:(BOOL)flag;
 226 - (void)appDidHide:(NSNotification*)note;
 227 - (void)appWillUnhide:(NSNotification*)note;
 228 - (void)appDidUnhide:(NSNotification*)note;
 229 - (id)initWithContentRect:(NSRect)contentRect styleMask:(NSUInteger)styleMask backing:(NSBackingStoreType)backingType defer:(BOOL)flag;
 230 @end
 231
 232 /** Subclass of NSView to fix Quartz rendering and mouse awareness */
 233 @interface OTTD_CocoaView : NSView
 234 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
 235 #       if MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4
 236                 <NSTextInputClient, NSTextInput>
 237 #       else
 238                 <NSTextInputClient>
 239 #       endif /* MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4 */
 240 #else
 241         <NSTextInput>
 242 #endif /* MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5 */
 243 {
 244         CocoaSubdriver *driver;
 245         NSTrackingRectTag trackingtag;
 246 }
 247 - (void)setDriver:(CocoaSubdriver*)drv;
 248 - (void)drawRect:(NSRect)rect;
 249 - (BOOL)isOpaque;
 250 - (BOOL)acceptsFirstResponder;
 251 - (BOOL)becomeFirstResponder;
 252 - (void)setTrackingRect;
 253 - (void)clearTrackingRect;
 254 - (void)resetCursorRects;
 255 - (void)viewWillMoveToWindow:(NSWindow *)win;
 256 - (void)viewDidMoveToWindow;
 257 - (void)mouseEntered:(NSEvent *)theEvent;
 258 - (void)mouseExited:(NSEvent *)theEvent;
 259 @end
 260
 261 /** Delegate for our NSWindow to send ask for quit on close */
 262 @interface OTTD_CocoaWindowDelegate : NSObject {
 263         CocoaSubdriver *driver;
 264 }
 265
 266 - (void)setDriver:(CocoaSubdriver*)drv;
 267
 268 - (BOOL)windowShouldClose:(id)sender;
 269 - (void)windowDidEnterFullScreen:(NSNotification *)aNotification;
 270 @end
 271
 272
 273 #endif /* VIDEO_COCOA_H */