formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Materials

# fz_rmtl_get_srep_data

Description

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

Plugin Prototype

fzrt_error_td fz_rmtl_get_srep_data(

fzrt_int | windex,
fz_rmtl_ptr | rmtl_ptr,
fzrt_UUID_td | srep_uuid,
fzrt_int | srep_indx,
void ** | srep_data )

Parameters

windex [Input]

project window index

rmtl_ptr [Input]

the surface style from which to get the data

srep_uuid [Input, Optional]

the uuid which identifies the surface style representation. If passed as NULL, srep_indx is used.

srep_indx [Input, Optional]

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

srep_data [Result]

a pointer to the surface style data

Returns

Error codes

Availability

6.0.0.2

See Also

Function Set

fz_rmtl_fset

Defined in

fz_rmtl_api.h