Function

CVPixelBufferGetBaseAddress(_:)

Returns the base address of the pixel buffer.

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

func CVPixelBufferGetBaseAddressOfPlane(CVPixelBuffer, Int) -> UnsafeMutableRawPointer?

Returns the base address of the plane at the specified plane index.

func CVPixelBufferGetBytesPerRow(CVPixelBuffer) -> Int

Returns the number of bytes per row of the pixel buffer.

func CVPixelBufferGetBytesPerRowOfPlane(CVPixelBuffer, Int) -> Int

Returns the number of bytes per row for a plane at the specified index in the pixel buffer.

func CVPixelBufferGetHeight(CVPixelBuffer) -> Int

Returns the height of the pixel buffer.

func CVPixelBufferGetHeightOfPlane(CVPixelBuffer, Int) -> Int

Returns the height of the plane at planeIndex in the pixel buffer.

func CVPixelBufferGetWidth(CVPixelBuffer) -> Int

Returns the width of the pixel buffer.

func CVPixelBufferGetWidthOfPlane(CVPixelBuffer, Int) -> Int

Returns the width of the plane at a given index in the pixel buffer.

func CVPixelBufferIsPlanar(CVPixelBuffer) -> Bool

Determines whether the pixel buffer is planar.

func CVPixelBufferGetPlaneCount(CVPixelBuffer) -> Int

Returns number of planes of the pixel buffer.

func CVPixelBufferGetDataSize(CVPixelBuffer) -> Int

Returns the data size for contiguous planes of the pixel buffer.

func CVPixelBufferGetPixelFormatType(CVPixelBuffer) -> OSType

Returns the pixel format type of the pixel buffer.

func CVPixelBufferGetIOSurface(CVPixelBuffer?) -> Unmanaged<IOSurfaceRef>?

Returns the IOSurface backing the pixel buffer, or NULL if it is not backed by an IOSurface.

func CVPixelBufferCreateResolvedAttributesDictionary(CFAllocator?, CFArray?, UnsafeMutablePointer<CFDictionary?>) -> CVReturn

Resolves an array of CFDictionary objects describing various pixel buffer attributes into a single dictionary.

func CVPixelBufferGetTypeID() -> CFTypeID

Returns the Core Foundation type identifier of the pixel buffer type.