Harlequin RIP SDK
HVD_tracker_params Struct Reference

Parameters for the HVD tracker. More...

#include "hvdtracker.h"

Data Fields

size_t size
 The size of this structure.
 
HqBool allow_zero_elements
 
HqBool allow_early_output
 
HqBool allow_async_output
 
HVD_page_output_fnpage_output_fn
 
HVD_interrupt_poll_fninterrupt_poll_fn
 
HVD_cachecache
 Cache instance rasters are stored in.
 
HVD_cache_fnscache_fns
 Cache functions, or NULL for default.
 
sw_memory_instancemem
 Memory allocation/deallocation functions.
 

Detailed Description

Parameters for the HVD tracker.

Field Documentation

◆ allow_async_output

HqBool HVD_tracker_params::allow_async_output

Can the client handle output callbacks at times other than requested?

◆ allow_early_output

HqBool HVD_tracker_params::allow_early_output

Can the client handle output in any order (when elements become ready)?

◆ allow_zero_elements

HqBool HVD_tracker_params::allow_zero_elements

Can the client handle pages with no elements in them?

◆ interrupt_poll_fn

HVD_interrupt_poll_fn* HVD_tracker_params::interrupt_poll_fn

Function to poll for interrupts.

Return values
TRUEStop waiting for page rasters.
FALSEContinue waiting for page rasters.

◆ page_output_fn

HVD_page_output_fn* HVD_tracker_params::page_output_fn

Function to output a completed page.

Parameters
[in]outputThe page details to output. The lifetime of this structure is the duration of this callback: any data that the backend wishes to store for a longer duration must be copied.
Return values
HVD_SUCCESS(0) The page was output successfully
Returns
Any other return value greater than MON_CLASS_ERROR is an error UID. The subclass, PS error type, and UID for the error can be deconstructed using the macros in monevent.h.

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