| synopsis || return value || arguments || prev || next |
int generate_marker_segments( kdu_output * out, int which_tile, int tpart_idx)
Java: int Generate_marker_segments( Kdu_output out, int which_tile, int tpart_idx)
[Declared in "../coresys/common/kdu_params.h"]
This function invokes the protected (and generally overridden) write_marker_segment member function of every object whose tile index agrees with which_tile, in the network of code-stream parameter objects to which the current object belongs. Note that it does not make any difference whether the current object is a cluster head or not. In any event, all objects of all clusters are scanned, starting from the first cluster (usually that associated with the derived siz_params class).
Marker segments are written cluster by cluster, starting from the tile head and working through each tile-component in turn.
You can simulate the marker generation process by supplying a NULL value for the out argument. This is useful, since the function returns the total number of bytes which would have been generated, regardless of whether out is NULL.
The total number of bytes written (or simulated), including the marker codes and segment bytes for all marker segments.
If NULL, the marker generation process is only simulated — nothing is written, but the return value represents the number of bytes which would be written out if out had not been NULL.
Index of the tile for which marker segments are to be generated (or simulated). A value of -1 causes marker segments to be generated for the main header, while the first tile in the image has an index of 0.
Indicates the tile-part whose header is being written. A value of 0 refers to the first tile-part of the tile. A value of 0 is also required for the main header (i.e., when which_tile = -1).
| top || synopsis || return value || arguments || prev || next |