formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Manager
Description
Writes a single scanline to the image buffer. This image buffer is automatically
created and maintained by formZ, if the renderer is a static pixel based renderer.
Passed into this function are a number of arrays,
which are assumed to be as fzrt_int as the rendered image is wide. This function must
be called with consecutive scanlines. It is not possible to pass in the
scanlines in an arbitrary order. The arrays currently supported are the
rgb_pixel array, which contains the final color of each rendered pixel, and the
optional alpha array, which contains the alpha channel value for each pixel.
The depth and rgb_bg (background rgb) arrays are currently unused.
Plugin Prototype
fzrt_error_td fz_rndr_ibuf_add_scanline(
rndr_uuid, | |
rgb_pixel, | |
float * | alpha, |
float * | depth, |
rgb_bg ) |
Parameters
rndr_uuid [Input]
The renderer's UUID
rgb_pixel [Input]
An array with rgb colors, one item for each pixel of the scanline.
alpha [Input, Optional]
If the current rendering produces an alpha channel, this array contains the alpha channel values. One array item for each scanline pixel.
depth [Input, Optional]
For future use (pass in NULL). An array with depth values, representing the distance of the pixel from the eye point. One array item for each scanline pixel.
rgb_bg [Input, Optional]
For future use (pass in NULL). An array with color pixels, representing the background without any surfaces rendered. One array item for each scanline pixel.
Returns
Error codes
Availability
5.0.0.0
Function Set
Defined in