Function

CGDisplayIsAsleep

Returns a Boolean value indicating whether a display is sleeping (and is therefore not drawable).

Declaration

boolean_t CGDisplayIsAsleep(CGDirectDisplayID display);

Parameters

display

The identifier of the display to be accessed.

Return Value

If YES, the specified display is in sleep mode; otherwise, NO.

Discussion

A display is sleeping when its framebuffer and the attached monitor are in reduced power mode. A sleeping display is still considered to be a part of global display (desktop) space, but it is not drawable.

See Also

Getting the Display Configuration

CGDisplayCopyColorSpace

Returns the color space for a display.

CGDisplayIOServicePort

Returns the I/O Kit service port of the specified display.

Deprecated
CGDisplayIsActive

Returns a Boolean value indicating whether a display is active.

CGDisplayIsAlwaysInMirrorSet

Returns a Boolean value indicating whether a display is always in a mirroring set.

CGDisplayIsBuiltin

Returns a Boolean value indicating whether a display is built-in, such as the internal display in portable systems.

CGDisplayIsInHWMirrorSet

Returns a Boolean value indicating whether a display is in a hardware mirroring set.

CGDisplayIsInMirrorSet

Returns a Boolean value indicating whether a display is in a mirroring set.

CGDisplayIsMain

Returns a Boolean value indicating whether a display is the main display.

CGDisplayIsOnline

Returns a Boolean value indicating whether a display is connected or online.

CGDisplayIsStereo

Returns a Boolean value indicating whether a display is running in a stereo graphics mode.

CGDisplayMirrorsDisplay

For a secondary display in a mirroring set, returns the primary display.

CGDisplayModelNumber

Returns the model number of a display monitor.

CGDisplayPrimaryDisplay

Returns the primary display in a hardware mirroring set.

CGDisplayRotation

Returns the rotation angle of a display in degrees.

CGDisplayScreenSize

Returns the width and height of a display in millimeters.

CGDisplaySerialNumber

Returns the serial number of a display monitor.

CGDisplayUnitNumber

Returns the logical unit number of a display.

CGDisplayUsesOpenGLAcceleration

Returns a Boolean value indicating whether Quartz is using OpenGL-based window acceleration (Quartz Extreme) to render in a display.

CGDisplayVendorNumber

Returns the vendor number of the specified display’s monitor.