Returns the base address of the pixel buffer.
SDKs
- iOS 4.0+
- macOS 10.4+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Core Video
Declaration
func CVPixelBufferGetBaseAddress(_ pixelBuffer: CVPixelParameters
pixelBufferThe pixel buffer whose base address you want to obtain.
Return Value
The base address of the pixel buffer.
Discussion
The pointer returned by this function depends on the type of buffer and the conditions under which it was created.
For chunky buffers, returns a pointer to the pixel at (0,0) in the buffer.
For planar buffers, returns a pointer to a
CVPlanarstructure, orComponent Info NULLif no such structure is present.
Because this function returns NULL for some planar buffers, you should call CVPixel and CVPixel to get information about a planar buffer.
Retrieving the base address for a pixel buffer requires that the buffer base address be locked using the CVPixel function.