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

# fz_rmtl_set_simple_parms

Description

Sets the generic rendering parameters from the simple surface style representation. Note, the the simple srep is always guaranteed to be present and a plugin can rely on these parameters to be avialable all the time.
A plugin may call this function with NULL for any parameter input arument so that only specific parameters can be set
Note, that some parameter are currently unsupported. They may be in the future.

Plugin Prototype

fzrt_error_td fz_rmtl_set_simple_parms(

fzrt_int | windex,
fz_rmtl_ptr | matl_ptr,
fz_srep_pattern_type_enum * | col_which,
float * | col,
fz_tmap_embd_ptr | col_tmap,
fzrt_int * | col_tmap_flags,
float * | col_txr_scale,
fz_srep_shading_type_enum * | refl_which,
float * | ambient,
float * | diffuse,
float * | specular,
float * | spec_expo,
float * | spec_col,
float * | mirr,
float * | trans_misson,
float * | refr,
float * | glow,
fz_srep_pattern_type_enum * | transp_which,
float * | transp,
fz_tmap_embd_ptr | transp_tmap,
fzrt_int * | transp_tmap_flags,
float * | trn_txr_scale,
fz_srep_pattern_type_enum * | bmp_which,
fz_tmap_embd_ptr | bmp_tmap,
float * | bmp_amp,
fzrt_int * | bmp_tmap_flags,
float * | bmp_txr_scale )

Parameters

windex [Input]

project window index

matl_ptr [Input]

the surface style, for which to set the simple parameters

col_which [Input, Optional]

The color pattern type. FZ_SREP_PATTERN_TYPE_PLAIN or FZ_SREP_PATTERN_TYPE_MAP

col [Input, Optional]

The simple color, if col_which == FZ_SREP_PATTERN_TYPE_PLAIN

col_tmap [Input, Optional]

The color map, if col_which == FZ_SREP_PATTERN_TYPE_MAP

col_tmap_flags [Input, Optional]

Bit encoded color map options (unused for now)

col_txr_scale [Input, Optional]

Color texture scale (unused for now)

refl_which [Input, Optional]

The reflection type type. FZ_SREP_REFLECTION_TYPE_CONSTANT or FZ_SREP_REFLECTION_TYPE_SHADED

ambient [Input, Optional]

The ambient reflection factor

diffuse [Input, Optional]

The diffuse reflection factor

specular [Input, Optional]

The specular reflection factor

spec_expo [Input, Optional]

The specular reflection exponent

spec_col [Input, Optional]

The specular reflection color

mirr [Input, Optional]

The mirror factor (unused for now)

trans_misson [Input, Optional]

The transmission (glass like) factor (unused for now)

refr [Input, Optional]

The index of refraction (unused for now)

glow [Input, Optional]

The glow factor (unused for now)

transp_which [Input, Optional]

The transparency pattern type. FZ_SREP_PATTERN_TYPE_PLAIN, FZ_SREP_PATTERN_TYPE_MAP or FZ_SREP_PATTERN_TYPE_NONE

transp [Input, Optional]

The simple transparency, if transp_which == FZ_SREP_PATTERN_TYPE_PLAIN

transp_tmap [Input, Optional]

The transparency map, if transp_which == FZ_SREP_PATTERN_TYPE_MAP

transp_tmap_flags [Input, Optional]

Bit encoded transparency map options (see fz_srep_tmap_flags_enum for bits)

trn_txr_scale [Input, Optional]

Transparency texture scale (unused for now)

bmp_which [Input, Optional]

The bump pattern type. (unused for now)

bmp_tmap [Input, Optional]

The bump map, (unused for now)

bmp_amp [Input, Optional]

The bump map amplitide, (unused for now)

bmp_tmap_flags [Input, Optional]

Bit encoded bump map options, (unused for now)

bmp_txr_scale [Input, Optional]

The bump map scale, (unused for now)

Returns

Error codes

Availability

7.0.0.0

Function Set

fz_rmtl_fset

Defined in

fz_rmtl_api.h