formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | Graphics
Description
Copies pixel data from a pixel buffer into memory. This will load a memory buffer with pixel data to an allocated pixel buffer, converting the pixel data if necessary.
Plugin Prototype
fzrt_error_td fzrt_pbuf_get_pixels(
src_pbuf, | |
const fzrt_pbuf_rect_td * | src_bounds, |
dst_ptr, | |
fzrt_int | dst_rowbytes, |
fzrt_int | dst_scanlines, |
short | dst_pixdepth, |
short | dst_pixbytes, |
dst_pix_format, | |
const fzrt_pbuf_point_td * | dst_off, |
dst_ctab, | |
apply_alpha ) |
Parameters
src_pbuf [Input]
Destination GWorld fzrt_ptr
src_bounds [Input]
offset to (top,left) src. pixel
dst_ptr [Result]
pointer to pixel data must be allocated by the caller
dst_rowbytes [Input]
number of bytes per scanline
dst_scanlines [Input]
number of scanlines in destination buffer
dst_pixdepth [Input]
number of bits per pixel (1,8,16,24,32)
dst_pixbytes [Input]
number of bytes per pixel
dst_pix_format [Input]
format of pixel data (RGB, BGR, RGBA, PIX555, indexed...)
dst_off [Input]
bounding rectangle to read pixel data from
dst_ctab [Result]
pointer to destination color table
apply_alpha [Input]
handle the alpha data
Returns
FZRT_NOERR if successful, error number otherwise
Availability
5.0.0.0
Function Set
Defined in