CoreVideo · IOS API REFERENCE

CVPixelBufferCreationAttributes

struct · iOS 26.0+ · SDK 27.1

struct CVPixelBufferCreationAttributes

Attributes needed for creating a pixel buffer.

Members (19)

get · iOS 27.0+

attachments

TypeScript

get attachments(): (CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>) | null

Swift declaration

var attachments: CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>?

Attachments to set on the pixel buffer.

set · iOS 27.0+

attachments

TypeScript

set attachments(value: (CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>) | null)

Swift declaration

var attachments: CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>?

Attachments to set on the pixel buffer.

get · iOS 26.0+

compatibility

TypeScript

get compatibility(): CVPixelFormatDescription_Compatibility

Swift declaration

var compatibility: CVPixelFormatDescription.Compatibility

Defines interoperability of pixel buffers with other frameworks

set · iOS 26.0+

compatibility

TypeScript

set compatibility(value: CVPixelFormatDescription_Compatibility)

Swift declaration

var compatibility: CVPixelFormatDescription.Compatibility

Defines interoperability of pixel buffers with other frameworks

get · iOS 26.0+

extendedPixels

TypeScript

get extendedPixels(): (CVPixelBufferPadding) | null

Swift declaration

var extendedPixels: CVPixelBufferPadding?

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

set · iOS 26.0+

extendedPixels

TypeScript

set extendedPixels(value: (CVPixelBufferPadding) | null)

Swift declaration

var extendedPixels: CVPixelBufferPadding?

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

get · iOS 26.0+

planeAlignment

TypeScript

get planeAlignment(): (number) | null

Swift declaration

var planeAlignment: Int?

Planes start on a byte number that’s a multiple of this value.

set · iOS 26.0+

planeAlignment

TypeScript

set planeAlignment(value: (number) | null)

Swift declaration

var planeAlignment: Int?

Planes start on a byte number that’s a multiple of this value.

init · iOS 27.0+

init

TypeScript

static initPixelFormatTypeSizeCompatibilityBytesPerRowAlignmentPlaneAlignmentExtendedPixelsAttachments(pixelFormatType: CVPixelFormatType, size: CVImageSize, compatibility?: CVPixelFormatDescription_Compatibility, bytesPerRowAlignment?: (number) | null, planeAlignment?: (number) | null, extendedPixels?: (CVPixelBufferPadding) | null, attachments?: (CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>) | null): CVPixelBufferCreationAttributes

Swift declaration

init(pixelFormatType: CVPixelFormatType, size: CVImageSize, compatibility: CVPixelFormatDescription.Compatibility = [], bytesPerRowAlignment: Int? = nil, planeAlignment: Int? = nil, extendedPixels: CVPixelBufferPadding? = nil, attachments: CVAttachmentContainer<CVPixelBufferAttachmentKeyDefinitions>? = nil)

init · iOS 26.0+

init

TypeScript

static initPixelFormatTypeSizeCompatibilityBytesPerRowAlignmentPlaneAlignmentExtendedPixels(pixelFormatType: CVPixelFormatType, size: CVImageSize, compatibility?: CVPixelFormatDescription_Compatibility, bytesPerRowAlignment?: (number) | null, planeAlignment?: (number) | null, extendedPixels?: (CVPixelBufferPadding) | null): CVPixelBufferCreationAttributes

Swift declaration

init(pixelFormatType: CVPixelFormatType, size: CVImageSize, compatibility: CVPixelFormatDescription.Compatibility = [], bytesPerRowAlignment: Int? = nil, planeAlignment: Int? = nil, extendedPixels: CVPixelBufferPadding? = nil)

get · iOS 26.0+

pixelFormatType

TypeScript

get pixelFormatType(): CVPixelFormatType

Swift declaration

var pixelFormatType: CVPixelFormatType

Format of the pixel buffer bytes

set · iOS 26.0+

pixelFormatType

TypeScript

set pixelFormatType(value: CVPixelFormatType)

Swift declaration

var pixelFormatType: CVPixelFormatType

Format of the pixel buffer bytes

get · iOS 26.0+

bytesPerRowAlignment

TypeScript

get bytesPerRowAlignment(): (number) | null

Swift declaration

var bytesPerRowAlignment: Int?

The number of bytes per row in the pixel buffer must be a multiple of this number.

set · iOS 26.0+

bytesPerRowAlignment

TypeScript

set bytesPerRowAlignment(value: (number) | null)

Swift declaration

var bytesPerRowAlignment: Int?

The number of bytes per row in the pixel buffer must be a multiple of this number.

get · iOS 26.0+

size

TypeScript

get size(): CVImageSize

Swift declaration

var size: CVImageSize

Size of the buffer in pixels

set · iOS 26.0+

size

TypeScript

set size(value: CVImageSize)

Swift declaration

var size: CVImageSize

Size of the buffer in pixels

get · iOS 26.0+

backing

TypeScript

get backing(): CVPixelBufferCreationAttributes_Backing

Swift declaration

var backing: CVPixelBufferCreationAttributes.Backing

Defines how the memory for the pixel buffer backing is allocated. IOSurface backed pixel buffers can be shared between CPU and GPU also across process boundaries. Defaults to ``Backing.ioSurface``.

set · iOS 26.0+

backing

TypeScript

set backing(value: CVPixelBufferCreationAttributes_Backing)

Swift declaration

var backing: CVPixelBufferCreationAttributes.Backing

Defines how the memory for the pixel buffer backing is allocated. IOSurface backed pixel buffers can be shared between CPU and GPU also across process boundaries. Defaults to ``Backing.ioSurface``.

init · iOS 26.0+

init

TypeScript

static init(attributes: CVPixelBufferAttributes): (CVPixelBufferCreationAttributes) | null

Swift declaration

init?(_ attributes: CVPixelBufferAttributes)

Convert Attributes to CreationAttributes. This init will fail if ``pixelFormatType`` or ``size`` properties are absent.

Skipped declarations

No declarations were skipped in this snapshot.

All CoreVideo types →