Parameters for the HVD tracker. More...

#include "hvdtracker.h"

Data Fields
size_t	size
	The size of this structure.

HqBool	allow_zero_elements
	Can the client handle pages with no elements in them?

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

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

HVD_page_output_fn *	page_output_fn
	Function to output a completed page. More...

HVD_interrupt_poll_fn *	interrupt_poll_fn
	Function to poll for interrupts. More...

HVD_cache *	cache
	Cache instance rasters are stored in.

sw_memory_instance *	mem
	Memory allocation/deallocation functions.

Detailed Description

Parameters for the HVD tracker.

Field Documentation

HVD_interrupt_poll_fn* HVD_tracker_params::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.

HVD_page_output_fn* HVD_tracker_params::page_output_fn

Function to output a completed page.

Parameters

[in] output The page details to output.

Return values

HVD_SUCCESS	(0) The page was output successfully. The page output function should not call HVD_page_output::completion_fn().
HVD_SUCCESS_INCOMPLETE	The page will be output asynchronously. The output function has copied all necessary information to output the page asynchronously. The page output function must ensure that HVD_page_output::completion_fn() is called with HVD_page_output::completion_data as the first argument when the output is complete or fails.

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 page output function should not call HVD_page_output::completion_fn().

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