formZ SDK | 4.0 Call Back Reference | File Translator | Structured File Translator | Image Bitmap Call Back

# fz_ffmt_cbak_image_bmap_read_info

Description

Reads Information from a bitmap file. This function is called to get information about a bitmap file. This information includes width, height, number of components, bits per sample, etc.

Plugin Prototype

fzrt_error_td fz_ffmt_cbak_image_bmap_read_info(

fzrt_int | windex,
fz_ffmt_ref_td | ffmt_id,
fzrt_floc_ptr | floc,
fzrt_int * | width,
fzrt_int * | height,
short * | pixel_depth,
fzrt_boolean * | has_alpha,
double * | dpi )

Parameters

windex [Input]

project window index

ffmt_id [Input]

The file format reference id.

floc [Input]

The file to read from.

width [Result]

The width of the bitmap in pixels.

height [Result]

The height of the bitmap in pixels.

pixel_depth [Result]

The number of bits per pixel.

has_alpha [Result]

TRUE if the bitmap has an alpha channel.

dpi [Result]

The resolution of the bitmap in pixels (dots) per inch.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_cbak_image_fset

Defined in

fz_ffmt_api.h