Core Graphics Constants

No overview available.

Topics

Constants

kCGDisplayStreamColorSpace

This key specifies the color space of the output buffer. If this key is not included in the dictionary, the output buffer uses the same color space as the display. The value associated with this key must be a CGColorSpaceRef for the desired color space.

kCGColorConversionBlackPointCompensation

An option for whether to apply black point compensation when converting between color profiles.

kCGDisplayBitsPerPixel

Specifies a CFNumber integer value that represents the number of bits in a pixel.

kCGDisplayBitsPerSample

Specifies a CFNumber integer value that represents the number of bits in an individual sample (for example, a color value in an RGB pixel).

kCGDisplayBlendNormal

The blend color is not applied at the start or end of a fade operation.

kCGDisplayBlendSolidColor

The user sees only the blend color at the start or end of a fade operation.

kCGDisplayBytesPerRow

Specifies a CFNumber integer value that represents the number of bytes in a row on the display.

kCGDisplayHeight

Specifies a CFNumber integer value that represents the height of the display in pixels.

kCGDisplayIOFlags

Specifies a CFNumber integer value that contains the I/O Kit display mode flags. For more information, see the header file IOKit/IOGraphicsTypes.h.

kCGDisplayMode

Specifies a CFNumber integer value that represents the I/O Kit display mode number.

kCGDisplayModeIsInterlaced

Specifies a CFBoolean value indicating that the I/O Kit interlace mode flag is set.

kCGDisplayModeIsSafeForHardware

Specifies a CFBoolean value indicating that the display mode doesn’t need a confirmation dialog to be set.

kCGDisplayModeIsStretched

Specifies a CFBoolean value indicating that the I/O Kit stretched mode flag is set.

kCGDisplayModeIsTelevisionOutput

Specifies a CFBoolean value indicating that the I/O Kit television output mode flag is set.

kCGDisplayModeUsableForDesktopGUI

Specifies a CFBoolean value that indicates whether the display is suitable for use with the macOS graphical user interface. The criteria include factors such as sufficient width and height and adequate pixel depth.

kCGDisplayRefreshRate

Specifies a CFNumber double-precision floating point value that represents the refresh rate of a CRT display. Some displays may not use conventional video vertical and horizontal sweep in painting the screen; these displays report a refresh rate of 0.

kCGDisplaySamplesPerPixel

Specifies a CFNumber integer value that represents the number of samples in a pixel.

kCGDisplayStreamDestinationRect

This key specifies that the display stream outputs the frame data into a subset of the output IOSurface object. If this key is not included in the dictionary, then the entire output surface is used. The value must be created using the CGRectCreateDictionaryRepresentation function. The rectangle is specified in pixels in the surface’s coordinate system

kCGDisplayStreamMinimumFrameTime

This key specifies the desired minimum time between frame updates, allowing you to throttle the rate at which updates are received. If this key is not included in the dictionary, the default value is 0, meaning that updates are not throttled. The value must be specified as a CFNumber.

kCGDisplayStreamQueueDepth

This key specifies the number of frames to keep in the queue. If this key is not included in the dictionary, the default value is 3 frames. Specifying more frames uses more memory, but may allow you to process frame data without stalling the display stream. The value associated with this key should be specified as a CFNumber, and should not exceed 8 frames.

kCGDisplayStreamShowCursor

This key specifies whether the cursor should appear in the stream. If this key is not included in the dictionary, the cursor is visible. The value must be specified as a CFBoolean.

kCGDisplayStreamSourceRect

This key specifies that the display stream only samples a subset of the display’s framebuffer. If this key is not included in the dictionary, then the entire display is streamed. The value must be created using the CGRectCreateDictionaryRepresentation function. The rectangle is specified in points in the display’s logical coordinate system.

kCGDisplayStreamYCbCrMatrix

This key should only be included if you the display stream is creating output frames in either the 420v or 420f formats. It is used to specify the YCbCr matrix applied to the output surface. The value associated with this key must be one of the strings specified in Display Stream YCbCr to RGB conversion Matrix Options.

kCGDisplayStreamYCbCrMatrix_ITU_R_601_4

Specifies the YCbCr to RGB conversion matrix for standard digital television (ITU R 601) images.

kCGDisplayStreamYCbCrMatrix_ITU_R_709_2

Specifies the YCbCr to RGB conversion matrix for HDTV digital television (ITU R 709) images.

kCGDisplayStreamYCbCrMatrix_SMPTE_240M_1995

Specifies the YCbCR to RGB conversion matrix for 1920 x 1135 HDTV (SMPTE 240M 1995).

kCGDisplayWidth

Specifies a CFNumber integer value that represents the width of the display in pixels.

kCGErrorNameTooLong

A parameter, typically a C string, is too long to be used without truncation.

kCGErrorNoCurrentPoint

An operation relative to a known point or coordinate could not be done, as there is no known point.

kCGFontIndexInvalid

A value representing an invalid CGFontIndex.

kCGFontIndexMax

The maximum allowed value of a CGFontIndex.

kCGGlyphMax

The maximum allowed value of a CGGlyph.

kCGSessionConsoleSetKey

A CFNumber 32-bit unsigned integer value that represents a set of hardware composing a console.

kCGSessionLoginDoneKey

A CFBoolean value indicating whether the login operation has been done.

kCGSessionOnConsoleKey

A CFBoolean value indicating whether the session is on a console.

kCGSessionUserIDKey

A CFNumber 32-bit unsigned integer value that encodes a user ID for the session’s current user.

kCGSessionUserNameKey

A CFString value that encodes the session’s short user name as set by the login operation.

kCGDisplayStreamPreserveAspectRatio

This key specifies whether the display stream preserves the aspect ratio of the source pixel data. If this key is not included in the dictionary, then the aspect ratio is preserved. If the aspect ratio is preserved, then the display stream adds black bars to the output data. If the aspect ratio is not preserved, then the pixel data is stretched to fit the output buffer’s dimensions. The value associated with the key must be a CFBoolean.

kCGNullDirectDisplay

A value that will never correspond to actual hardware.