Harlequin RIP SDK
Barcode Generation API

The Barcode generation API is an RDR-discoverable interface that the core RIP calls to generate barcode data suitable for rendering. More...

Files

file  barcodeapi.h
 Header file defining the Barcode Generation API.
 
file  libbarcodezint.h
 Functions for registering and deregistering the libzint adapter for the Barcode Generation API.
 

Data Structures

struct  sw_barcode_data
 Structure representing the barcode to generate. More...
 
struct  sw_barcode_bitmap
 Structure representing the bitmap generated for a barcode. More...
 
struct  sw_barcode_error
 Structure for returning error information from barcode generation. More...
 
struct  sw_barcode_symbol
 Collected input and output data for barcode generation. More...
 
struct  sw_barcode_api_20170420
 

Macros

#define SW_BARCODE_OPTION_UNSET   0x7FFFFFFF
 

Typedefs

typedef struct sw_barcode_api_20170420 sw_barcode_api_20170420
 

Enumerations

enum  sw_barcode_type { SW_BARCODE_TYPE_UNSET = 0 , SW_BARCODE_TYPE_1D , SW_BARCODE_TYPE_2D }
 Barcode types. More...
 
enum  sw_barcode_color_encoding { SW_BARCODE_COLOR_UNSET = 0 , SW_BARCODE_COLOR_8BIT_RGB_MONO , SW_BARCODE_COLOR_8BIT_RGB , SW_BARCODE_COLOR_8BIT_CMYK }
 Barcode color encodings. More...
 

Detailed Description

The Barcode generation API is an RDR-discoverable interface that the core RIP calls to generate barcode data suitable for rendering.

The barcode API is used to generate barcode image data which can be displayed on a page via the PostScript barcode operator. This operator will call the methods sw_barcode_api_20170420::barcode_open(), sw_barcode_api_20170420::barcode_render() and then sw_barcode_api_20170420::barcode_close() for each barcode it has to render.

Note
This API is not complete or final. Only use documented and supported parameters of the PostScript barcode operator.

Macro Definition Documentation

◆ SW_BARCODE_OPTION_UNSET

#define SW_BARCODE_OPTION_UNSET   0x7FFFFFFF

The option has not been set at all.

Typedef Documentation

◆ sw_barcode_api_20170420

Barcode API structure.

Allow alternate barcode implementations to be registered via RDR, and then used instead of the HQN provided code.

Enumeration Type Documentation

◆ sw_barcode_color_encoding

Barcode color encodings.

Enumerator
SW_BARCODE_COLOR_UNSET 

Value has not been specified.

SW_BARCODE_COLOR_8BIT_RGB_MONO 

Only one currently supported. All RGB pixel values must be be 0xFFFFFF or 0x000000.

SW_BARCODE_COLOR_8BIT_RGB 

Not currently supported.

SW_BARCODE_COLOR_8BIT_CMYK 

Not currently supported.

◆ sw_barcode_type

Barcode types.

Enumerator
SW_BARCODE_TYPE_UNSET 

Value has not been specified.

SW_BARCODE_TYPE_1D 

Treat barcode as a 1D barcode.

SW_BARCODE_TYPE_2D 

Treat barcode as a 2D barcode.