CVPixelBufferGetBaseAddress(_:)

Declaration

func CVPixelBufferGetBaseAddress(_ pixelBuffer: CVPixelBuffer) -> UnsafeMutableRawPointer?

Parameters

• pixelBuffer:

  The 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 CVPlanarComponentInfo structure, or NULL if no such structure is present.

Because this function returns NULL for some planar buffers, you should call CVPixelBufferGetBaseAddressOfPlane(_:_:) and CVPixelBufferGetBytesPerRowOfPlane(_:_:) 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 CVPixelBufferLockBaseAddress(_:_:) function.

See Also

Inspecting Pixel Buffers

• CVPixelBufferGetBaseAddressOfPlane(_:_:)
• CVPixelBufferGetBytesPerRow(_:)
• CVPixelBufferGetBytesPerRowOfPlane(_:_:)
• CVPixelBufferGetHeight(_:)
• CVPixelBufferGetHeightOfPlane(_:_:)
• CVPixelBufferGetWidth(_:)
• CVPixelBufferGetWidthOfPlane(_:_:)
• CVPixelBufferIsPlanar(_:)
• CVPixelBufferGetPlaneCount(_:)
• CVPixelBufferGetDataSize(_:)
• CVPixelBufferGetPixelFormatType(_:)
• CVPixelBufferGetExtendedPixels(_:_:_:_:_:)
• CVPixelBufferGetIOSurface(_:)
• CVPixelBufferCreateResolvedAttributesDictionary(_:_:_:)
• CVPixelBufferGetTypeID()