One Logo Pool Ball
CoreVideo · IOS API REFERENCE

CVMutablePixelBuffer.Pool

class · iOS 26.0+ · SDK 27.1

final class Pool

Manage and recycle pixel buffer backings.

Members (4)

init · iOS 26.0+

init

TypeScript
static initPixelBufferAttributesConfiguration(attributes: CVPixelBufferCreationAttributes, configuration?: CVMutablePixelBuffer_Pool_Configuration): CVMutablePixelBuffer_Pool
Swift declaration
init(pixelBufferAttributes attributes: CVPixelBufferCreationAttributes, configuration: CVMutablePixelBuffer.Pool.Configuration = .init()) throws

Create a new pixel buffer pool which creates pixel buffers using `pixelBufferAttributes`. - Parameter pixelBufferAttributes: The attributes used for creating the pixel buffer. - Parameter configuration: Change how the pool allocates and reuses pixel buffer backings.

get · iOS 26.0+

pixelBufferAttributes

TypeScript
get pixelBufferAttributes(): CVPixelBufferCreationAttributes
Swift declaration
final var pixelBufferAttributes: CVPixelBufferCreationAttributes { get }

Creation attributes for the pixel buffers created by this pool.

init · iOS 26.0+

init

TypeScript
static initUnsafePool(unsafePool: CVPixelBufferPool): CVMutablePixelBuffer_Pool
Swift declaration
init(unsafePool: sending CVPixelBufferPool)

Initialize a mutable pixel buffer pool by transferring existing CVPixelBufferPool.

method · iOS 26.0+

flush

TypeScript
flush(agedOutOnly?: boolean): void
Swift declaration
final func flush(agedOutOnly: Bool = true)

Frees as many buffers from the pool as possible. - Parameter agedOutOnly: Only free backings that are waiting to be aged out. If false, all unused backings are flushed regardless of age.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CVMutablePixelBuffer.Pool.makeMutablePixelBuffer(_:)

The iOS SDK compiler rejected this binding: instance method 'out' requires that 'CVMutablePixelBuffer' be a class type

All CoreVideo types →