Creates a single pixel buffer in planar format for a given size and pixel format containing data specified by a memory location.
SDKs
- iOS 4.0+
- macOS 10.4+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Core Video
Declaration
func CVPixelBufferCreateWithPlanarBytes(_ allocator: CFAllocator?, _ width: Int, _ height: Int, _ pixelFormatType: OSType, _ dataPtr: UnsafeParameters
allocatorThe allocator to use to create this buffer. Pass
NULLto specify the default allocator.widthThe width of the pixel buffer, in pixels.
heightThe height of the pixel buffer, in pixels.
pixelFormatTypeThe pixel format identified by its respective four-character code (type
OSType).dataPtrA pointer to a plane descriptor block if applicable, or
NULLif it is not.dataSizeThe size of the memory if the planes are contiguous, or
NULLif it is not.numberOfPlanesThe number of planes.
planeBaseAddressThe array of base addresses for the planes.
planeWidthThe array of plane widths.
planeHeightThe array of plane heights.
planeBytesPerRowThe array of plane bytes-per-row values.
releaseCallbackThe callback function that gets called when the pixel buffer is destroyed. This callback allows the owner of the pixels to free the memory. See
CVPixelfor more information.Buffer Release Bytes Callback releaseRefConA pointer to user data identifying the pixel buffer. This value is passed to your pixel buffer release callback.
pixelBufferAttributesA dictionary with additional attributes for a a pixel buffer. This parameter is optional. See Pixel Buffer Attribute Keys for more details.
pixelBufferOutOn output, the newly created pixel buffer. Ownership follows the The Create Rule.
Return Value
A Core Video result code. See Core Video Constants for possible values.
Discussion
Some of the parameters specified in this call override equivalent pixel buffer attributes. For example, if you define the k and k keys in the pixel buffer attributes parameter (pixel), these values are overridden by the width and height parameters.