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

kdu_region_compositor::search_overlays

Java: Kdu_region_compositor::Search_overlays

jpx_metanode search_overlays( kdu_coords point, int & codestream_idx)

Java: Jpx_metanode Search_overlays( Kdu_coords point, int[] codestream_idx)

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

Go to class description.


Synopsis

This function searches through all overlay metadata, returning a non-empty interface only if a node is found whose bounding box includes the supplied point. The function returns an empty interface if overlays are not currently enabled, or if the relevant bounding box is not currently visible, as determined by the opacity of layers which may lie on top of a layer whose codestream actually contains the metadata.


Return Value

A non-empty interface unless a match is found, in which case the returned object is represented by an ROI description box — i.e., jpx_metanode::get_num_regions is guaranteed to return a value greater than 0.

Arguments

point [kdu_coords]

Location of a point on the compositing grid, expressed using the same coordinate system as that associated with set_buffer_surface.

codestream_idx [int &]

Used to return the zero-based index of the codestream whose overlay contains the metadata whose bounding box contains point.


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