Kakadu Hyper-Doc (kdu_stripe_decompressor::pull

bool pull_stripe( kdu_byte * buffer, int stripe_heights[], int * sample_offsets=NULL, int * sample_gaps=NULL, int * row_gaps=NULL, int * precisions=NULL)

Synopsis

Same as the first form of the overloaded pull_stripe function, except in the following respect:

The stripe samples for all image components are located within a single array, given by the buffer argument. The location of the first sample of each component stripe within this single array is given by the corresponding entry in the sample_offsets array.

This form of the function is no more useful (in fact less general) than the first form, but is more suitable for the automatic construction of Java language bindings by the "kdu_hyperdoc" utility. It can also be more convenient to use when the application uses an interleaved buffer.

Return Value

True until all samples of all image components have been decompressed and returned, at which point the function returns false.

Arguments

buffer [kdu_byte *]

stripe_heights[] [int]

See description of the first form of the pull_stripe function.

sample_offsets [int *]

Array with one entry for each image component, identifying the position of the first sample of that component within the buffer array. If this argument is NULL, the implied sample offsets are sample_offsets[c] = c — i.e., samples are tightly interleaved. In this case, the interpretation of a NULL sample_gaps array is modified to match the tight interleaving assumption.

sample_gaps [int *]

See description of the first form of the pull_stripe function. If NULL, the sample gaps for all image components are taken to be 1, which means that the organization of buffer must be either line- or component- interleaved. The only exception to this is if sample_offsets is also NULL, in which case, the sample gaps all default to the number of image components, corresponding to a sample-interleaved organization.

row_gaps [int *]

See description of the first form of the pull_stripe function. If NULL, the lines of each component stripe buffer are assumed to be contiguous, meaning that the organization of buffer must be either component- or sample-interleaved.

precisions [int *]