Exports to other skinkit files from skinkit.c. More...

#include "skinkit.h"
#include "rasthand.h"
#include "monevent.h"

Functions
int32	KGetConfigAvailable (void)
	This method is called from the RIP thread by the config device to determine how much config data, if any is available. This data would then be obtained by the RIP via KGetConfigData(). More...

void *	KGetConfigJobContext (void)
	Method called from the RIP thread by the config device to get the opaque job context pointer supplied by the user to SwLeJobStart(). More...

HqBool	KGetConfigJobFailed (sw_mon_type monuid, const char *detail)
	Method called from the RIP thread by the config device to get the error status of a job for ending a RIP timeline. More...

HqBool	KGetConfigData (int32 cbMax, uint8 *ppData, uint32 pcbData)
	This method is called from the RIP thread by the config device when it is ready for the config data for next job. Config data is provided by the app via SwLeJobStart(). More...

HqBool	KGetJobData (int32 cbMax, uint8 *ppData, uint32 pcbData)
	This method is called from the RIP thread by the monitor device when it is ready for data from the current job. This data is provided by the app via SwLePs(). More...

RASTER_result	KCallRasterStart (RasterDescription *rasterDescription)
	This function informs the raster callback implementation that raster data for is about to be written for a separation. More...

RASTER_result	KCallRasterWriteData (RasterDescription rasterDescription, uint8 pBuffer)
	This function hands a band of raster data generated from the current job page to the raster callback implementation, if any, that the application has registered. More...

RASTER_result	KCallRasterFinish (RasterDescription *rasterDescription, HqBool ok)
	This function informs the raster callback implementation that raster data for a separation is complete. More...

void	KCallRasterJobEnd (RasterDescription *rasterDescription)
	This function informs the raster callback implementation that raster data for a job is complete. More...

RASTER_result	KCallRasterBandSize (RASTER_BANDSIZE *pBandSize)
	A callback function which allows the skin to affect the band size calculation. More...

RASTER_result	KCallRasterRequirements (RASTER_REQUIREMENTS pRasterRequirements, RasterDescription rasterDescription)
	A callback function which gives the skin the details of the raster it is about to be handed, and gives the skin an opportunity to allocate memory to contain it. More...

RASTER_result	KCallRasterDestination (RASTER_DESTINATION *pRasterDestination, int32 separationIndex)
	A callback function which asks the skin to provide a memory address range into which to render. More...

RASTER_result	KCallBlankPage (RASTER_BLANK pBlank, RasterDescription rasterDescription)
	This function tells the raster backend implementation that a page is blank, and allows it to determine how to handle the page. More...

void	KSwLeStop (void)
	Called as part of the RIP's exit procedure. More...

void	SkinExit (int32 n, uint8 *text)
	Called when the RIP exits. More...

void	SkinReboot (void)
	Called when RIP reboots. More...

Detailed Description

Exports to other skinkit files from skinkit.c.

Function Documentation

◆ KCallBlankPage()

RASTER_result KCallBlankPage	(	RASTER_BLANK *	pBlank,
		RasterDescription *	rasterDescription
	)

This function tells the raster backend implementation that a page is blank, and allows it to determine how to handle the page.

The RASTER_BLANK::action field indicates on entry the default action that will be taken if there is no error. This action may be changed by the callee.

Parameters

[in,out]	pBlank	Structure providing the reason for the blank page call, and the action to take for the blank page. This is initialised to contain the default action for the reason for the blank page call. The handler may just set RASTER_BLANK::handled to TRUE and return if it wants to use the default action.
	rasterDescription	Description of the blank page. If called because all separations were omitted, there will be no colorants in the raster description.

Returns: RASTER_noErr (0) or a positive value less than MON_CLASS_ERROR if successful; one of the negative RASTER_RESULT codes or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type, and UID for an error. If there was no error, but the value of the RASTER_BLANK::handled field return value is FALSE, the function will be called again until it sets the field to TRUE or an error is reported.

◆ KCallRasterBandSize()

RASTER_result KCallRasterBandSize ( RASTER_BANDSIZE * pBandSize )

A callback function which allows the skin to affect the band size calculation.

Parameters

[in,out] pBandSize Structure providing details of the raster stride (byte offset between the start address of successive * raster lines), and some parameters for the skin to indicate to the RIP whether to limit band size and whether to allocate dynamic bands for asynchronous processing.

Returns: RASTER_noErr (0) or a positive value less than MON_CLASS_ERROR if successful; one of the negative RASTER_RESULT codes or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type, and UID for an error. If there was no error, but the value of the RASTER_BANDSIZE::handled field return value is FALSE, the function will be called again until it sets the field to TRUE or an error is reported.

◆ KCallRasterDestination()

RASTER_result KCallRasterDestination	(	RASTER_DESTINATION *	pRasterDestination,
		int32	separationIndex
	)

A callback function which asks the skin to provide a memory address range into which to render.

Parameters

pRasterDestination	Structure providing the band number the RIP is about to render, and pointers to the memory range that the RIP should use.
separationIndex	The separation index.

Returns: RASTER_noErr (0) or a positive value less than MON_CLASS_ERROR if successful; one of the negative RASTER_RESULT codes or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type, and UID for an error. If there was no error, but the value of the RASTER_DESTINATION::handled field return value is FALSE, the function will be called again until it sets the field to TRUE or an error is reported.

◆ KCallRasterFinish()

RASTER_result KCallRasterFinish	(	RasterDescription *	rasterDescription,
		HqBool	ok
	)

This function informs the raster callback implementation that raster data for a separation is complete.

Parameters

[in]	rasterDescription	Description of the raster data.
[in]	ok	A boolean indicating whether the rendering and delivery of the separation proceeded normally (TRUE) or whether an error occurred during rendering or delivery of data (FALSE).

Returns: RASTER_noErr if this function was called in sequence, and either no raster callback was registered or a registered raster callback succeeded. Otherwise, one of the RASTER_RESULT error codes or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type and UID.

◆ KCallRasterJobEnd()

void KCallRasterJobEnd ( RasterDescription * rasterDescription )

This function informs the raster callback implementation that raster data for a job is complete.

Parameters

[in] rasterDescription Description of the raster data.

◆ KCallRasterRequirements()

RASTER_result KCallRasterRequirements	(	RASTER_REQUIREMENTS *	pRasterRequirements,
		RasterDescription *	rasterDescription
	)

A callback function which gives the skin the details of the raster it is about to be handed, and gives the skin an opportunity to allocate memory to contain it.

Parameters

pRasterRequirements	Structure providing details of the raster which the RIP will be providing, and some parameters for the skin to indicate to the RIP how it will proceed.
rasterDescription	A pointer to a description of the raster data. This will be NULL when this function is being called as a result of a change to the page device which means a difference in the raster structure. It will be non-NULL when no further such changes are possible and rendering is beginning very soon, and will contain the finalised description of the raster data.

Returns: RASTER_noErr (0) or a positive value less than MON_CLASS_ERROR if successful; one of the negative RASTER_RESULT codes or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type, and UID for an error. If there was no error, but the value of the RASTER_REQUIREMENTS::handled field return value is FALSE, the function will be called again until it sets the field to TRUE or an error is reported.

◆ KCallRasterStart()

RASTER_result KCallRasterStart ( RasterDescription * rasterDescription )

This function informs the raster callback implementation that raster data for is about to be written for a separation.

Parameters

[in] rasterDescription Description of the raster data.

Returns: RASTER_noErr if this function was called in sequence, and either no raster callback was registered or a registered raster callback succeeded. Otherwise, one of the RASTER_RESULT error codes, or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type and UID.

◆ KCallRasterWriteData()

RASTER_result KCallRasterWriteData	(	RasterDescription *	rasterDescription,
		uint8 *	pBuffer
	)

This function hands a band of raster data generated from the current job page to the raster callback implementation, if any, that the application has registered.

Parameters

[in]	rasterDescription	Description of the raster data.
[in]	pBuffer	The raster data itself.

Returns: RASTER_noErr if this function was called in sequence, and either no raster callback was registered or a registered raster callback succeeded. Otherwise, one of the RASTER_RESULT error codes, or a sw_mon_type error code greater than MON_CLASS_ERROR with a valid subclass, PS error type and UID.

◆ KGetConfigAvailable()

int32 KGetConfigAvailable ( void )

This method is called from the RIP thread by the config device to determine how much config data, if any is available. This data would then be obtained by the RIP via KGetConfigData().

Returns: The number of bytes of config data available, or -1 if a protocol error occurs.

◆ KGetConfigData()

HqBool KGetConfigData	(	int32	cbMax,
		uint8 **	ppData,
		uint32 *	pcbData
	)

This method is called from the RIP thread by the config device when it is ready for the config data for next job. Config data is provided by the app via SwLeJobStart().

Parameters

cbMax	The maximum amount of data which should be provided
ppData	Where to copy the data to
pcbData	The actual amount of data copied

Returns: TRUE if some data was provided, and FALSE otherwise.

◆ KGetConfigJobContext()

void* KGetConfigJobContext ( void )

Method called from the RIP thread by the config device to get the opaque job context pointer supplied by the user to SwLeJobStart().

The opaque job context pointer is attached to the SWTLT_SKIN_JOB timeline as its primary context, to give skin modules the ability to correlate jobs and manipulate job-specific data.

Returns: The job context pointer set by the most recent SwLeJobStart() call.

◆ KGetConfigJobFailed()

HqBool KGetConfigJobFailed	(	sw_mon_type *	monuid,
		const char **	detail
	)

Method called from the RIP thread by the config device to get the error status of a job for ending a RIP timeline.

Parameters

[out]	monuid	If an error caused the job to fail, its UID.
[out]	detail	If an error caused the job to fail, a reason.

The reason string must be copied by the caller if it wishes to preserve it.

Return values

TRUE	The most recent job submitted by SwLeJobStart() failed.
FALSE	The most recent job submitted by SwLeJobStart() succeeded.

◆ KGetJobData()

HqBool KGetJobData	(	int32	cbMax,
		uint8 **	ppData,
		uint32 *	pcbData
	)

This method is called from the RIP thread by the monitor device when it is ready for data from the current job. This data is provided by the app via SwLePs().

Parameters

cbMax	The maximum amount of data which should be provided
ppData	Where to copy the data to
pcbData	The actual amount of data copied

Returns: TRUE if some data was provided, and FALSE otherwise.

◆ KSwLeStop()

void KSwLeStop ( void )

Called as part of the RIP's exit procedure.

This function releases any remaining resources allocated during RIP initialization.

◆ SkinExit()

void SkinExit	(	int32	n,
		uint8 *	text
	)

Called when the RIP exits.

Parameters

n	The exit code
text	Reason for exit

This function is called by the RIP when it exits. It is responsible for calling the function registered by SwLeSetRipExitFunction().

◆ SkinReboot()

void SkinReboot ( void )

Called when RIP reboots.

This function is called by the RIP when it reboots. It is responsible for calling the function registered by SwLeSetRipRebootFunction().

Functions

Detailed Description

Function Documentation

◆ KCallBlankPage()

◆ KCallRasterBandSize()

◆ KCallRasterDestination()

◆ KCallRasterFinish()

◆ KCallRasterJobEnd()

◆ KCallRasterRequirements()

◆ KCallRasterStart()

◆ KCallRasterWriteData()

◆ KGetConfigAvailable()

◆ KGetConfigData()

◆ KGetConfigJobContext()

◆ KGetConfigJobFailed()

◆ KGetJobData()

◆ KSwLeStop()

◆ SkinExit()

◆ SkinReboot()