Function

vImageConvert_Planar1toPlanar8

Converts a Planar1 image to a Planar8 image.

Declaration

vImage_Error vImageConvert_Planar1toPlanar8(const vImage_Buffer *src, const vImage_Buffer *dest, const vImage_Flags flags);

Parameters

src

A pointer to the source vImage buffer object. Because the source pixel format is smaller than a byte, there are multiple pixels in each byte of the data buffer. These pixels are interpreted as being in big endian order (that is, the low-indexed pixel is in the high-order bits of the byte).

Sub-byte indexing of scanlines is unsupported, because the data and rowBytes fields of the buffer are specified in whole bytes.

Widths, however, are measured in pixels, so a scanline may end in the middle of a byte. If this occurs, the contents of any unused bits of the final byte are ignored.

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.

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

For each pixel in the destination image, the resulting value is the corresponding pixel value from the source image multiplied by 255.

See Also

Converting Between Planar Formats

vImageConvert_PlanarFtoPlanar8_dithered

Converts a PlanarF image to a Planar8 image with dithering.

vImageConvert_PlanarFtoPlanar16F

Converts a PlanarF image to a Planar16F image.

vImageConvert_PlanarFtoPlanar8

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

vImageConvert_Planar2toPlanar8

Converts a Planar2 image to a Planar8 image.

vImageConvert_Planar4toPlanar8

Converts a Planar4 image to a Planar8 image.

vImageConvert_Planar8toPlanarF

Converts a Planar8 image to a PlanarF image.

vImageConvert_Planar8toPlanar16F

Converts a Planar8 image to a Planar16F image.

vImageConvert_Planar8toPlanar1

Converts a Planar8 image to a Planar1 image.

vImageConvert_Planar8toPlanar2

Converts a Planar8 image to a Planar2 image.

vImageConvert_Planar8toPlanar4

Converts a Planar8 image to a Planar4 image.

vImageConvert_Planar16FtoPlanar8

Converts a Planar16F image to a Planar8 image.

vImageConvert_Planar16FtoPlanarF

Separates an ARGB8888 image into four Planar8 images.

vImageConvert_Planar16UtoPlanar8_dithered

Converts a Planar16U image to a Planar8 image with dithering.

vImageConvert_Indexed1toPlanar8

Converts an indexed 1-bit image to a Planar8 image.

vImageConvert_Indexed2toPlanar8

Converts an indexed 2-bit image to a Planar8 image.

vImageConvert_Indexed4toPlanar8

Converts an indexed 4-bit image to a Planar8 image.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software