Pixel Buffer Attribute Keys

The attributes associated with a pixel buffer.

Overview

A pixel buffer attributes dictionary is a Core Foundation dictionary containing zero or more of these keys and appropriate values. Core Video functions such as CVPixelBufferCreate(_:_:_:_:_:_:) and CVPixelBufferPoolCreate(_:_:_:_:) accept pixel buffer attributes dictionaries to describe how to allocate pixel buffers for compatibility with client requirements. Where multiple CoreVideo clients seek to exchange pixel buffers, CVPixelBufferCreateResolvedAttributesDictionary(_:_:_:) can be used to find a common pixel buffer attributes dictionary that is compatible with all the clients' pixel buffer attributes dictionaries.

Topics

Constants

let kCVPixelBufferMemoryAllocatorKey: CFString

The allocator used with this buffer (type CFAllocatorRef).

let kCVPixelBufferPixelFormatTypeKey: CFString

One or more pixel format types used for this buffer. The value for this key may be a single CFNumber value or an array (CFArray) containing multiple CFNumber values.

let kCVPixelBufferWidthKey: CFString

The width of the pixel buffer (type CFNumber).

let kCVPixelBufferHeightKey: CFString

The height of the pixel buffer (type CFNumber).

let kCVPixelBufferExtendedPixelsLeftKey: CFString

The number of pixels padding the left of the image (type CFNumber).

let kCVPixelBufferExtendedPixelsTopKey: CFString

The number of pixels padding the top of the image (type CFNumber).

let kCVPixelBufferExtendedPixelsRightKey: CFString

The number of pixels padding the right of the image (type CFNumber).

let kCVPixelBufferExtendedPixelsBottomKey: CFString

The number of pixels padding the bottom of the image (type CFNumber).

let kCVPixelBufferBytesPerRowAlignmentKey: CFString

A number that specifies the alignment of number of bytes per row in the pixel buffer(type CFNumber).

let kCVPixelBufferCGBitmapContextCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer is compatible with Core Graphics bitmap contexts (type CFBoolean).

let kCVPixelBufferCGImageCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer is compatible with CGImage types (type CFBoolean).

let kCVPixelBufferOpenGLCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer is compatible with OpenGL contexts (type CFBoolean).

let kCVPixelBufferPlaneAlignmentKey: CFString

A number that specifies the alignment of the planes in the pixel buffer (type CFNumber).

let kCVPixelBufferIOSurfacePropertiesKey: CFString

A dictionary containing optional properties for use by the IOSurface framework (type CFDictionary).

let kCVPixelBufferOpenGLESCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer is compatible with OpenGL ES contexts (type CFBoolean).

let kCVPixelBufferMetalCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer is compatible with the Metal framework (type CFBoolean).

let kCVPixelBufferIOSurfaceCoreAnimationCompatibilityKey: CFString

A Boolean value that indicates whether the pixel buffer can be displayed by CoreAnimation.