formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Shaders

fz_shdr_set_col_parm

Description

This function can only be called inside the set_parameters callback function when implementing a plugin or script shader. It declares a color shader parameter, which will show up in the shader options dialog as a color box with a title.

Plugin Prototype

fzrt_error_td fz_shdr_set_col_parm(

char *

name,

fz_rgb_float_td *

col,

fzrt_int

id )

Parameters

name [Input]

The title of the parameter, as shown in the shader options dialog

col [Input]

The default color

id [Input]

if passed in as -1, this function will create a unique id, with which the value of this parameter can be retrieved using the API . This id will be returned by the function in its return value. If a value other than -1 is passed in, it will be used as the unique id. It is the responsibility of the calling code to make sure, that the id is not used again in another fz_shdr_set_xxx_parm function

Returns

unique id for this parameter.

Availability

5.0.0.0

Function Set

fz_shdr_fset


Defined in

fz_rzne_shdr_api.h