formZ SDK | 5.0 API Reference | Project | File Formats | Structured File Translator | Image Bitmap

# fz_ffmt_image_bmap_load_pbuf

Description

Loads an image from a specified file into a pixel buffer.

Plugin Prototype

fzrt_error_td fz_ffmt_image_bmap_load_pbuf(

fz_ffmt_ref_td | ffmt_id,
fzrt_floc_ptr | floc,
char | alpha,
short | pix_depth,
fzrt_pbuf_ptr * | pbuf )

Parameters

ffmt_id [Input]

The format reference id of the image file to load. Use FFMT_NONE if the format id is not known.

floc [Input]

The image file to load.

alpha [Input]

If TRUE, load the image into the pixel buffer's alpha channel.

pix_depth [Input]

The number of color channels in the pixel buffer.

pbuf [Result]

The pointer to a pixel buffer to load. If it points to NULL, a pixel buffer will be allocated.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_image_fset

Defined in

fz_ffmt_api.h