| synopsis || return value || arguments || prev || next |

kdu_region_compositor::process

Java: Kdu_region_compositor::Process

bool process( int suggested_increment, kdu_dims & new_region)

Java: boolean Process( int suggested_increment, Kdu_dims new_region)

[Declared in "../apps/support/kdu_region_compositor.h"]

Go to class description.


Synopsis

Call this function regularly (e.g. during an idle processing loop, or within a tight loop in a processing thread) until is_processing_complete returns false. You will generally need to start calling the function again after making any changes to the compositing layers, scale, orientation, overlays, or buffered region. You may use the returned new_region to control all painting in your image application, except where the screen must be repainted after being overwritten by an independent event.

This function may catch and rethrow an integer exception generated by a kdu_error handler if an error occurred in processing the underlying code-stream.


Return Value

False only under one of the following two conditions. In either case, new_region is guaranteed to be empty upon return.

Arguments

suggested_increment [int]

The meaning of this argument is identical to its namesake in the kdu_region_decompressor object.

new_region [kdu_dims &]

Upon successful return, this record holds the dimensions of a new region which contains at least one newly composited pixel. An interactive application may choose to repaint this region immediately.


| top || synopsis || return value || arguments || prev || next |