<!--
{
  "documentType" : "article",
  "framework" : "IOSurface",
  "identifier" : "/documentation/IOSurface/iosurface-constants",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "IOSurface Constants"
}
-->

# IOSurface Constants

## Topics

### Constants

[`let kIOSurfaceAllocSize: CFString`](/documentation/IOSurface/kIOSurfaceAllocSize)

CFNumber of the total allocation size of the buffer including all planes.

[`let kIOSurfaceBytesPerElement: CFString`](/documentation/IOSurface/kIOSurfaceBytesPerElement)

The total number of bytes in an element.

[`let kIOSurfaceBytesPerRow: CFString`](/documentation/IOSurface/kIOSurfaceBytesPerRow)

The bytes per row of the buffer.

[`let kIOSurfaceCacheMode: CFString`](/documentation/IOSurface/kIOSurfaceCacheMode)

The CPU cache mode to be used for the allocation.

[`let kIOSurfaceColorSpace: CFString`](/documentation/IOSurface/kIOSurfaceColorSpace)

[`let kIOSurfaceElementHeight: CFString`](/documentation/IOSurface/kIOSurfaceElementHeight)

CFNumber for how many pixels high each element is.

[`let kIOSurfaceElementWidth: CFString`](/documentation/IOSurface/kIOSurfaceElementWidth)

CFNumber for how many pixels wide each element is.

[`let kIOSurfaceHeight: CFString`](/documentation/IOSurface/kIOSurfaceHeight)

The height of the IOSurface buffer in pixels.

[`let kIOSurfaceICCProfile: CFString`](/documentation/IOSurface/kIOSurfaceICCProfile)

[`let kIOSurfaceIsGlobal: CFString`](/documentation/IOSurface/kIOSurfaceIsGlobal)

CFBoolean If true, the IOSurface may be looked up by any task in the system by its ID.

[`let kIOSurfaceName: CFString`](/documentation/IOSurface/kIOSurfaceName)

[`let kIOSurfaceOffset: CFString`](/documentation/IOSurface/kIOSurfaceOffset)

The starting offset into the buffer.

[`let kIOSurfacePixelFormat: CFString`](/documentation/IOSurface/kIOSurfacePixelFormat)

A 32-bit unsigned integer that stores the traditional macOS buffer format.

[`let kIOSurfacePixelSizeCastingAllowed: CFString`](/documentation/IOSurface/kIOSurfacePixelSizeCastingAllowed)

[`let kIOSurfacePlaneBase: CFString`](/documentation/IOSurface/kIOSurfacePlaneBase)

The base offset into the buffer for this plane.

[`let kIOSurfacePlaneBitsPerElement: CFString`](/documentation/IOSurface/kIOSurfacePlaneBitsPerElement)

[`let kIOSurfacePlaneBytesPerElement: CFString`](/documentation/IOSurface/kIOSurfacePlaneBytesPerElement)

The bytes per element of this plane.

[`let kIOSurfacePlaneBytesPerRow: CFString`](/documentation/IOSurface/kIOSurfacePlaneBytesPerRow)

The bytes per row of this plane.

[`let kIOSurfacePlaneComponentBitDepths: CFString`](/documentation/IOSurface/kIOSurfacePlaneComponentBitDepths)

[`let kIOSurfacePlaneComponentBitOffsets: CFString`](/documentation/IOSurface/kIOSurfacePlaneComponentBitOffsets)

[`let kIOSurfacePlaneComponentNames: CFString`](/documentation/IOSurface/kIOSurfacePlaneComponentNames)

[`let kIOSurfacePlaneComponentRanges: CFString`](/documentation/IOSurface/kIOSurfacePlaneComponentRanges)

[`let kIOSurfacePlaneComponentTypes: CFString`](/documentation/IOSurface/kIOSurfacePlaneComponentTypes)

[`let kIOSurfacePlaneElementHeight: CFString`](/documentation/IOSurface/kIOSurfacePlaneElementHeight)

The element height of this plane.

[`let kIOSurfacePlaneElementWidth: CFString`](/documentation/IOSurface/kIOSurfacePlaneElementWidth)

The element width of this plane.

[`let kIOSurfacePlaneHeight: CFString`](/documentation/IOSurface/kIOSurfacePlaneHeight)

The height of this plane in pixels.

[`let kIOSurfacePlaneInfo: CFString`](/documentation/IOSurface/kIOSurfacePlaneInfo)

CFArray describing each image plane in the buffer as a CFDictionary.

[`let kIOSurfacePlaneOffset: CFString`](/documentation/IOSurface/kIOSurfacePlaneOffset)

The offset into the buffer for this plane.

[`let kIOSurfacePlaneSize: CFString`](/documentation/IOSurface/kIOSurfacePlaneSize)

The total data size of this plane.

[`let kIOSurfacePlaneWidth: CFString`](/documentation/IOSurface/kIOSurfacePlaneWidth)

The width of this plane in pixels.

[`let kIOSurfaceSubsampling: CFString`](/documentation/IOSurface/kIOSurfaceSubsampling)

[`var kIOSurfaceSuccess: Int32`](/documentation/IOSurface/kIOSurfaceSuccess)

[`let kIOSurfaceWidth: CFString`](/documentation/IOSurface/kIOSurfaceWidth)

The width of the IOSurface buffer in pixels.

### Macros

[`#define IOSFC_DEPRECATED_MSG(s)`](/documentation/IOSurface/IOSFC_DEPRECATED_MSG)

[`#define IOSFC_IOS_DEPRECATED_MSG(s)`](/documentation/IOSurface/IOSFC_IOS_DEPRECATED_MSG)

[`#define IOSFC_SWIFT_NAME(name)`](/documentation/IOSurface/IOSFC_SWIFT_NAME)


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)