Function

vImageConvert_Planar8ToXRGBFFFF(_:_:_:_:_:_:_:_:)

Combines three Planar8 images into one XRGBFFFF image.

Declaration

func vImageConvert_Planar8ToXRGBFFFF(_ alpha: Pixel_F, _ red: UnsafePointer<vImage_Buffer>, _ green: UnsafePointer<vImage_Buffer>, _ blue: UnsafePointer<vImage_Buffer>, _ dest: UnsafePointer<vImage_Buffer>, _ maxFloat: UnsafePointer<Float>!, _ minFloat: UnsafePointer<Float>!, _ flags: vImage_Flags) -> vImage_Error

Parameters

alpha

A value to use for the alpha channel of the destination image.

red

A pointer to a vImage buffer structure that contains the Planar8 image to use as the red channel of the destination image.

green

A pointer to a vImage buffer structure that contains the Planar8 image to use as the green channel of the destination image.

blue

A pointer to a vImage buffer structure that contains the Planar8 image to use as the blue channel of the destination image.

dest

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.

maxFloat

A group of maximum pixel values, one per channel, in the same order as in the output pixels. The function clips larger values to these values in the destination image.

minFloat

A group of minimum pixel values, one per channel, in the same order as in the output pixels. The function clips smaller values to these values in the destination image.

flags

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.

Discussion

This routine cannot be used in place.

If the maxFloat value for a channel is less than the minFloat value, the output range for that channel is inverted.

To use a constant value for a single channel, set the maximum and minimum values for that channel to be the same value. When you do this, you must still provide a valid vImage_Buffer pointer for that channel, but the values in that buffer are unimportant.

See Also

Converting from Planar Formats

func vImageConvert_FTo16S(UnsafePointer<vImage_Buffer>, UnsafePointer<vImage_Buffer>, Float, Float, vImage_Flags) -> vImage_Error

Converts a PlanarF image into a special format in which each pixel is a 16-bit signed integer.

func vImageConvert_FTo16U(UnsafePointer<vImage_Buffer>, UnsafePointer<vImage_Buffer>, Float, Float, vImage_Flags) -> vImage_Error

Converts a PlanarF image into a special format in which each pixel is a 16-bit unsigned integer.