FingerImage.toBufferObject Method

Module: FingerImage

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 all other formats, the value is ignored.

to_buffer_object(self, finger_image_format: ImageFormat, compression_level: float, buffer: ImageBuffer) -> None

Parameters

finger_image_format ImageFormat
in The output image format.

compression_level float
in The compression level to be applied.

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
void toBufferObject(ImageFormat fingerImageFormat, double compressionLevel, ImageBuffer buffer)

Parameters

fingerImageFormat 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

FingerException
An error has occurred during Finger Library execution.
public void ToBufferObject(ImageFormat fingerImageFormat, float compressionLevel, ImageBuffer buffer)

Parameters

fingerImageFormat ImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
public void toBufferObject(ImageFormat fingerImageFormat, float compressionLevel, ImageBuffer buffer) throws FingerException

Parameters

fingerImageFormat ImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
public func toBufferObject(fingerImageFormat: ImageFormat, compressionLevel: Float, buffer: ImageBuffer) throws

Parameters

fingerImageFormat ImageFormat
in The output image format.

compressionLevel Float
in The compression level to be applied.

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

Exceptions

FingerException
An error has occurred during Finger Library execution.
int id3FingerImage_ToBufferObject (
    ID3_FINGER_IMAGE hFingerImage,
    id3FingerImageFormat eFingerImageFormat,
    float compressionLevel,
    ID3_FINGER_IMAGE_BUFFER hBuffer)

Parameters

hFingerImage ID3_FINGER_IMAGE
in Handle to the FingerImage object.

eFingerImageFormat id3FingerImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

hBuffer ID3_FINGER_IMAGE_BUFFER
in The image buffer that receives the image data.

Returns

int
An error code.
See id3FingerError file for the list of possible error codes.