Function

CVPixelBufferIsPlanar

Determines whether the pixel buffer is planar.

Declaration

Boolean CVPixelBufferIsPlanar(CVPixelBufferRef pixelBuffer);

Parameters

pixelBuffer

The pixel buffer to check.

Return Value

true if the pixel buffer is planar; otherwise, false.

Discussion

Planar buffers can be created using the CVPixelBufferCreateWithPlanarBytes function.

See Also

Inspecting Pixel Buffers

CVPixelBufferGetBaseAddress

Returns the base address of the pixel buffer.

CVPixelBufferGetBaseAddressOfPlane

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

CVPixelBufferGetBytesPerRow

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

CVPixelBufferGetBytesPerRowOfPlane

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

CVPixelBufferGetHeight

Returns the height of the pixel buffer.

CVPixelBufferGetHeightOfPlane

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

CVPixelBufferGetWidth

Returns the width of the pixel buffer.

CVPixelBufferGetWidthOfPlane

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

CVPixelBufferGetPlaneCount

Returns number of planes of the pixel buffer.

CVPixelBufferGetDataSize

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

CVPixelBufferGetPixelFormatType

Returns the pixel format type of the pixel buffer.

CVPixelBufferGetExtendedPixels

Returns the amount of extended pixel padding in the pixel buffer.

CVPixelBufferGetIOSurface

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

CVPixelBufferCreateResolvedAttributesDictionary

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

CVPixelBufferGetTypeID

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