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

fz_ffmt_image_bmap_write_pbuf

Description

Writes the contents of a pixel buffer to a file. This is the main function which writes the contents of a pixel buffer to an image file.

Plugin Prototype

fzrt_error_td fz_ffmt_image_bmap_write_pbuf(

fzrt_int

windex,

fz_ffmt_ref_td

ffmt_id,

fzrt_floc_ptr

floc,

fzrt_pbuf_ptr

pbuf,

fzrt_pbuf_rect_td *

pb_rect )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

floc [Input]

The file to write to.

pbuf [Input]

The pixel buffer to write.

pb_rect [Input]

The bounding rectangle of the pixel buffer.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

See Also

Function Set

fz_ffmt_image_fset


Defined in

fz_ffmt_api.h