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

# fz_lite_get_lrep_data

Description

This function allows a plugin to retrieve the data associated with a light representation. It is most useful for a plugin renderer that has implemented its own light representation plugin and needs to get to its light data when executing the rendering. The lrep_uuid argument identifies the light representation. If it is passed as NULL, the lrep_indx argument is used. For speed purpose, the lrep_indx is faster, as it is a run time index, where as the lrep_uuid requires searching. The lrep_indx can be retrieved from the uuid of a light representation by the api call fz_lite_get_lrep_index.

Plugin Prototype

fzrt_error_td fz_lite_get_lrep_data(

fzrt_int | windex,
fz_lite_ptr | lite_ptr,
fzrt_UUID_td | lrep_uuid,
fzrt_int | lrep_indx,
void ** | lrep_data )

Parameters

windex [Input]

project window index

lite_ptr [Input]

the light from which to get the data

lrep_uuid [Input, Optional]

the uuid which identifies the light representation. If passed as NULL, lrep_indx is used.

lrep_indx [Input, Optional]

the run time index which identifies the light representation. If lrep_uuid is passed as NULL, this argument is used and must be a valid index.

lrep_data [Result]

a pointer to the light data

Returns

Error codes

Availability

7.0.0.0

See Also

fz_lite_get_lrep_index

Function Set

fz_lite_fset

Defined in

fz_lite_api.h