CaptureImage.toBufferObject Method

Module: CaptureImage

Definition

Copies the image to a buffer in the specified format.

The compression level meaning depends on the algorithm used:

  • For JPEG compression, the value is the expected quality and may vary from 1 to 100.

  • For JPEG2000 compression, the value is the compression rate and may vary from 1 to 512.

  • For PNG compression, the value is the compression rate and may vary from 1 to 10.

  • For WEBP compression, the value is the expected quality and may vary from 1 to 100.

  • For all other formats, the value is ignored.

void toBufferObject(ImageFormat captureImageFormat, double compressionLevel, ImageBuffer buffer)

Parameters

captureImageFormat ImageFormat
in The output image format.

compressionLevel double
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DevicesException
An error has occurred during Devices Library execution.