Vuo  0.5.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Instance Methods | Protected Attributes | Properties | List of all members
VuoWindowOpenGLInternal Class Reference

Description

A graphics window for use by Vuo node classes.

The graphics window renders onto an OpenGL context shared with Vuo nodes, so that it can render the scenes created by those nodes. A scene is rendered by calling callbacks provided by the Vuo nodes.

Instance Methods

(void) - enableTriggersWithMovedMouseTo:scrolledMouse:usedMouseButton:
 Sets up the window to call trigger functions.
 
(void) - disableTriggers
 Stops the window from calling trigger functions.
 
(void) - scheduleRedraw
 Schedules the OpenGL view to be redrawn.
 
(void) - executeWithWindowContext:
 Executes the specifed block on the window's OpenGL context, then returns.
 
(void) - setAspectRatioToWidth:height:
 Constrains the window's aspect ratio to pixelsWide/pixelsHigh.
 
(void) - toggleFullScreen
 Switches between full-screen and windowed mode.
 

Protected Attributes

BOOL userResizedWindow
 True if the user has manually resized the window.
 
BOOL programmaticallyResizingWindow
 True if a programmatic resize of the window is in progress.
 

Properties

BOOL callbacksEnabled
 True if the window can call its trigger callbacks.
 
VuoWindowOpenGLViewglView
 The OpenGL view inside this window.
 
BOOL depthBuffer
 Was a depth buffer requested?
 

Method Documentation

- (void) disableTriggers

Stops the window from calling trigger functions.

This function may be called from any thread.

- (void) enableTriggersWithMovedMouseTo: (VuoPoint2d _movedMouseTo
scrolledMouse: (VuoPoint2d _scrolledMouse
usedMouseButton: (VuoMouseButtonAction _usedMouseButton 

Sets up the window to call trigger functions.

This function may be called from any thread.

- (void) executeWithWindowContext: (VuoGlContext glContext)  blockToExecute

Executes the specifed block on the window's OpenGL context, then returns.

Ensures that nobody else is using the OpenGL context at that time (by synchronizing with the window's drawQueue).

This function may be called from any thread.

- (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 width is preserved) or the requested size is larger than the window's screen (in which case the window is scaled to fit the screen).

This function may be called from any thread.

- (void) toggleFullScreen

Switches between full-screen and windowed mode.

This function may only be called on the main thread.

Member Data Documentation

- (BOOL) programmaticallyResizingWindow
protected

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

- (BOOL) userResizedWindow
protected

True if the user has manually resized the window.

Property Documentation

- (BOOL) callbacksEnabled
atomicprotected

True if the window can call its trigger callbacks.

- (BOOL) depthBuffer
readwriteatomic

Was a depth buffer requested?

- (VuoWindowOpenGLView*) glView
readwriteatomicretain

The OpenGL view inside this window.


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