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

kCVPixelBufferMemoryAllocatorKey

The allocator used with this buffer (type CFAllocatorRef).

kCVPixelBufferPixelFormatTypeKey

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.

kCVPixelBufferWidthKey

The width of the pixel buffer (type CFNumber).

kCVPixelBufferHeightKey

The height of the pixel buffer (type CFNumber).

kCVPixelBufferExtendedPixelsLeftKey

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

kCVPixelBufferExtendedPixelsTopKey

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

kCVPixelBufferExtendedPixelsRightKey

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

kCVPixelBufferExtendedPixelsBottomKey

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

kCVPixelBufferBytesPerRowAlignmentKey

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

kCVPixelBufferCGBitmapContextCompatibilityKey

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

kCVPixelBufferCGImageCompatibilityKey

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

kCVPixelBufferOpenGLCompatibilityKey

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

kCVPixelBufferPlaneAlignmentKey

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

kCVPixelBufferIOSurfacePropertiesKey

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

kCVPixelBufferOpenGLESCompatibilityKey

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

kCVPixelBufferMetalCompatibilityKey

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

kCVPixelBufferIOSurfaceCoreAnimationCompatibilityKey

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