swhtm.h File Reference

Header file defining the Halftone module interface. More...

#include <stddef.h>
#include <limits.h>
#include "ripcall.h"
#include "swapi.h"
#include "swmemapi.h"
#include "swdataapi.h"

Data Structures
struct	sw_htm_colorant_info
	Information about a colorant in a raster. More...
struct	sw_htm_raster_info
	Information about the destination raster. More...
struct	sw_htm_select_info
	Information passed to the screening module for sw_htm_api::HalftoneSelect(). More...
struct	sw_htm_render_info
	Render information passed to sw_htm_api::RenderInitiation() and sw_htm_api::DoHalftone(). More...
struct	sw_htm_dohalftone_request
	Structure describing what the RIP wants sw_htm_api::DoHalftone() to do. More...
struct	sw_htm_instance
	An instance structure for the modular halftone API implementation. More...
struct	sw_htm_init_params
	Collection structure for initialisation parameters. More...
struct	sw_htm_render_overrides
	Structure for parameters that may be overridden at sw_htm_api::RenderInitiationInstance. More...
struct	sw_htm_api
	The definition of an implementation of the modular halftoning interface. More...

Macros
#define	SW_HTM_DEFAULT_INDEX   UINT_MAX
	Denotes the halftone is being selected for /Default.
#define	SW_HTM_RASTER_UNIT_BITS   (64)
	The number of bits in each sw_htm_raster_unit.

Typedefs
typedef HqnResult	sw_htm_result
	Type of results returned by screening modules. More...
typedef struct sw_htm_api	sw_htm_api
	A type definition for an implementation of the modular halftone interface.
typedef int32	sw_htm_coord
	Raster coordinates, widths, heights etc.
typedef double	sw_htm_resolution
	Raster resolution, usually dots per inch, expressed as a floating-point value.
typedef void	sw_message_fn(const char *message)
	Type of the callback to output a message to the RIP's monitor device. More...
typedef int32	sw_htm_coloranttype
	Storage unit for colorant types.
typedef int32	sw_htm_colorant_handling
	Storage unit for colorant handling.
typedef struct sw_htm_colorant_info	sw_htm_colorant_info
	Information about a colorant in a raster.
typedef int32	sw_htm_raster_interleaving
	Storage unit for raster interleaving.
typedef int32	sw_htm_colorspace
	Storage unit for raster colorspace.
typedef struct sw_htm_raster_info	sw_htm_raster_info
	Information about the destination raster.
typedef struct sw_htm_select_info	sw_htm_select_info
	Information passed to the screening module for sw_htm_api::HalftoneSelect().
typedef int32	sw_htm_band_ordering
	Storage unit for band ordering.
typedef struct sw_htm_render_info	sw_htm_render_info
	Render information passed to sw_htm_api::RenderInitiation() and sw_htm_api::DoHalftone().
typedef uint64	sw_htm_raster_unit
	The unit of size used to access and point to rasters. More...
typedef sw_htm_raster_unit *	sw_htm_raster_ptr
	Type definition for a raster pointer.
typedef int32	sw_htm_mask_hint
	Storage unit for mask hints.
typedef struct sw_htm_dohalftone_request	sw_htm_dohalftone_request
	Structure describing what the RIP wants sw_htm_api::DoHalftone() to do.
typedef struct sw_htm_instance	sw_htm_instance
	An instance structure for the modular halftone API implementation. More...
typedef struct sw_htm_init_params	sw_htm_init_params
	Collection structure for initialisation parameters.
typedef struct sw_htm_render_overrides	sw_htm_render_overrides
	Structure for parameters that may be overridden at sw_htm_api::RenderInitiationInstance.

Enumerations
enum	sw_htm_api_version {   SW_HTM_API_VERSION_20070525 = 1 , SW_HTM_API_VERSION_20071110 , SW_HTM_API_VERSION_20100414 , SW_HTM_API_VERSION_20140227 ,   SW_HTM_API_VERSION_20151027 , SW_HTM_API_VERSION_20200220 }
	Version numbers defined for the HTM API. More...
enum	sw_htm_error {   SW_HTM_SUCCESS = HQN_RESULT_SUCCESS , SW_HTM_ERROR = 1 , SW_HTM_ERROR_IOERROR , SW_HTM_ERROR_LIMITCHECK ,   SW_HTM_ERROR_RANGECHECK , SW_HTM_ERROR_TYPECHECK , SW_HTM_ERROR_MEMORY , SW_HTM_ERROR_CONFIGURATIONERROR ,   SW_HTM_ERROR_VERSION , SW_HTM_ERROR_BAD_HINSTANCE , SW_HTM_ERROR_UNSUPPORTED_SRC_BIT_DEPTH , SW_HTM_ERROR_UNSUPPORTED_DST_BIT_DEPTH }
	Return values for screening modules. More...
enum	sw_htm_coloranttypes { SW_HTM_COLORANTTYPE_UNKNOWN = 0 , SW_HTM_COLORANTTYPE_PROCESS , SW_HTM_COLORANTTYPE_SPOT }
	Colorant types values. More...
enum	sw_htm_specialhandling { SW_HTM_SPECIALHANDLING_NONE = 0 , SW_HTM_SPECIALHANDLING_OPAQUE , SW_HTM_SPECIALHANDLING_OPAQUEIGNORE , SW_HTM_SPECIALHANDLING_TRANSPARENT }
	Values for special handling to apply to a colorant. More...
enum	sw_htm_raster_interleave { SW_HTM_RASTER_INTERLEAVE_BAND = 1 , SW_HTM_RASTER_INTERLEAVE_FRAME , SW_HTM_RASTER_INTERLEAVE_PIXEL }
	Raster interleaving styles values. More...
enum	sw_htm_colorspaces {   SW_HTM_COLORSPACE_UNKNOWN = 0 , SW_HTM_COLORSPACE_GRAY , SW_HTM_COLORSPACE_RGB , SW_HTM_COLORSPACE_CMY ,   SW_HTM_COLORSPACE_RGBK , SW_HTM_COLORSPACE_CMYK , SW_HTM_COLORSPACE_Lab , SW_HTM_COLORSPACE_N }
	Values for the fundamental color space of a raster. More...
enum	sw_htm_band_order { SW_HTM_BAND_ORDER_ANY = 0 , SW_HTM_BAND_ORDER_ASCENDING , SW_HTM_BAND_ORDER_DESCENDING }
	Band ordering constraints imposed by a screening module. More...
enum	sw_htm_maskhint { SW_HTM_MASKHINT_ALL_OFF = 0 , SW_HTM_MASKHINT_NORMAL , SW_HTM_MASKHINT_ALL_ON }
	Hints of the state of the mask bitmap, so as to permit optimisations when all bits are known to be set or no bits are set. More...

Functions
HqnResult	swhtm_result_translate (sw_htm_result result)
	Translate an HTM API-specific error code to a generic HqnResult error code. More...
sw_api_result	SwRegisterHTM (sw_htm_api *implementation)
	This routine makes a modular halftone implementation known to the RIP. More...

Detailed Description

Header file defining the Halftone module interface.

Copyright (C) 2023 Global Graphics Software Ltd. All rights reserved. This source code contains the confidential and trade secret information of Global Graphics Software Ltd. It may not be used, copied or distributed for any reason except as set forth in the applicable Global Graphics license agreement.