Harlequin RIP SDK
sw_libjpeg_api_20201226 Struct Reference

The LibJPEG API version 20201226. More...

#include "libjpegapi.h"

Data Fields

struct jpeg_error_mgr *(* jpeg_std_error )(struct jpeg_error_mgr *err)
 Initialize a default error manager. More...
 
void(* jpeg_CreateDecompress )(j_decompress_ptr cinfo, int version, size_t structsize)
 Create a LibJPEG decompression context. More...
 
int(* jpeg_read_header )(j_decompress_ptr cinfo, boolean require_image)
 Read a LibJPEG decompression context. More...
 
boolean(* jpeg_start_decompress )(j_decompress_ptr cinfo)
 Start decompression with LibJPEG, freeing working memory. More...
 
JDIMENSION(* jpeg_read_scanlines )(j_decompress_ptr cinfo, JSAMPARRAY scanlines, JDIMENSION max_lines)
 Decompress a number of scanlines. More...
 
boolean(* jpeg_finish_decompress )(j_decompress_ptr cinfo)
 Finish decompression with LibJPEG, freeing working memory. More...
 
void(* jpeg_destroy_decompress )(j_decompress_ptr cinfo)
 Destroy a LibJPEG decompression context, freeing all memory allocations. More...
 
void(* jpeg_CreateCompress )(j_compress_ptr cinfo, int version, size_t structsize)
 Create a LibJPEG compression context. More...
 
void(* jpeg_set_defaults )(j_compress_ptr cinfo)
 Set the default values of optional LibJPEG compression parameters. More...
 
void(* jpeg_set_quality )(j_compress_ptr cinfo, int quality, boolean force_baseline)
 Set the quality for LibJPEG compression parameters. More...
 
void(* jpeg_start_compress )(j_compress_ptr cinfo, boolean write_all_tables)
 Start compression with LibJPEG. More...
 
JDIMENSION(* jpeg_write_scanlines )(j_compress_ptr cinfo, JSAMPARRAY scanlines, JDIMENSION num_lines)
 compress a number of scanlines. More...
 
void(* jpeg_finish_compress )(j_compress_ptr cinfo)
 Finish compression with LibJPEG, freeing working memory. More...
 
void(* jpeg_destroy_compress )(j_compress_ptr cinfo)
 Destroy a LibJPEG compression context, freeing all memory allocations. More...
 

Detailed Description

The LibJPEG API version 20201226.

Field Documentation

◆ jpeg_CreateCompress

void(* sw_libjpeg_api_20201226::jpeg_CreateCompress) (j_compress_ptr cinfo, int version, size_t structsize)

Create a LibJPEG compression context.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context to initialize. On entry, the err and client_data fields should be initialized. All other fields are reset.
[in]versionThe LibJPEG version number.
[in]structsizeThe size of the structure pointed to by cinfo.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_CreateDecompress

void(* sw_libjpeg_api_20201226::jpeg_CreateDecompress) (j_decompress_ptr cinfo, int version, size_t structsize)

Create a LibJPEG decompression context.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context to initialize. On entry, the err and client_data fields should be initialized. All other fields are reset.
[in]versionThe LibJPEG version number.
[in]structsizeThe size of the structure pointed to by cinfo.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_destroy_compress

void(* sw_libjpeg_api_20201226::jpeg_destroy_compress) (j_compress_ptr cinfo)

Destroy a LibJPEG compression context, freeing all memory allocations.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context to destroy.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_destroy_decompress

void(* sw_libjpeg_api_20201226::jpeg_destroy_decompress) (j_decompress_ptr cinfo)

Destroy a LibJPEG decompression context, freeing all memory allocations.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context to destroy.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_finish_compress

void(* sw_libjpeg_api_20201226::jpeg_finish_compress) (j_compress_ptr cinfo)

Finish compression with LibJPEG, freeing working memory.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_finish_decompress

boolean(* sw_libjpeg_api_20201226::jpeg_finish_decompress) (j_decompress_ptr cinfo)

Finish decompression with LibJPEG, freeing working memory.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context.
Returns
Only relevant for decompression suspension. See the full LibJPEG documentation for details.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_read_header

int(* sw_libjpeg_api_20201226::jpeg_read_header) (j_decompress_ptr cinfo, boolean require_image)

Read a LibJPEG decompression context.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context to initialize. On entry, the err and client_data fields should be initialized. All other fields are reset.
[in]versionThe LibJPEG version number.
[in]structsizeThe size of the structure pointed to by cinfo.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_read_scanlines

JDIMENSION(* sw_libjpeg_api_20201226::jpeg_read_scanlines) (j_decompress_ptr cinfo, JSAMPARRAY scanlines, JDIMENSION max_lines)

Decompress a number of scanlines.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context.
[out]scanlinesA pointer to a buffer to store decompressed scanline data in.
[in]max_linesThe maximum number of lines to read.
Returns
The number of scanlines read.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_set_defaults

void(* sw_libjpeg_api_20201226::jpeg_set_defaults) (j_compress_ptr cinfo)

Set the default values of optional LibJPEG compression parameters.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_set_quality

void(* sw_libjpeg_api_20201226::jpeg_set_quality) (j_compress_ptr cinfo, int quality, boolean force_baseline)

Set the quality for LibJPEG compression parameters.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context.
[in]qualityA quality value from 0-100.
[in]force_baselineIf TRUE, the the quantization table entries are constrained to the range 1-255 for full JPEG baseline compatibility.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_start_compress

void(* sw_libjpeg_api_20201226::jpeg_start_compress) (j_compress_ptr cinfo, boolean write_all_tables)

Start compression with LibJPEG.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context.
[in]write_all_tablesNormally TRUE to write a complete JPEG interchange datastream.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_start_decompress

boolean(* sw_libjpeg_api_20201226::jpeg_start_decompress) (j_decompress_ptr cinfo)

Start decompression with LibJPEG, freeing working memory.

Parameters
[in,out]cinfoA pointer to a struct jpeg_decompress_struct context.
Returns
Only relevant for decompression suspension. See the full LibJPEG documentation for details.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_std_error

struct jpeg_error_mgr*(* sw_libjpeg_api_20201226::jpeg_std_error) (struct jpeg_error_mgr *err)

Initialize a default error manager.

JPEG compression and decompression contexts must have the err field set to point to an error manager structure on initialization. The default error manager outputs messages to standard output or standard error, and will exit the process in case of an unrecoverable JPEG error. This is probably not what you want, but you may wish to initialize and error manager with it and then override methods.

Parameters
[out]errThe error manager structure to initialize.
Returns
The error structure passed in as err.

See the jpeglib.h header file and libjpeg.txt file for more information.

◆ jpeg_write_scanlines

JDIMENSION(* sw_libjpeg_api_20201226::jpeg_write_scanlines) (j_compress_ptr cinfo, JSAMPARRAY scanlines, JDIMENSION num_lines)

compress a number of scanlines.

Parameters
[in,out]cinfoA pointer to a struct jpeg_compress_struct context.
[out]scanlinesA pointer to a buffer containing uncompressed scanline to write.
[in]num_linesThe maximum number of lines to write.
Returns
The number of scanlines written.

See the jpeglib.h header file and libjpeg.txt file for more information.


The documentation for this struct was generated from the following file: