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

# fz_ffmt_image_bmap_pixbuf_from_display

Description

Creates a pixel buffer from the display. This function will return a pixel buffer of the display associated with the specified windex. The pixel buffer will contain a rendering with the currently selected renderer at the current view parameters.

Plugin Prototype

fzrt_error_td fz_ffmt_image_bmap_pixbuf_from_display(

fzrt_int | windex,
fzrt_pbuf_ptr * | pbuf,
fzrt_pbuf_rect_td * | pbuf_rect )

Parameters

windex [Input]

project window index

pbuf [Result]

pointer to a pixel buffer pointer that receives a pixel buffer of the current display

pbuf_rect [Result]

pointer to a pixel buffer rectangle that contains the size of the pixel buffer

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