2016-03-05 19:45:09 +00:00
|
|
|
//
|
|
|
|
// CSOpenGLView.h
|
|
|
|
// Clock Signal
|
|
|
|
//
|
|
|
|
// Created by Thomas Harte on 16/07/2015.
|
2018-05-13 19:19:52 +00:00
|
|
|
// Copyright 2015 Thomas Harte. All rights reserved.
|
2016-03-05 19:45:09 +00:00
|
|
|
//
|
|
|
|
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <AppKit/AppKit.h>
|
|
|
|
|
|
|
|
@class CSOpenGLView;
|
|
|
|
|
2019-03-03 00:33:28 +00:00
|
|
|
typedef NS_ENUM(NSInteger, CSOpenGLViewRedrawEvent) {
|
|
|
|
/// Indicates that AppKit requested a redraw for some reason (mostly likely, the window is being resized). So,
|
|
|
|
/// if the delegate doesn't redraw the view, the user is likely to see a graphical flaw.
|
|
|
|
CSOpenGLViewRedrawEventAppKit,
|
|
|
|
/// Indicates that the view's display-linked timer has triggered a redraw request. So, if the delegate doesn't
|
|
|
|
/// redraw the view, the user will just see the previous drawing without interruption.
|
|
|
|
CSOpenGLViewRedrawEventTimer
|
|
|
|
};
|
|
|
|
|
2016-03-05 19:45:09 +00:00
|
|
|
@protocol CSOpenGLViewDelegate
|
2016-03-13 17:38:03 +00:00
|
|
|
/*!
|
|
|
|
Requests that the delegate produce an image of its current output state. May be called on
|
|
|
|
any queue or thread.
|
2017-08-17 14:48:29 +00:00
|
|
|
@param view The view making the request.
|
2019-03-03 00:33:28 +00:00
|
|
|
@param redrawEvent If @c YES then the delegate may decline to redraw if its output would be
|
2016-03-13 17:38:03 +00:00
|
|
|
identical to the previous frame. If @c NO then the delegate must draw.
|
|
|
|
*/
|
2019-03-03 00:33:28 +00:00
|
|
|
- (void)openGLViewRedraw:(nonnull CSOpenGLView *)view event:(CSOpenGLViewRedrawEvent)redrawEvent;
|
2016-03-20 02:46:17 +00:00
|
|
|
|
2017-08-17 14:48:29 +00:00
|
|
|
/*!
|
|
|
|
Announces receipt of a file by drag and drop to the delegate.
|
|
|
|
@param view The view making the request.
|
|
|
|
@param URL The file URL of the received file.
|
|
|
|
*/
|
|
|
|
- (void)openGLView:(nonnull CSOpenGLView *)view didReceiveFileAtURL:(nonnull NSURL *)URL;
|
|
|
|
|
2019-08-02 21:07:51 +00:00
|
|
|
/*!
|
|
|
|
Announces 'capture' of the mouse — i.e. that the view is now preventing the mouse from exiting
|
|
|
|
the window, in order to forward continuous mouse motion.
|
|
|
|
@param view The view making the announcement.
|
|
|
|
*/
|
|
|
|
- (void)openGLViewDidCaptureMouse:(nonnull CSOpenGLView *)view;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Announces that the mouse is no longer captured.
|
|
|
|
@param view The view making the announcement.
|
|
|
|
*/
|
|
|
|
- (void)openGLViewDidReleaseMouse:(nonnull CSOpenGLView *)view;
|
|
|
|
|
2016-03-05 19:45:09 +00:00
|
|
|
@end
|
|
|
|
|
|
|
|
@protocol CSOpenGLViewResponderDelegate <NSObject>
|
2016-03-13 17:38:03 +00:00
|
|
|
/*!
|
2018-05-13 15:12:03 +00:00
|
|
|
Supplies a keyDown event to the delegate.
|
2016-03-13 17:38:03 +00:00
|
|
|
@param event The @c NSEvent describing the keyDown.
|
|
|
|
*/
|
2016-03-05 19:45:09 +00:00
|
|
|
- (void)keyDown:(nonnull NSEvent *)event;
|
2016-03-13 17:38:03 +00:00
|
|
|
|
|
|
|
/*!
|
2018-05-13 15:12:03 +00:00
|
|
|
Supplies a keyUp event to the delegate.
|
2016-03-13 17:38:03 +00:00
|
|
|
@param event The @c NSEvent describing the keyUp.
|
|
|
|
*/
|
2016-03-05 19:45:09 +00:00
|
|
|
- (void)keyUp:(nonnull NSEvent *)event;
|
2016-03-13 17:38:03 +00:00
|
|
|
|
|
|
|
/*!
|
2018-05-13 15:12:03 +00:00
|
|
|
Supplies a flagsChanged event to the delegate.
|
2016-03-13 17:38:03 +00:00
|
|
|
@param event The @c NSEvent describing the flagsChanged.
|
|
|
|
*/
|
2017-07-22 01:27:50 +00:00
|
|
|
- (void)flagsChanged:(nonnull NSEvent *)event;
|
2016-03-13 17:38:03 +00:00
|
|
|
|
2018-05-13 15:12:03 +00:00
|
|
|
/*!
|
|
|
|
Supplies a paste event to the delegate.
|
|
|
|
*/
|
|
|
|
- (void)paste:(nonnull id)sender;
|
|
|
|
|
2019-06-11 20:30:53 +00:00
|
|
|
@optional
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Supplies a mouse moved event to the delegate. This functions only if
|
|
|
|
shouldCaptureMouse is set to YES, in which case the view will ensure it captures
|
|
|
|
the mouse and returns only relative motion
|
|
|
|
(Cf. CGAssociateMouseAndMouseCursorPosition). It will also elide mouseDragged:
|
|
|
|
(and rightMouseDragged:, etc) and mouseMoved: events.
|
|
|
|
*/
|
|
|
|
- (void)mouseMoved:(nonnull NSEvent *)event;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Supplies a mouse button down event. This elides mouseDown, rightMouseDown and otherMouseDown.
|
|
|
|
@c shouldCaptureMouse must be set to @c YES to receive these events.
|
|
|
|
*/
|
|
|
|
- (void)mouseDown:(nonnull NSEvent *)event;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Supplies a mouse button up event. This elides mouseUp, rightMouseUp and otherMouseUp.
|
|
|
|
@c shouldCaptureMouse must be set to @c YES to receive these events.
|
|
|
|
*/
|
|
|
|
- (void)mouseUp:(nonnull NSEvent *)event;
|
|
|
|
|
2016-03-05 19:45:09 +00:00
|
|
|
@end
|
|
|
|
|
2020-02-04 02:58:29 +00:00
|
|
|
/*!
|
|
|
|
Although I'm still on the fence about this as a design decision, CSOpenGLView is itself responsible
|
|
|
|
for creating and destroying a CVDisplayLink. There's a practical reason for this: you'll get real synchronisation
|
|
|
|
only if a link is explicitly tied to a particular display, and the CSOpenGLView therefore owns the knowledge
|
|
|
|
necessary to decide when to create and modify them. It doesn't currently just propagate "did change screen"-type
|
|
|
|
messages because I haven't yet found a way to track that other than polling, in which case I might as well put
|
|
|
|
that into the display link callback.
|
|
|
|
*/
|
|
|
|
@protocol CSOpenGLViewDisplayLinkDelegate
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Informs the delegate that from now on, the display link @c displayLink will be used for update notifications
|
|
|
|
and/or that the frequency or phase or @c displayLink has changed.
|
|
|
|
*/
|
|
|
|
- (void)openGLView:(nonnull CSOpenGLView *)view didUpdateDisplayLink:(nonnull CVDisplayLinkRef)displayLink;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
Informs the delegate that the display link has fired.
|
|
|
|
*/
|
2020-02-07 04:35:03 +00:00
|
|
|
- (void)openGLViewDisplayLinkDidFire:(nonnull CSOpenGLView *)view now:(nonnull const CVTimeStamp *)now outputTime:(nonnull const CVTimeStamp *)outputTime;
|
2020-02-04 02:58:29 +00:00
|
|
|
|
|
|
|
@end
|
|
|
|
|
2016-03-05 19:45:09 +00:00
|
|
|
/*!
|
2018-05-13 15:12:03 +00:00
|
|
|
Provides an OpenGL canvas with a refresh-linked update timer that can forward a subset
|
|
|
|
of typical first-responder actions.
|
2016-03-05 19:45:09 +00:00
|
|
|
*/
|
|
|
|
@interface CSOpenGLView : NSOpenGLView
|
|
|
|
|
2017-02-11 17:58:47 +00:00
|
|
|
@property (atomic, weak, nullable) id <CSOpenGLViewDelegate> delegate;
|
2016-06-23 13:37:49 +00:00
|
|
|
@property (nonatomic, weak, nullable) id <CSOpenGLViewResponderDelegate> responderDelegate;
|
2020-02-04 02:58:29 +00:00
|
|
|
@property (atomic, weak, nullable) id <CSOpenGLViewDisplayLinkDelegate> displayLinkDelegate;
|
2016-03-05 19:45:09 +00:00
|
|
|
|
2019-09-22 17:15:35 +00:00
|
|
|
/// Determines whether the view offers mouse capturing — i.e. if the user clicks on the view then
|
|
|
|
/// then the system cursor is disabled and the mouse events defined by CSOpenGLViewResponderDelegate
|
|
|
|
/// are forwarded, unless and until the user releases the mouse using the control+command shortcut.
|
2019-06-11 20:30:53 +00:00
|
|
|
@property (nonatomic, assign) BOOL shouldCaptureMouse;
|
|
|
|
|
2019-09-22 17:15:35 +00:00
|
|
|
/// Determines whether the CSOpenGLViewResponderDelegate of this window expects to use the command
|
|
|
|
/// key as though it were any other key — i.e. all command combinations should be forwarded to the delegate,
|
|
|
|
/// not being allowed to trigger regular application shortcuts such as command+q or command+h.
|
|
|
|
///
|
|
|
|
/// How the view respects this will depend on other state; if this view is one that captures the mouse then it
|
|
|
|
/// will usurp command only while the mouse is captured.
|
|
|
|
///
|
|
|
|
/// TODO: what's smart behaviour if this view doesn't capture the mouse? Probably
|
|
|
|
/// force a similar capturing behaviour?
|
|
|
|
@property (nonatomic, assign) BOOL shouldUsurpCommand;
|
|
|
|
|
2016-03-13 17:38:03 +00:00
|
|
|
/*!
|
|
|
|
Ends the timer tracking time; should be called prior to giving up the last owning reference
|
|
|
|
to ensure that any retain cycles implied by the timer are resolved.
|
|
|
|
*/
|
2016-03-05 19:45:09 +00:00
|
|
|
- (void)invalidate;
|
|
|
|
|
2016-03-13 17:38:03 +00:00
|
|
|
/// The size in pixels of the OpenGL canvas, factoring in screen pixel density and view size in points.
|
2016-03-05 19:45:09 +00:00
|
|
|
@property (nonatomic, readonly) CGSize backingSize;
|
|
|
|
|
2018-05-13 15:12:03 +00:00
|
|
|
/*!
|
|
|
|
Locks this view's OpenGL context and makes it current, performs @c action and then unlocks
|
|
|
|
the context. @c action is performed on the calling queue.
|
|
|
|
*/
|
2020-02-04 02:58:29 +00:00
|
|
|
- (void)performWithGLContext:(nonnull dispatch_block_t)action flushDrawable:(BOOL)flushDrawable;
|
2016-03-20 02:46:17 +00:00
|
|
|
- (void)performWithGLContext:(nonnull dispatch_block_t)action;
|
|
|
|
|
2019-06-11 20:30:53 +00:00
|
|
|
/*!
|
|
|
|
Instructs that the mouse cursor, if currently captured, should be released.
|
|
|
|
*/
|
|
|
|
- (void)releaseMouse;
|
|
|
|
|
2016-03-05 19:45:09 +00:00
|
|
|
@end
|