formZ SDK | 4.0 Call Back Reference | Light Representation

# fz_light_rep_cbak_data_init

Description

Light Representation data initiailization function (Required). This function is called whenever a new Light is created by formZ. It is expected to fill in the default values for the content of the Light Representation. Note, that formZ allocates the data block for the Light Representation, based on the size parameter returned by the function. In other words, the plugin does not need to allocate / deallocate the basic data storage. However, any dynamic memory needed within each instance of a Light Representation needs to be allcoated here end deallocated in the fz_light_rep_cbak_finit function. For convenience ,the light, which is created new is also passed in. This allows the plugin to inquire more detail about the light, such as its type.

Plugin Prototype

fzrt_error_td fz_light_rep_cbak_data_init(

fzrt_int | windex,
fz_lite_ptr | light,
void * | light_rep_data )

Parameters

windex [Input]

project window index

light [Input]

the light, which has been created new

light_rep_data [Input, Result]

Light Representation data.

Returns

Error codes

Availability

7.0.0.0

Function Set

fz_light_rep_cbak_fset

Defined in

fz_view_rep_api.h