Harlequin RIP SDK
SwLeDoParams Struct Reference

A structure containing the parameters for SwLeDo(). More...

#include "skinkit.h"

Data Fields

size_t size
 
size_t RIP_maxAddressSpaceInBytes
 
size_t RIP_workingSizeInBytes
 
size_t RIP_emergencySizeInBytes
 
void * RIP_memory
 
SysMemFnspSysMemFns
 
SwLeMONITORCALLBACKmonitor
 
HqBool fContinueAfterError
 
int exitvalue
 
int queuestate
 
HqBool fProcessQueueWait
 

Detailed Description

A structure containing the parameters for SwLeDo().

Field Documentation

◆ exitvalue

int SwLeDoParams::exitvalue

Exit value of the SDK or RIP process. This should be initialised to zero (EXIT_SUCCESS). SwLeDo() will refuse requests to continue processing jobs, or to re-initialise the RIP or SDK if this is non-zero, however it will perform shutdown actions as requested for the target state.

◆ fContinueAfterError

HqBool SwLeDoParams::fContinueAfterError

Should we continue processing more jobs after a job error?

◆ fProcessQueueWait

HqBool SwLeDoParams::fProcessQueueWait

Should SwLeDo() wait for more input after processing all jobs on the queue with SW_LE_DO_PROCESS_QUEUE, if there are persistent sources of input that might add more jobs to the queue?

◆ monitor

SwLeMONITORCALLBACK* SwLeDoParams::monitor

A pointer to a monitor callback function, passed to SwLeStart().

◆ pSysMemFns

SysMemFns* SwLeDoParams::pSysMemFns

A pointer to the system memory functions for non-MPS allocations, or NULL. This is passed to SwLeSDKStart().

◆ queuestate

int SwLeDoParams::queuestate

The state of the input queue after SW_LE_DO_PROCESS_QUEUE. This is one of the SwLeProcessQueueResult enumeration values.

◆ RIP_emergencySizeInBytes

size_t SwLeDoParams::RIP_emergencySizeInBytes

Additional memory beyond RIP_workingSizeInBytes to use before resorting to partial paint. Only meaningful if RIP_memory is NULL. This is passed to SwLeMemInit() and SwLeStart().

◆ RIP_maxAddressSpaceInBytes

size_t SwLeDoParams::RIP_maxAddressSpaceInBytes

Size of virtual memory available to RIP, as initially requested or modified by SwLeSDKStart(). This is passed to SwLeMemInit() and SwLeStart().

◆ RIP_memory

void* SwLeDoParams::RIP_memory

A pointer to an allocated buffer of size RIP_workingSizeInBytes, or NULL. This is passed to SwLeMemInit() and SwLeStart().

◆ RIP_workingSizeInBytes

size_t SwLeDoParams::RIP_workingSizeInBytes

Size of the memory buffer that the RIP will work in, as initially requested or modified by SwLeSDKStart(). This is passed to SwLeMemInit() and SwLeStart().

◆ size

size_t SwLeDoParams::size

Size of this structure.


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