Enumeration

Result Codes

Describes the result codes generated by Core Video operations.

Declaration

enum : CVReturn {
    ...
};

Topics

Common

Result codes related to a number of Core Video operations.

kCVReturnAllocationFailed

Memory allocation for a buffer or buffer pool failed.

kCVReturnError

An otherwise undefined error occurred.

kCVReturnInvalidArgument

Invalid function parameter. For example, out of range or the wrong type.

kCVReturnSuccess

Indicates the operation completed successfully.

kCVReturnLast

Placeholder to mark the end of Core Video result codes (not returned by any functions).

kCVReturnFirst

Placeholder to mark the beginning of Core Video result codes (not returned by any functions).

Pixel Buffer

Result codes related to CVPixelBuffer operations.

kCVReturnInvalidPixelBufferAttributes

A buffer cannot be created with the specified attributes.

kCVReturnInvalidPixelFormat

The buffer does not support the specified pixel format.

kCVReturnInvalidSize

The buffer cannot support the requested buffer size (usually too big).

kCVReturnPixelBufferNotMetalCompatible

The pixel buffer is not compatible with Metal due to an unsupported buffer size, pixel format, or attribute.

kCVReturnPixelBufferNotOpenGLCompatible

The pixel buffer is not compatible with OpenGL due to an unsupported buffer size, pixel format, or attribute.

Buffer Pool

Result codes related to CVPixelBufferPool operations.

kCVReturnRetry

A scan hasn't completely traversed the CVBufferPool due to a concurrent operation.

kCVReturnInvalidPoolAttributes

A buffer pool cannot be created with the specified attributes.

kCVReturnPoolAllocationFailed

Allocation for a buffer pool failed, most likely due to a lack of resources. Check to make sure your parameters are in range.

kCVReturnWouldExceedAllocationThreshold

Allocation for a pixel buffer failed because the threshold value set for the kCVPixelBufferPoolAllocationThresholdKey key in the CVPixelBufferPoolCreatePixelBufferWithAuxAttributes function would be surpassed.

Display Link

Result codes related to CVDisplayLink operations.

kCVReturnInvalidDisplay

The display specified when creating a display link is invalid.

kCVReturnDisplayLinkAlreadyRunning

The specified display link is already running.

kCVReturnDisplayLinkNotRunning

The specified display link is not running.

kCVReturnDisplayLinkCallbacksNotSet

No callback registered for the specified display link. You must set either the output callback or both the render and display callbacks.

See Also

Core Video Error Constants

Data Types

Common data types used by the Core Video framework.