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

kdu_region_compositor::get_codestream_info

bool get_codestream_info( kdrc_stream * stream_ref, int & codestream_idx, int & compositing_layer_idx, int * components_in_use=NULL)

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

Go to class description.


Synopsis

Use this function with the kdrc_stream pointer returned by a previous call to get_next_codestream. It returns information concerning the associated layer codestream. For a discussion of "layer codestreams", see the get_next_codestream function.

Note that the kdrc_stream pointers returned by get_next_codestream must be considered invalid and not passed to the present function, if the composition has since been modified by a call to any of set_frame, add_compositing_layer, remove_compositing_layer, set_single_component or cull_inactive_layers.


Return Value

True if the indicated layer codestream is on the internal active list; for a discussion of the active list, see the comments appearing with get_next_codestream.

Arguments

stream_ref [kdrc_stream *]

Pointer returned by a previous call to get_next_codestream.

codestream_idx [int &]

Used to return the absolute index of the JPEG2000 code-stream associated with this layer codestream, as it appears within its data source.

compositing_layer_idx [int &]

Used to return the absolute index of the compositing layer associated with this layer codestream, as it appears within its data source. If the codestream has never been associated with any compositing layer (e.g., only opened as a result of calls to set_single_component), this variable is set to -1.

components_in_use [int *]

If non-NULL, this argument must point to an array with at least 4 elements. The array's entries are filled out with the indices (starting from 0) of the image components which are actually being used within this code-stream. All four entries of the array are filled out, but once all components which are in use have been accounted for, remaining entries are set to -1.


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