formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Materials

# fz_rmtl_iface_pview_update

Description

Draws a rendered preview of the surface style into the preview window in the Surface Style Parameters dialog. This api function in intended to be only called from the callback function of a Surface Style Representation plugin. The num_scanlines argument indicates how many scanlines to draw. If -1 is passed for this argument, the whole image buffer is shown. The image buffer must be an array of RGB pixel colors. Its size must be FZ_SREP_PVIEW_SIZE * FZ_SREP_PVIEW_SIZE * 3 bytes and pixels are ordered as RGB values, where 255,255,255 indicates white and 0,0,0 is black. The buffer passed to the can be used to store the image and pass it to fz_rmtl_iface_pview_update.

Plugin Prototype

fzrt_error_td fz_rmtl_iface_pview_update(

fz_fuim_tmpl_ptr | fuim_tmpl,
unsigned char * | image_buffer,
fzrt_int | num_scanlines )

Parameters

fuim_tmpl [Input]

pointer to fuim template.

image_buffer [Input]

the image to draw.

num_scanlines [Input]

how many scalines of the image to draw, or -1 to draw the whole image

Returns

Error codes

Availability

6.0.0.2

See Also

, fz_rmtl_iface_pview_interrupt

Function Set

fz_rmtl_fset

Defined in

fz_rmtl_api.h