vImageConverter

sourceBuffers

sourceBuffers(colorSpace: _CoreGraphics_CGColorSpace): Array<(vImage_BufferType) | null>

func sourceBuffers(colorSpace: CGColorSpace) -> [vImage.BufferType?]

Returns an array of vImage source buffer types specifying the order of planes. - Parameter colorSpace: The color space of the source format.

sourceBufferCount

get sourceBufferCount(): number

var sourceBufferCount: Int { get }

The number of source buffers consumed by the converter.

destinationBuffers

destinationBuffers(colorSpace: _CoreGraphics_CGColorSpace): Array<(vImage_BufferType) | null>

func destinationBuffers(colorSpace: CGColorSpace) -> [vImage.BufferType?]

Returns an array of vImage source buffer types specifying the order of planes. - Parameter colorSpace: The color space of the destination format.

mustOperateOutOfPlace

mustOperateOutOfPlace(source: vImage_Buffer, destination: vImage_Buffer, options?: vImage_Options): boolean

func mustOperateOutOfPlace(source: vImage_Buffer, destination: vImage_Buffer, flags options: vImage.Options = .noFlags) throws -> Bool

Determines whether a converter is capable of operating in place. - Parameter source: The source buffer. - Parameter destination: The destination buffer. - Parameter options: The options to use when performing this operation. - Returns: `true` if the conversion must operate out of place or `false` if the operation will work in place.

destinationBufferCount

get destinationBufferCount(): number

var destinationBufferCount: Int { get }

The number of destination buffers written to by the converter.

makeCGToCVPixelBuffers

makeCGToCVPixelBuffers(lockedCVPixelBuffer: _CoreVideo_CVBuffer): Array<vImage_PixelBuffer<vImage_DynamicPixelFormat>>

func makeCGToCVPixelBuffers(referencing lockedCVPixelBuffer: CVPixelBuffer) throws -> [vImage.PixelBuffer<vImage.DynamicPixelFormat>]

Returns an array of pixel buffers in the right order to convert an image to a Core Video formatted image. - Parameter lockedCVPixelBuffer: The locked Core Video pixel buffer. Use `CVPixelBufferLockBaseAddress` and `CVPixelBufferUnlockBaseAddress` to lock and unlock the pixel buffer. - Note: The converter must be Core Graphics to Core Video. The buffers that this function returns share memory with the `CVPixelBuffer` and are only valid while the `CVPixelBuffer` is locked with `CVPixelBufferLockBaseAddress`.

makeCVToCGPixelBuffers

makeCVToCGPixelBuffers(lockedCVPixelBuffer: _CoreVideo_CVBuffer): Array<vImage_PixelBuffer<vImage_DynamicPixelFormat>>

func makeCVToCGPixelBuffers(referencing lockedCVPixelBuffer: CVPixelBuffer) throws -> [vImage.PixelBuffer<vImage.DynamicPixelFormat>]

Returns an array of pixel buffers in the right order to convert a Core Video formatted image to another image format. - Parameter lockedCVPixelBuffer: The locked Core Video pixel buffer. Use `CVPixelBufferLockBaseAddress` and `CVPixelBufferUnlockBaseAddress` to lock and unlock the pixel buffer. - Note: The converter must be Core Video to Core Graphics. The buffers that this function returns share memory with the `CVPixelBuffer` and are only valid while the `CVPixelBuffer` is locked with `CVPixelBufferLockBaseAddress`.

make

static makeSourceFormatDestinationFormatColorConversionInfo(sourceFormat: vImage_CGImageFormat, destinationFormat: vImage_CGImageFormat, colorConversionInfo: _CoreGraphics_CGColorConversionInfo): vImageConverter

static func make(sourceFormat: vImage_CGImageFormat, destinationFormat: vImage_CGImageFormat, colorConversionInfo: CGColorConversionInfo) throws -> vImageConverter

Creates an any-to-any converter that uses a color conversion information object to convert from one image format to another. - Parameter sourceFormat: A `vImage_CGImageFormat` structure that describes the image format of the source image. - Parameter destinationFormat: A `vImage_CGImageFormat` structure that describes the image format of the destination image. - Parameter colorConversionInfo: The object that describes how to convert between color spaces. - Parameter options: The options to use when performing this operation. - Returns: a vImage converter to convert from one vImage Core Graphics image format to another. - Important: The source and destination color spaces must have the same number of channels.

make

static makeSourceFormatDestinationFormatFlags(sourceFormat: vImageCVImageFormat, destinationFormat: vImage_CGImageFormat, options?: vImage_Options): vImageConverter

static func make(sourceFormat: vImageCVImageFormat, destinationFormat: vImage_CGImageFormat, flags options: vImage.Options = .noFlags) throws -> vImageConverter

Creates a vImage converter that converts a Core Video-formatted image to a Core Graphics-formatted image. - Parameter sourceFormat: A `vImageCVImageFormat` structure describing the image format of the source image - Parameter destinationFormat: A `vImage_CGImageFormat` structure describing the image format of the destination image - Parameter options: The options to use when performing this operation. - Returns: a vImage converter to convert a Core Video-formatted image to a Core Graphics-formatted image.

make

static makeSourceFormatDestinationFormatFlags86998(sourceFormat: vImage_CGImageFormat, destinationFormat: vImage_CGImageFormat, options?: vImage_Options): vImageConverter

static func make(sourceFormat: vImage_CGImageFormat, destinationFormat: vImage_CGImageFormat, flags options: vImage.Options = .noFlags) throws -> vImageConverter

Creates a vImage converter to convert from one vImage Core Graphics image format to another. - Parameter sourceFormat: A `vImage_CGImageFormat` structure describing the image format of the source image - Parameter destinationFormat: A `vImage_CGImageFormat` structure describing the image format of the destination image - Parameter options: The options to use when performing this operation. - Returns: a vImage converter to convert from one vImage Core Graphics image format to another.

make

static makeSourceFormatDestinationFormatFlags41767(sourceFormat: vImage_CGImageFormat, destinationFormat: vImageCVImageFormat, options?: vImage_Options): vImageConverter

static func make(sourceFormat: vImage_CGImageFormat, destinationFormat: vImageCVImageFormat, flags options: vImage.Options = .noFlags) throws -> vImageConverter

Creates a vImage converter that converts a Core Graphics-formatted image to a Core Video-formatted image. - Parameter sourceFormat: A `vImage_CGImageFormat` structure describing the image format of the source image - Parameter destinationFormat: A `vImageCVImageFormat` structure describing the image format of the destination image - Parameter options: The options to use when performing this operation. - Returns: a vImage converter to convert a Core Graphics-formatted image to a Core Video-formatted image.

convert

convert(source: vImage_Buffer, destination: vImage_Buffer, options?: vImage_Options): { $ret: null; $out: { "destination": vImage_Buffer } }

func convert(source: vImage_Buffer, destination: inout vImage_Buffer, flags options: vImage.Options = .noFlags) throws

Converts the pixels in a vImage buffer to another format. - Parameter source: The source buffer. - Parameter destination: The destination buffer. - Parameter options: The options to use when performing this operation. - Returns: `kvImageNoError`; otherwise, one of the error codes described in _Data Types and Constants.

Omit the output parameters from the call. The result contains $ret and $out, with destination inside $out.