VuoScreenCommon.mm File Reference

Description

VuoScreenCommon implementation.

Copyright

Copyright © 2012–2022 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoScreenCommon.mm.

Go to the source code of this file.

Classes
category	NSScreen(VuoAdditions)
	Some convenience methods for fetching information about an NSScreen. More...

Functions
static VuoText	VuoScreen_getName (CGDirectDisplayID displayID)
	Returns a descriptive string identifying the device. More...
void *	VuoScreen_getNSScreen (VuoScreen screen)
	Returns a platform screen (NSScreen) matching screen. More...
VuoScreen	VuoScreen_makeFromCGDirectDisplay (CGDirectDisplayID display)
	Fills in a VuoScreen structure describing an CGDirectDisplayID. More...
VuoScreen	VuoScreen_makeFromNSScreen (void *vscreen)
	Fills in a VuoScreen structure describing an NSScreen. More...
VuoList_VuoScreen	VuoScreen_getList (void)
	Returns a list of the currently-active screens. More...
VuoScreen	VuoScreen_getActive (void)
	Returns the screen with the window that has keyboard focus. More...
VuoScreen	VuoScreen_getPrimary (void)
	Returns the primary screen. More...
VuoScreen	VuoScreen_getSecondary (void)
	Returns a secondary (non-primary) screen if present, or a null screen otherwise. More...
void	VuoScreen_reconfiguration (CGDirectDisplayID display, CGDisplayChangeSummaryFlags flags, void *userInfo)
	Invoked by macOS Quartz Display Services. More...
void	VuoScreen_use (void)
	Indicates that the caller needs to get notifications about screens. More...
void	VuoScreen_disuse (void)
	Indicates that the caller no longer needs notifications about screens. More...
void	VuoScreen_addDevicesChangedTriggers (VuoOutputTrigger(screens, VuoList_VuoScreen))
	Adds a trigger callback, to be invoked whenever the list of known screens changes. More...
void	VuoScreen_removeDevicesChangedTriggers (VuoOutputTrigger(screens, VuoList_VuoScreen))
	Removes a trigger callback previously added by VuoScreen_addDevicesChangedTriggers. More...

Variables
static VuoTriggerSet< VuoList_VuoScreen >	VuoScreen_callbacks
	Trigger functions to call when the list of screens changes. More...
unsigned int	VuoScreen_useCount = 0
	Process-wide count of callers (typically node instances) interested in notifications about screens. More...

Function Documentation

VuoScreen_addDevicesChangedTriggers()

void VuoScreen_addDevicesChangedTriggers

(

VuoOutputTrigger(screens, VuoList_VuoScreen)

)

Adds a trigger callback, to be invoked whenever the list of known screens changes.

Call VuoScreen_use() before calling this.

This function may be called from any thread.

Changed in Vuo 2.0.0:

New.

Definition at line 469 of file VuoScreenCommon.mm.

VuoScreen_disuse()

void VuoScreen_disuse

(

void

)

Indicates that the caller no longer needs notifications about screens.

This function may be called from any thread.

Changed in Vuo 2.0.0:

New.

Definition at line 449 of file VuoScreenCommon.mm.

VuoScreen_getActive()

VuoScreen VuoScreen_getActive

(

void

)

Returns the screen with the window that has keyboard focus.

Definition at line 321 of file VuoScreenCommon.mm.

VuoScreen_getList()

VuoList_VuoScreen VuoScreen_getList

(

void

)

Returns a list of the currently-active screens.

Definition at line 295 of file VuoScreenCommon.mm.

VuoScreen_getName()

static VuoText VuoScreen_getName ( CGDirectDisplayID  displayID )

static

Returns a descriptive string identifying the device.

E.g., "Color LCD" or "LA2405".

Definition at line 53 of file VuoScreenCommon.mm.

VuoScreen_getNSScreen()

void * VuoScreen_getNSScreen

(

VuoScreen

screen

)

Returns a platform screen (NSScreen) matching screen.

Definition at line 237 of file VuoScreenCommon.mm.

VuoScreen_getPrimary()

VuoScreen VuoScreen_getPrimary

(

void

)

Returns the primary screen.

(In System Preferences > Displays > Arrangement, the primary screen is the one with the menu bar.)

Definition at line 335 of file VuoScreenCommon.mm.

VuoScreen_getSecondary()

VuoScreen VuoScreen_getSecondary

(

void

)

Returns a secondary (non-primary) screen if present, or a null screen otherwise.

Changed in Vuo 2.0.0:

Now returns a null screen if there is no secondary screen (instead of returning the primary screen.

Definition at line 345 of file VuoScreenCommon.mm.

VuoScreen_makeFromCGDirectDisplay()

VuoScreen VuoScreen_makeFromCGDirectDisplay

(

CGDirectDisplayID

display

)

Fills in a VuoScreen structure describing an CGDirectDisplayID.

Definition at line 261 of file VuoScreenCommon.mm.

VuoScreen_makeFromNSScreen()

VuoScreen VuoScreen_makeFromNSScreen

(

void *

vscreen

)

Fills in a VuoScreen structure describing an NSScreen.

Definition at line 286 of file VuoScreenCommon.mm.

VuoScreen_reconfiguration()

void VuoScreen_reconfiguration	(	CGDirectDisplayID	display,
		CGDisplayChangeSummaryFlags	flags,
		void *	userInfo
	)

Invoked by macOS Quartz Display Services.

Definition at line 367 of file VuoScreenCommon.mm.

VuoScreen_removeDevicesChangedTriggers()

void VuoScreen_removeDevicesChangedTriggers

(

VuoOutputTrigger(screens, VuoList_VuoScreen)

)

Removes a trigger callback previously added by VuoScreen_addDevicesChangedTriggers.

This function may be called from any thread.

Changed in Vuo 2.0.0:

New.

Definition at line 481 of file VuoScreenCommon.mm.

VuoScreen_use()

void VuoScreen_use

(

void

)

Indicates that the caller needs to get notifications about screens.

This function may be called from any thread.

Changed in Vuo 2.0.0:

New.

Definition at line 432 of file VuoScreenCommon.mm.

Variable Documentation

VuoScreen_callbacks

VuoTriggerSet<VuoList_VuoScreen> VuoScreen_callbacks

static

Trigger functions to call when the list of screens changes.

Definition at line 40 of file VuoScreenCommon.mm.

VuoScreen_useCount

unsigned int VuoScreen_useCount = 0

Process-wide count of callers (typically node instances) interested in notifications about screens.

Definition at line 41 of file VuoScreenCommon.mm.