Platforms to show: All Mac Windows Linux Cross-Platform
Back to CGDisplayConfigMBS class.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
On return, the configuration is cancelled and is no longer valid.
Calls CGCancelDisplayConfiguration.
CGDisplayConfigMBS.Complete(options as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
On return, the configuration is no longer valid.
A configuration change can apply for the life of an application, the life of a login session, or permanently. If a request is made to make a change permanent, and the change cannot be supported by Mac OS X user interface, then the configuration change lasts only for the current login session.
A permanent configuration change also becomes the current session's configuration.
When the system reverts configurations at app termination, the configuration reverts to the session or permanent configuration setting.
When the system reverts configurations at session termination, the configuration reverts to the permanent configuration setting.
This operation may fail if an unsupported display mode is requested, or if another app is running in full-screen mode.
Calls CGCompleteDisplayConfiguration.
CGDisplayConfigMBS.DisplayMode(display as CGDisplayMBS, mode as CGDisplayModeMBS)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
A display mode is a set of properties such as width, height, pixel depth, and refresh rate, and options such as stretched LCD panel filling.
If you use this function to change the mode of a display in a mirroring set, Quartz may adjust the bounds, resolutions, and depth of the other displays in the set to a safe mode, with matching depth and the smallest enclosing size.
Calls CGConfigureDisplayWithDisplayMode.
CGDisplayConfigMBS.MirrorOfDisplay(display as CGDisplayMBS, master as CGDisplayMBS)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Pass nil for the master display to disable mirroring.
Pass MainDisplay for the master display to mirror the main display.
Display mirroring and display matte generation are implemented either in hardware (preferred) or software, at the discretion of the device driver.
- Hardware mirroring
With hardware mirroring enabled, all drawing is directed to the primary
display --- see PrimaryDisplay.
If the device driver selects hardware matte generation, the display bounds and rowbytes values are adjusted to reflect the active drawable area.
- Software mirroring
In this form of mirroring, identical content is drawn into each display in the mirroring set. Applications that use the window system need not be concerned about mirroring, as the window system takes care of all flushing of window content to the appropriate displays.
Applications that draw directly to the display, as with display capture, must make sure to draw the same content to all mirrored displays in a software mirror set. When drawing to software mirrored displays using a full screen OpenGL context (not drawing through a window), you should create shared OpenGL contexts for each display and re-render for each display.
You can use the function GetActiveDisplayList to determine which displays are active, or drawable. This automatically gives your application the correct view of the current displays.
Calls CGConfigureDisplayMirrorOfDisplay.
CGDisplayConfigMBS.Mode(display as CGDisplayMBS, mode as Dictionary)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Deprecated with Mac OS X 10.6.
Calls CGConfigureDisplayMode.
CGDisplayConfigMBS.Origin(display as CGDisplayMBS, x as Integer, y as Integer)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The new origin of the display is placed as close as possible to the requested location, without overlapping or leaving a gap between displays.
Any display whose origin is not explicitly set in a reconfiguration will be repositioned to a location as close as possible to its current location without overlapping or leaving a gap between displays.
Note that setting the origin of a display which is mirroring another display will remove that display from any mirroring set.
Calls CGConfigureDisplayOrigin.
CGDisplayConfigMBS.StereoOperation(display as CGDisplayMBS, stereo as Boolean, forceBlueLine as Boolean)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | CoreGraphics | MBS MacCG Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Note that the system normally detects the presence of a stereo window, and will automatically switch a display containing a stereo window to stereo operation. This function provides a mechanism to force a display to stereo operation, and to set options (such as blue line sync signal) when in stereo operation.
When in stereo operation, a display may need to generate a special stereo sync signal as part of the video output. The sync signal consists of a blue line which occupies the first 25% of the last scanline for the left eye view, and the first 75% of the last scanline for the right eye view. The remainder of the scanline is black. To force the display to generate this sync signal, pass true for forceBlueLine; otherwise, pass false.
Returns kCGErrorSuccess on success, or kCGErrorRangeCheck if the display does not support the stereo operation settings requested.
On success, the display resolution, mirroring mode, and available display modes may change due to hardware-specific capabilities and limitations. You should check these settings to verify that they are appropriate for your application.
Calls CGConfigureDisplayStereoOperation.
The items on this page are in the following plugins: MBS MacCG Plugin.
