| synopsis || return value || arguments || prev || next |
kdu_uint32 * get_composition_buffer( kdu_dims & region, int & row_gap)
[Declared in "../apps/support/kdu_region_compositor.h"]
Returns a pointer to the buffer which stores composited imagery, along with information about the region occupied by the buffer on the composited image. To recover the origin of the composited image, use get_total_composition_dims.
You should call this function again, whenever you do anything which may affect the geometry of the composited image. Specifically, you should call this function again after any call to set_buffer_surface, set_scale, add_compositing_layer, remove_compositing_layer or set_single_component.
NULL if composition cannot be performed at the current scale — see the description of get_total_composition_dims for more on this.
Otherwise, the returned buffer uses 4 bytes to represent each pixel. We define the buffer as an array of 32-bit words so as to force alignment on 4-byte boundaries. The most significant byte in each word represents alpha, followed by red, green and blue which is in the least significant byte of the word.
| top || synopsis || return value || arguments || prev || next |