| synopsis || return value || arguments || prev || next |
bool get_window( kdu_window & window)
Java: boolean Get_window( Kdu_window window)
[Declared in "../apps/kdu_server/kdu_serve.h"]
Retrieves the window parameters which are to be used in the next call to generate_increments unless set_window is called first.
The principle reason for calling this function is to learn about any modifications which the server made to the window parameters supplied in a previous call to set_window. As noted in connection with that function, the server may need to make such changes in order to satisfy its own resource constraints. In particular, very large windows (large spatial regions and/or large number of components) may require excessive memory to be allocated by the server.
It is important to realize that the server may not make any necessary alterations to the window parameters supplied to set_window until after the first subsequent call to generate_increments, or possibly augment_cache_model or truncate_cache_model. Thus, the most meaningful point at which to call the present function is after the first (or a subsequent) call to generate_increments which follows a set_window call.
True if the window is still active, in the sense that not all data which is relevant to the window has yet been packaged up in calls to generate_increments. If the function returns false, subsequent calls to generate_increments are guaranteed to return NULL, meaning that the window has been fully served.
| top || synopsis || return value || arguments || prev || next |