formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Materials
Description
Gets 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 output parameter
except parm_mask, so that only specific parameters can be acquired.
Note, that some parameter are currently unsupported. They may
be in the future.
Plugin Prototype
fzrt_error_td fz_rmtl_get_simple_parms(
fzrt_int | windex, |
matl_ptr, | |
col_which, | |
float * | col, |
col_tmap, | |
fzrt_int * | col_tmap_flags, |
float * | col_txr_scale, |
refl_which, | |
float * | ambient, |
float * | diffuse, |
float * | specular, |
float * | spec_expo, |
float * | spec_col, |
float * | mirr, |
float * | trans_misson, |
float * | refr, |
float * | glow, |
transp_which, | |
float * | transp, |
transp_tmap, | |
fzrt_int * | transp_tmap_flags, |
float * | trn_txr_scale, |
bmp_which, | |
bmp_tmap, | |
float * | bmp_amp, |
fzrt_int * | bmp_tmap_flags, |
float * | bmp_txr_scale, |
fzrt_int * | parm_mask ) |
Parameters
windex [Input]
project window index
matl_ptr [Input]
the surface style, for which to get the simple parameters
col_which [Result, Optional]
The color pattern type. FZ_SREP_PATTERN_TYPE_PLAIN or FZ_SREP_PATTERN_TYPE_MAP
col [Result, Optional]
The simple color, if col_which == FZ_SREP_PATTERN_TYPE_PLAIN
col_tmap [Result, Optional]
The color map, if col_which == FZ_SREP_PATTERN_TYPE_MAP
col_tmap_flags [Result, Optional]
Bit encoded color map options (always 0 for now)
col_txr_scale [Result, Optional]
Color texture scale (always 1.0 for now)
refl_which [Result, Optional]
The reflection type type. FZ_SREP_REFLECTION_TYPE_CONSTANT or FZ_SREP_REFLECTION_TYPE_SHADED
ambient [Result, Optional]
The ambient reflection factor
diffuse [Result, Optional]
The diffuse reflection factor
specular [Result, Optional]
The specular reflection factor
spec_expo [Result, Optional]
The specular reflection exponent
spec_col [Result, Optional]
The specular reflection color
mirr [Result, Optional]
The mirror factor (always 0.0 for now)
trans_misson [Result, Optional]
The transmission (glass like) factor (always 0.0 for now)
refr [Result, Optional]
The index of refraction (always 1.0 for now)
glow [Result, Optional]
The glow factor (always 0.0 for now)
transp_which [Result, Optional]
The transparency pattern type. FZ_SREP_PATTERN_TYPE_PLAIN, FZ_SREP_PATTERN_TYPE_MAP or FZ_SREP_PATTERN_TYPE_NONE
transp [Result, Optional]
The simple transparency, if transp_which == FZ_SREP_PATTERN_TYPE_PLAIN
transp_tmap [Result, Optional]
The transparency map, if transp_which == FZ_SREP_PATTERN_TYPE_MAP
transp_tmap_flags [Result, Optional]
Bit encoded transparency map options (see fz_srep_tmap_flags_enum for bits)
trn_txr_scale [Result, Optional]
Transparency texture scale (always 1.0 for now)
bmp_which [Result, Optional]
The bump pattern type. Always FZ_SREP_PATTERN_TYPE_NONE for now
bmp_tmap [Result, Optional]
The bump map, (unused, since bmp_which is always FZ_SREP_PATTERN_TYPE_NONE)
bmp_amp [Result, Optional]
The bump map amplitide, (unused, since bmp_which is always FZ_SREP_PATTERN_TYPE_NONE)
bmp_tmap_flags [Result, Optional]
Bit encoded bump map options, (unused, since bmp_which is always FZ_SREP_PATTERN_TYPE_NONE)
bmp_txr_scale [Result, Optional]
The bump map scale, (unused, since bmp_which is always FZ_SREP_PATTERN_TYPE_NONE)
parm_mask [Result]
Bit mask, that indicates which parameters were actually set (see fz_srep_parm_generic_enum for bits).
Returns
Error codes
Availability
7.0.0.0
Function Set
Defined in