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

jp2_channels::get_chroma_key

Java: Jp2_channels::Get_chroma_key

bool get_chroma_key( int colour_idx, kdu_int32 & key_val)

Java: boolean Get_chroma_key( int colour_idx, int[] key_val)

[Declared in "../apps/compressed_io/jp2.h"]

Go to class description.


Synopsis

Retrieves the chroma key value, if any, associated with the indicated colour intensity channel. For a discussion of chroma keys, their dangers and limitations, consult the comments appearing with the set_chroma_key function.


Return Value

True if the colour description includes a chroma key. If so, all colour channels will have a chroma key value, and there will be no opacity or pre-multiplied opacity descriptions.

Arguments

colour_idx [int]

See the set_colour_mapping function for a description of this argument.

key_val [kdu_int32 &]

Used to return the chroma key value. See the set_chroma_key function for a description of the key value.


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