Description

A window containing a VuoGraphicsView.

Instance Methods
(instancetype)	- initWithInitCallback:updateBackingCallback:resizeCallback:drawCallback:userData:
	Creates a window with the default size and position.

(void)	- scheduleRedraw
	Schedules the OpenGL view to be redrawn.

(bool)	- isFullScreen
	Returns YES if this window is currently fullscreen.

(void)	- finishFullScreenTransition
	Ends the programmatic-resizing event-block, and explicitly fires the resize handler once.

(void)	- enableShowedWindowTrigger:requestedFrameTrigger:
	Sets up the window to call trigger functions.

(void)	- disableTriggers
	Stops the window from calling trigger functions.

(void)	- setProperties:
	Applies a list of properties to this window.

(void)	- setAspectRatioToWidth:height:
	Constrains the window's aspect ratio to `pixelsWide/pixelsHigh`.

(void)	- unlockAspectRatio
	Removes the aspect ratio constraint set by VuoWindowOpenGl_setAspectRatio.

(void)	- initDrag
	Helper for VuoGraphicsWindow's init method.

(void)	- addDragEnteredCallback:dragMovedToCallback:dragCompletedCallback:dragExitedCallback:
	Adds callbacks to be invoked when files are dragged from Finder.

(void)	- removeDragEnteredCallback:dragMovedToCallback:dragCompletedCallback:dragExitedCallback:
	Removes callbacks that would have been invoked when files were dragged from Finder.

Properties
NSRect	contentRectCached
	The window's content area.

float	backingScaleFactorCached
	The number of pixels per point in the window's content area.

NSMenu *	oldMenu
	The host app's menu, before the window was activated.

BOOL	isClosed
	Has the window been closed?

VuoWindowRecorder *	recorder
	nil if recording is inactive.

NSURL *	temporaryMovieURL
	The temporary file to which the movie is being saved.

bool	programmaticallyResizingWindow
	True if a programmatic resize of the window is in progress.

bool	programmaticallyTransitioningFullScreen
	True if a programmatic Mac-fullscreen transition is in progress.

bool	userResizedWindow
	True if the user has manually resized the window.

BOOL	isInMacFullScreenMode
	Is Mac OS X's fullscreen mode (green arrow button in titlebar) currently active?

VuoCursor	cursor
	The current mouse cursor for this window.

BOOL	maintainsPixelSizeWhenBackingChanges
	When the window is dragged between a retina and non-retina screen, should it maintain its size in points or pixels?

NSString *	titleBackup
	The window's title (stored since it gets cleared when switching to fullscreen mode).

NSUInteger	styleMaskWhenWindowed
	The window's style mask, prior to switching to full-screen.

NSRect	contentRectWhenWindowed
	The position and size of the window's content area, prior to switching to full-screen. In points (not pixels).

uint64_t	compositionUid
	The composition that contains this window.

void *	dragEntered
	A VuoTriggerSet of callbacks invoked when a Finder drag first moves into the window.

void *	dragMovedTo
	A VuoTriggerSet of callbacks invoked when a Finder drag moves around within the window.

void *	dragCompleted
	A VuoTriggerSet of callbacks invoked when a Finder drag is released over the window.

void *	dragExited
	A VuoTriggerSet of callbacks invoked when a Finder drag leaves the window without being released.

VuoGraphicsWindowShowedWindowCallback	showedWindow
	Callback to invoke when the window is shown, moved, and resized.

VuoGraphicsWindowRequestedFrameCallback	requestedFrame
	Callback to invoke when the display is ready for the next frame.

Method Documentation

- (void) addDragEnteredCallback:	(VuoGraphicsWindowDragCallback)	dragEnteredCallback
dragMovedToCallback:	(VuoGraphicsWindowDragCallback)	dragMovedCallback
dragCompletedCallback:	(VuoGraphicsWindowDragCallback)	dragCompletedCallback
dragExitedCallback:	(VuoGraphicsWindowDragCallback)	dragExitedCallback

Adds callbacks to be invoked when files are dragged from Finder.

Provided by category VuoGraphicsWindow(Drag).

- (void) disableTriggers

Stops the window from calling trigger functions.

This function may be called from any thread.

- (void) enableShowedWindowTrigger:	(VuoGraphicsWindowShowedWindowCallback)	showedWindow
requestedFrameTrigger:	(VuoGraphicsWindowRequestedFrameCallback)	requestedFrame

Sets up the window to call trigger functions.

This function may be called from any thread.

- (void) finishFullScreenTransition

Ends the programmatic-resizing event-block, and explicitly fires the resize handler once.

To be called when the delegate receives -windowDidEnter/ExitFullScreen:.

- (void) initDrag

Helper for VuoGraphicsWindow's init method.

Provided by category VuoGraphicsWindow(Drag).

- (instancetype) initWithInitCallback:	(VuoGraphicsWindowInitCallback)	initCallback
updateBackingCallback:	(VuoGraphicsWindowUpdateBackingCallback)	updateBackingCallback
resizeCallback:	(VuoGraphicsWindowResizeCallback)	resizeCallback
drawCallback:	(VuoGraphicsWindowDrawCallback)	drawCallback
userData:	(void *)	userData

Creates a window with the default size and position.

- (bool) isFullScreen

Returns YES if this window is currently fullscreen.

- (void) removeDragEnteredCallback:	(VuoGraphicsWindowDragCallback)	dragEnteredCallback
dragMovedToCallback:	(VuoGraphicsWindowDragCallback)	dragMovedCallback
dragCompletedCallback:	(VuoGraphicsWindowDragCallback)	dragCompletedCallback
dragExitedCallback:	(VuoGraphicsWindowDragCallback)	dragExitedCallback

Removes callbacks that would have been invoked when files were dragged from Finder.

Provided by category VuoGraphicsWindow(Drag).

- (void) scheduleRedraw

Schedules the OpenGL view to be redrawn.

This can be used in both windowed and full-screen mode.

This function may be called from any thread.

- (void) setAspectRatioToWidth:	(unsigned int)	pixelsWide
height:	(unsigned int)	pixelsHigh

Constrains the window's aspect ratio to pixelsWide/pixelsHigh.

Also resizes the window to pixelsWide by pixelsHigh, unless:

the user has manually resized the window, in which case the user-set width is preserved
the requested size is larger than the window's screen, in which case the window is scaled to fit the screen
the requested size is smaller than Cocoa can properly render, in which case the size is clamped

This function may only be called on the main thread.

- (void) setProperties: (VuoList_VuoWindowProperty) properties

Applies a list of properties to this window.

This function may only be called on the main thread.

- (void) unlockAspectRatio

Removes the aspect ratio constraint set by VuoWindowOpenGl_setAspectRatio.

This function may only be called on the main thread.

Property Documentation

- (float) backingScaleFactorCached

readwriteatomicassign

The number of pixels per point in the window's content area.

- (uint64_t) compositionUid

readwriteatomic

The composition that contains this window.

- (NSRect) contentRectCached

readwriteatomicassign

The window's content area.

- (NSRect) contentRectWhenWindowed

readwriteatomic

The position and size of the window's content area, prior to switching to full-screen. In points (not pixels).

- (VuoCursor) cursor

readwriteatomic

The current mouse cursor for this window.

- (void*) dragCompleted

readwriteatomic

A VuoTriggerSet of callbacks invoked when a Finder drag is released over the window.

- (void*) dragEntered

readwriteatomic

A VuoTriggerSet of callbacks invoked when a Finder drag first moves into the window.

- (void*) dragExited

readwriteatomic

A VuoTriggerSet of callbacks invoked when a Finder drag leaves the window without being released.

- (void*) dragMovedTo

readwriteatomic

A VuoTriggerSet of callbacks invoked when a Finder drag moves around within the window.

- (BOOL) isClosed

readwriteatomic

Has the window been closed?

- (BOOL) isInMacFullScreenMode

readwriteatomic

Is Mac OS X's fullscreen mode (green arrow button in titlebar) currently active?

- (BOOL) maintainsPixelSizeWhenBackingChanges

readwriteatomic

When the window is dragged between a retina and non-retina screen, should it maintain its size in points or pixels?

- (NSMenu*) oldMenu

readwriteatomicretain

The host app's menu, before the window was activated.

- (bool) programmaticallyResizingWindow

readwriteatomic

True if a programmatic resize of the window is in progress.

- (bool) programmaticallyTransitioningFullScreen

readwriteatomic

True if a programmatic Mac-fullscreen transition is in progress.

- (VuoWindowRecorder*) recorder

readwriteatomicassign

nil if recording is inactive.

- (VuoGraphicsWindowRequestedFrameCallback) requestedFrame

readwriteatomicassign

Callback to invoke when the display is ready for the next frame.

- (VuoGraphicsWindowShowedWindowCallback) showedWindow

readwriteatomicassign

Callback to invoke when the window is shown, moved, and resized.

- (NSUInteger) styleMaskWhenWindowed

readwriteatomic

The window's style mask, prior to switching to full-screen.

- (NSURL*) temporaryMovieURL

readwriteatomicretain

The temporary file to which the movie is being saved.

- (NSString*) titleBackup

readwriteatomicretain

The window's title (stored since it gets cleared when switching to fullscreen mode).

- (bool) userResizedWindow

readwriteatomic

True if the user has manually resized the window.

The documentation for this class was generated from the following files:

library/VuoGraphicsWindow.h
library/VuoGraphicsWindow.m

Description

Instance Methods

Properties

Method Documentation

Property Documentation