Converts a PlanarF image to a Planar8 image, clipping values to the provided minimum and maximum values.


func vImageConvert_PlanarFtoPlanar8(_ src: UnsafePointer<vImage_Buffer>, _ dest: UnsafePointer<vImage_Buffer>, _ maxFloat: Pixel_F, _ minFloat: Pixel_F, _ flags: vImage_Flags) -> vImage_Error



A pointer to a vImage buffer structure that contains the source image whose data you want to convert.


A pointer to a vImage buffer data structure. You're responsible for filling out the height, width, and rowBytes fields of this structure, and for allocating a data buffer of the appropriate size. On return, the data buffer this structure points to contains the destination image data. When you no longer need the data buffer, you must deallocate the memory.


A maximum pixel value. The function clips larger values to this value in the destination image.


A minimum pixel value. The function clips smaller values to this value in the destination image.


The options to use when performing the operation. If you plan to perform your own tiling or use multithreading, pass kvImageDoNotTile.

Return Value

kvImageNoError; otherwise, one of the error codes described in Data Types and Constants.


The minimum and maximum value determine the mapping of intensity values to the destination image. The mapping is:

    if oldPixel < minFloat
    newPixel = 0
    if minfloat <= oldPixel <= maxFloat
    newPixel = (oldPixel - minFloat) * 255.0f / (maxFloat - minFloat)
    if oldPixel > maxFloat
    newPixel = 255

The source and destination buffers must have the same height and width.

See Also

Converting Between Planar Formats