formZ SDK | 4.0 Call Back Reference | RenderZone Shader

fz_shdr_cbak_colr_fset

FZ_SHDR_CBAK_COLR_FSET_TYPE

formZ color shader callbacks function set id.

FZ_SHDR_CBAK_COLR_FSET_NAME

formZ color shader callbacks function set name.

FZ_SHDR_CBAK_COLR_FSET_VERSION

formZ color shader callbacks function set version.

Description

Function set for color shaders. The functions in this set need to be supplied by the plugin or script to implement a color shader.
The main shader function is the callback. It is expected to compute the original (unshaded) color of a pixel. Depending on whether the shader is a 2d or 3d shader, the 2d texture space coordinate (s,t) or the 3d texture space coordinate (x,y,z) relating to the pixel should be taken as the basis of the color computation. These coordinate values can be retrieved with the functions (2d) or fz_shdr_get_tspace_pnt (3d).
There are required and optional functions. The required functions are : All other functions are optional, but must be supplied to enable a certain functionality. For example, if the color shader has any parameters, the function must be supplied. It is also advisable to implement a function, if the function uses information which can be calculated once and does not change during the course of a rendering. It is important to note, that the function is called at least once for each pixel, potentially thousands of times during a single rendering. The faster the function, the faster the rendering will be.

Availability

5.0.0.0

Functions:

fz_shdr_cbak_colr_avg

fz_shdr_cbak_colr_iface_tmpl

fz_shdr_cbak_colr_name

fz_shdr_cbak_colr_pdf_help

fz_shdr_cbak_colr_pixel

fz_shdr_cbak_colr_post_render

fz_shdr_cbak_colr_pre_render

fz_shdr_cbak_colr_set_parameters

fz_shdr_cbak_colr_uuid

fz_shdr_cbak_colr_version

Defined in

fz_rzne_shdr_api.h