formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager

# fz_lite_get_intens_scale

Description

Gets the intensity scale factor of a light. If the light is not in a light group, this is always 1.0. If the light is in a light group and the group has the intensity override wit hthe scaler option on the scale factor is returned. This function is intended to be used by a plugin renderer to honor the intensity override option of a light group. That is, when setting up a rendering looking at the lights in a project, the plugin renderer should always inquire this parameter and apply it to its own light intenisty settings. Note, that the simple intensity light parameter((windex,light,FZ_LIGHT_REP_PARM_INTENS_BRIGHT,display,&data), that is maintained by formZ already has this scale factor applied if the display parameter is set to TRUE.

Plugin Prototype

fzrt_error_td fz_lite_get_intens_scale(

fzrt_int | windex,
fz_lite_ptr | lite,
double * | scale )

Parameters

windex [Input]

project window index

lite [Input]

the light from which to get intensity scale

scale [Result]

the intensity scale

Returns

Error codes

Availability

7.0.0.0

See Also

Function Set

fz_lite_fset

Defined in

fz_lite_api.h