CGConfigureDisplayMode(_:_:_:)

Declaration

func CGConfigureDisplayMode(_ config: CGDisplayConfigRef?, _ display: CGDirectDisplayID, _ mode: CFDictionary?) -> CGError

Parameters

• config:

  A display configuration, acquired by calling Cgbegindisplayconfiguration(_:).

• display:

  The identifier of the display being configured.

• mode:

  A display mode dictionary (see the discussion below).

Return Value

A result code. See Core Graphics Data Types and Constants.

Discussion

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.

The display mode you provide must be one of the following:

• A dictionary returned by one of the CGDisplayBestMode functions, such as CGDisplayBestModeForParameters(_:_:_:_:_:).

• A dictionary in the array returned by CGDisplayAvailableModes(_:).

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.

Special Considerations

This deprecated function takes as a parameter a display mode dictionary. Starting in OS X v10.6, display mode dictionaries have been replaced by the CGDisplayMode opaque type. For information on the CGDisplayMode opaque type, see Getting Information About a Display Mode.

See Also

Functions

• CGAcquireDisplayFadeReservation(_:_:)
• CGAssociateMouseAndMouseCursorPosition(_:)
• CGBeginDisplayConfiguration(_:)
• CGCancelDisplayConfiguration(_:)
• CGCaptureAllDisplays()
• CGCaptureAllDisplaysWithOptions(_:)
• CGCompleteDisplayConfiguration(_:_:)
• CGConfigureDisplayFadeEffect(_:_:_:_:_:_:)
• CGConfigureDisplayMirrorOfDisplay(_:_:_:)
• CGConfigureDisplayOrigin(_:_:_:_:)
• CGConfigureDisplayStereoOperation(_:_:_:_:)
• CGConfigureDisplayWithDisplayMode(_:_:_:_:)
• CGCursorIsDrawnInFramebuffer()
• CGCursorIsVisible()
• CGDirectDisplayCopyCurrentMetalDevice(_:)