From http://www.jwz.org/xscreensaver/xscreensaver-5.35.tar.gz
[xscreensaver] / OSX / XScreenSaverView.h
1 /* xscreensaver, Copyright (c) 2006-2016 Jamie Zawinski <jwz@jwz.org>
2  *
3  * Permission to use, copy, modify, distribute, and sell this software and its
4  * documentation for any purpose is hereby granted without fee, provided that
5  * the above copyright notice appear in all copies and that both that
6  * copyright notice and this permission notice appear in supporting
7  * documentation.  No representations are made about the suitability of this
8  * software for any purpose.  It is provided "as is" without express or 
9  * implied warranty.
10  */
11
12 /* This is a subclass of Apple's ScreenSaverView that knows how to run
13    xscreensaver programs without X11 via the dark magic of the "jwxyz"
14    library.  In xscreensaver terminology, this is the replacement for
15    the "screenhack.c" module.
16  */
17
18 #ifdef USE_IPHONE
19 # import <Foundation/Foundation.h>
20 # import <UIKit/UIKit.h>
21 # define NSView  UIView
22 # define NSRect  CGRect
23 # define NSSize  CGSize
24 # define NSColor UIColor
25 # define NSImage UIImage
26 # define NSEvent UIEvent
27 # define NSWindow UIWindow
28 # define NSOpenGLContext EAGLContext
29 #else
30 # import <Cocoa/Cocoa.h>
31 # import <ScreenSaver/ScreenSaver.h>
32 #endif
33
34
35 #import "screenhackI.h"
36 #import "PrefsReader.h"
37
38 #ifdef USE_IPHONE
39
40 @class XScreenSaverView;
41
42 @protocol XScreenSaverViewDelegate
43 - (void) wantsFadeOut:(XScreenSaverView *)saverView;
44 - (void) didShake:(XScreenSaverView *)saverView;
45 @end
46
47 @interface ScreenSaverView : NSView
48 - (id)initWithFrame:(NSRect)frame isPreview:(BOOL)isPreview;
49 - (NSTimeInterval)animationTimeInterval;
50 - (void)setAnimationTimeInterval:(NSTimeInterval)timeInterval;
51 - (void)startAnimation;
52 - (void)stopAnimation;
53 - (BOOL)isAnimating;
54 - (void)animateOneFrame;
55 - (BOOL)hasConfigureSheet;
56 //- (NSWindow*)configureSheet;
57 - (UIViewController*)configureView;
58 - (BOOL)isPreview;
59 @end
60
61 #endif // USE_IPHONE
62
63
64 // Currently only OpenGL backbuffers are supported (OSX and iOS).
65 # define BACKBUFFER_OPENGL
66
67 @interface XScreenSaverView : ScreenSaverView
68 # ifdef USE_IPHONE
69                               <UIAlertViewDelegate>
70 # endif
71 {
72   struct xscreensaver_function_table *xsft;
73   PrefsReader *prefsReader;
74
75   BOOL setup_p;            // whether xsft->setup_cb() has been run
76   BOOL initted_p;          // whether xsft->init_cb() has been run
77   BOOL resized_p;          // whether to run the xsft->reshape_cb() soon
78   double next_frame_time;  // time_t in milliseconds of when to tick the frame
79
80   // Data used by the Xlib-flavored screensaver
81   Display *xdpy;
82   Window xwindow;
83   void *xdata;
84   fps_state *fpst;
85
86 # ifdef USE_IPHONE
87   BOOL screenLocked;
88   BOOL _ignoreRotation;         // whether hack requested "always portrait".
89                                 // some want this, some do not.
90   NSTimer *crash_timer;
91
92   NSDictionary *function_tables;
93
94   id<XScreenSaverViewDelegate> _delegate;
95
96 # else // !USE_PHONE
97
98   NSOpenGLPixelFormat *pixfmt;
99
100 # endif // !USE_IPHONE
101
102   NSOpenGLContext *ogl_ctx;      // OpenGL rendering context
103
104 # ifdef JWXYZ_QUARTZ
105   CGContextRef backbuffer;
106   CGColorSpaceRef colorspace;
107
108 #  ifdef BACKBUFFER_OPENGL
109   void *backbuffer_data;
110   size_t backbuffer_len;
111
112   GLsizei gl_texture_w, gl_texture_h;
113
114   GLuint backbuffer_texture;
115   GLenum gl_texture_target;
116   GLenum gl_pixel_format, gl_pixel_type;
117 #   ifndef USE_IPHONE
118   BOOL double_buffered_p, gl_apple_client_storage_p;
119 #   else // USE_IPHONE
120   BOOL gl_limited_npot_p;
121   GLuint gl_framebuffer, gl_renderbuffer;
122 #   endif // USE_IPHONE
123 #  endif
124
125 # endif // JWXYZ_QUARTZ
126
127 # if defined JWXYZ_GL && defined USE_IPHONE
128   NSOpenGLContext *ogl_ctx_pixmap;
129 # endif // JWXYZ_GL && USE_IPHONE
130 }
131
132 - (id)initWithFrame:(NSRect)frame saverName:(NSString*)n isPreview:(BOOL)p;
133
134 - (void) render_x11;
135 - (NSOpenGLContext *) oglContext;
136 - (void) prepareContext;
137 - (NSUserDefaultsController *) userDefaultsController;
138 + (NSString *) decompressXML:(NSData *)xml;
139
140 #ifdef USE_IPHONE
141 - (CGFloat) hackedContentScaleFactor;
142 - (void)setScreenLocked:(BOOL)locked;
143 - (NSDictionary *)getGLProperties;
144 - (void)addExtraRenderbuffers:(CGSize)size;
145 - (NSString *)getCAGravity;
146 - (void)orientationChanged;
147 @property (nonatomic, assign) id<XScreenSaverViewDelegate> delegate;
148 @property (nonatomic) BOOL ignoreRotation;
149 - (BOOL)suppressRotationAnimation;
150 - (BOOL)rotateTouches;
151 #else // !USE_IPHONE
152 - (NSOpenGLPixelFormat *)getGLPixelFormat;
153 #endif // !USE_IPHONE
154
155 - (void)enableBackbuffer:(CGSize)new_backbuffer_size;
156 - (void)setViewport;
157 - (void)createBackbuffer:(CGSize)s;
158 - (void)reshape_x11;
159 #ifdef JWXYZ_QUARTZ
160 - (void)drawBackbuffer;
161 #endif // JWXYZ_QUARTZ
162 - (void)flushBackbuffer;
163
164 @end