<!--
{
  "documentType" : "article",
  "framework" : "Accelerate",
  "identifier" : "/documentation/Accelerate/1578972-error-codes",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Error codes"
}
-->

# Error codes

Error codes that vImage functions return when an operation fails.

## Topics

### Constants

[`enum Error`](/documentation/Accelerate/vImage/Error)

An error that occurs during a vImage operation.

[`var kvImageNoError: Int`](/documentation/Accelerate/kvImageNoError)

The vImage function completed without error.

[`var kvImageRoiLargerThanInputBuffer: Int`](/documentation/Accelerate/kvImageRoiLargerThanInputBuffer)

The region of interest, as specified by the `srcOffsetToROI_X` and `srcOffsetToROI_Y` parameters and the height and width of the destination buffer, extends beyond the bottom edge or right edge of the source buffer.

[`var kvImageInvalidKernelSize: Int`](/documentation/Accelerate/kvImageInvalidKernelSize)

Either the kernel height, the kernel width, or both, are even.

[`var kvImageInvalidEdgeStyle: Int`](/documentation/Accelerate/kvImageInvalidEdgeStyle)

The edge style specified is invalid.

[`var kvImageInvalidOffset_X: Int`](/documentation/Accelerate/kvImageInvalidOffset_X)

The `srcOffsetToROI_X` parameter that specifies the left edge of the region of interest is greater than the width of the source image.

[`var kvImageInvalidOffset_Y: Int`](/documentation/Accelerate/kvImageInvalidOffset_Y)

The `srcOffsetToROI_Y` parameter that specifies the top edge of the region of interest is greater than the height of the source image.

[`var kvImageMemoryAllocationError: Int`](/documentation/Accelerate/kvImageMemoryAllocationError)

An attempt to allocate memory failed.

[`var kvImageNullPointerArgument: Int`](/documentation/Accelerate/kvImageNullPointerArgument)

A pointer parameter is `NULL` and it must not be.

[`var kvImageInvalidParameter: Int`](/documentation/Accelerate/kvImageInvalidParameter)

Invalid parameter.

[`var kvImageBufferSizeMismatch: Int`](/documentation/Accelerate/kvImageBufferSizeMismatch)

The function requires the source and destination buffers to have the same height and the same width, but they do not.

[`var kvImageUnknownFlagsBit: Int`](/documentation/Accelerate/kvImageUnknownFlagsBit)

The flag is not recognized.

[`var kvImageColorSyncIsAbsent: Int`](/documentation/Accelerate/kvImageColorSyncIsAbsent)

[`var kvImageCoreVideoIsAbsent: Int`](/documentation/Accelerate/kvImageCoreVideoIsAbsent)

[`var kvImageInternalError: Int`](/documentation/Accelerate/kvImageInternalError)

A serious error occured inside vImage, which prevented vImage from continuing.

[`var kvImageInvalidCVImageFormat: Int`](/documentation/Accelerate/kvImageInvalidCVImageFormat)

[`var kvImageInvalidImageFormat: Int`](/documentation/Accelerate/kvImageInvalidImageFormat)

[`var kvImageInvalidImageObject: Int`](/documentation/Accelerate/kvImageInvalidImageObject)

[`var kvImageInvalidRowBytes: Int`](/documentation/Accelerate/kvImageInvalidRowBytes)

[`var kvImageOutOfPlaceOperationRequired: Int`](/documentation/Accelerate/kvImageOutOfPlaceOperationRequired)

[`var kvImageUnsupportedConversion: Int`](/documentation/Accelerate/kvImageUnsupportedConversion)

Some lower level conversion APIs only support conversion among a sparse matrix of image formats.

### Core Video Image Format Errors

[`var kvImageCVImageFormat_NoError: Int`](/documentation/Accelerate/kvImageCVImageFormat_NoError)

An error code that indicates the conversion completed without error.

[`var kvImageCVImageFormat_ColorSpace: Int`](/documentation/Accelerate/kvImageCVImageFormat_ColorSpace)

An error code that indicates the image’s color space is missing.

[`var kvImageCVImageFormat_ChromaSiting: Int`](/documentation/Accelerate/kvImageCVImageFormat_ChromaSiting)

An error code that indicates the chroma siting information is absent.

[`var kvImageCVImageFormat_AlphaIsOneHint: Int`](/documentation/Accelerate/kvImageCVImageFormat_AlphaIsOneHint)

A hint that indicates the alpha channel is opaque.

[`var kvImageCVImageFormat_ConversionMatrix: Int`](/documentation/Accelerate/kvImageCVImageFormat_ConversionMatrix)

An error code that indicates the required conversion matrix is absent.

[`var kvImageCVImageFormat_VideoChannelDescription: Int`](/documentation/Accelerate/kvImageCVImageFormat_VideoChannelDescription)

An error code that indicates the range and clipping information is missing.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)