| synopsis || return value || arguments || prev || next |
bool finish( int num_layer_specs=0, kdu_long * layer_sizes=NULL, kdu_uint16 * layer_slopes=NULL)
Java: boolean Finish( int num_layer_specs, long[] layer_sizes, int[] layer_slopes)
[Declared in "../apps/support/kdu_stripe_compressor.h"]
Each call to start must be bracketed by a call to finish, for the compression cycle to be completed.
If you did not push all required image data into the push_stripe function before calling finish, the function returns false. If this happens, the compressed image is not completely generated, but the internal machinery is cleaned up, so you cannot continue to push more stripes in. This means that a new call to start can be issued regardless of whether finish returns true or false. You should watch the value returned by push_stripe if you have any doubts as to whether sufficient image data has been supplied.
True only if the compressed image is complete. Otherwise, insufficent image data was pushed in via push_stripe, but the internal machinery is cleaned up anyway.
Identifies the number of entries in the layer_sizes and/or layer_slopes arrays, if non-NULL.
If non-NULL, the final cumulative sizes of each code-stream quality layer will be written into this array. At most num_layer_specs cumulative layer sizes will be written. If the actual number of quality layers whose sizes are known is less than num_layer_specs, the additional entries are set to 0.
Same as layer_sizes but used to receive final values of the distortion length slope thresholds associated with each layer. Again, if num_layer_specs exceeds the number of layers for which slope information is available, the additional entries will be set to 0.
| top || synopsis || return value || arguments || prev || next |