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

kdu_stripe_compressor::push_stripe

Java: Kdu_stripe_compressor.Push_stripe

C#: Ckdu_stripe_compressor.push_stripe

VB: Ckdu_stripe_compressor.push_stripe

Overload navigation: 1, 2, 3, 4, 5, 6, 7, 8

bool push_stripe( kdu_int16 * buffer, int stripe_heights[], int * sample_offsets=NULL, int * sample_gaps=NULL, int * row_gaps=NULL, int * precisions=NULL, bool * is_signed=NULL, int flush_period=0)

Java: public native boolean Push_stripe( short[] buffer, int[] stripe_heights, int[] sample_offsets, int[] sample_gaps, int[] row_gaps, int[] precisions, boolean[] is_signed, int flush_period)

C#: public bool push_stripe( short[] buffer, int[] stripe_heights, int[] sample_offsets, int[] sample_gaps, int[] row_gaps, int[] precisions, bool[] is_signed, int flush_period)

VB: Public Function push_stripe( ByVal buffer() As Short, ByVal stripe_heights() As Integer, ByVal sample_offsets() As Integer, ByVal sample_gaps() As Integer, ByVal row_gaps() As Integer, ByVal precisions() As Integer, ByVal is_signed() As Boolean, ByVal flush_period As Integer)  As Boolean

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

Go to class description.


Synopsis

Same as the third form of the overloaded push_stripe function, except that all component buffers are found within the single supplied buffer. Specifically, sample values have a 16-bit signed (but possibly unsigned, depending on the is_signed argument) representation, rather than an 8-bit unsigned representation. As with the second form of the function, this fourth form is provided primarily to facilitate automatic construction of Java language bindings by the "kdu_hyperdoc" utility.


Return Value

True until all samples for all image components have been pushed in, at which point the function returns false.

Arguments

buffer [kdu_int16 *]

stripe_heights[] [int]

See description of the first form of the push_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 push_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 push_stripe function. If NULL, the lines of each component stripe buffers are assumed to be contiguous, meaning that the organization of buffer must be either component- or sample-interleaved.

precisions [int *]

See description of the third form of the push_stripe function.

is_signed [bool *]

See description of the third form of the push_stripe function.

flush_period [int]

See description of the first form of the push_stripe function.


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