HVD_page_output Struct Reference

Page information for the page output callback function. More...

#include "hvdpageoutput.h"

Data Fields
uint32	pageno
	Page number in total sequence.
uint32	pageNumberOffset
	Page number offset for output name.
int32	pdfPageNumber
	Page number from original PDF, -1 if not known.
uint32	h
	Width and height of the page.
int32	y2
	Raster bbox of this page: x1,y1 included; x2,y2 excluded.
HqBool	isTile
	Does this represent a tile of a larger page?
HqBool	hasBackground
	Is the first element a background (replicated)?
unsigned int	nElements
	Number of elements in the page, including the background (if present)
HVD_element_output **	elements
	Array of elements to output.
HVD_page_completion_fn *	completion_fn
	A callback function to report the completion of output. More...
void *	completion_data
	Data to be passed to completion_fn.
HVD_interrupt_poll_fn *	interrupt_poll_fn
	Function to poll for interrupts. More...

Detailed Description

Page information for the page output callback function.

The page output callback function is called when all of the rasters for all elements of a page are ready and present in the cache. The lifetime of this structure is the page output function call: any data that the backend wishes to store for a longer duration must be copied. The callee can modify the data in this structure and the elements and rasterData sub-structures, but any changes will not be reflected in the HVD cache or tracker after the page output function call finishes (for example, the callee may wish to sort rasters within a separation into a particular order).

Field Documentation

completion_fn

HVD_page_completion_fn* HVD_page_output::completion_fn

A callback function to report the completion of output.

If the HVD_tracker_params::page_output_fn() returns HVD_SUCCESS_INCOMPLETE, then it must ensure that this function is called with completion_data as its first parameter when the output either completes or fails. This function should not be called if the HVD_tracker_params::page_output_fn() returns any other value.

Parameters

[in]	data	The opaque page completion data passed to HVD_tracker_page_ready().
[in]	status	The status of the HVD_tracker_page_ready() output request. This will be: HVD_SUCCESS The page was output successfully. HVD_SUCCESS_ALREADY The page was already output. This may happen if the HVD_tracker_params::allow_early_output field was TRUE when the tracker was created, the elements for the page were already cached, and the page was already output. The SWEVT_RR_PAGE_COMPLETE event will not be issued in this case. HVD_ERROR_NO_PAGE The page index is not valid for the tracker. HVD_ERROR_NO_MEMORY The page output could not be performed because of memory exhaustion. HVD_ERROR_NO_ELEMENT An element of the page could not be located in the cache. HVD_ERROR_ABORTED Waiting for elements of the page was aborted by calling HVD_tracker_abort_job(). HVD_ERROR_INTERRUPTED Waiting for elements or the output was interrupted. Any other result 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.

interrupt_poll_fn

HVD_interrupt_poll_fn* HVD_page_output::interrupt_poll_fn

Function to poll for interrupts.

Return values

TRUE	Stop waiting for page rasters or outputting the page.
FALSE	Continue waiting for page rasters or outputting the page.

---

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

• lib/interface/hvdpageoutput.h