formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Manager
Description
Renderer parameters for RenderZone. Each renderer has a set of options that can be retrieved or changed, and this enum identifies which option is wanted. This is used with the fz_rndr_get_parm, render manager functions.
enum fz_rndr_rzne_parm_enum {
FZ_RNDR_RZNE_PARM_TYPE_OBSOLETE,
FZ_RNDR_RZNE_PARM_MAX_RAYS,
FZ_RNDR_RZNE_PARM_MAX_POLYS_BVOL,
FZ_RNDR_RZNE_PARM_MAX_DEPTH_BVOL,
FZ_RNDR_RZNE_PARM_MIN_RAY_CONTRIB,
FZ_RNDR_RZNE_PARM_AA_THRESHOLD,
FZ_RNDR_RZNE_PARM_EST_MEM_USAGE,
FZ_RNDR_RZNE_PARM_SET_IMG_SIZE_OBSOLETE,
FZ_RNDR_RZNE_PARM_SHADOWS,
FZ_RNDR_RZNE_PARM_SHAD_MENU,
FZ_RNDR_RZNE_PARM_TEXTURES,
FZ_RNDR_RZNE_PARM_REFL,
FZ_RNDR_RZNE_PARM_TRNS,
FZ_RNDR_RZNE_PARM_BUMP,
FZ_RNDR_RZNE_PARM_SHDR_AA,
FZ_RNDR_RZNE_PARM_SUPER,
FZ_RNDR_RZNE_PARM_SUPER_MENU,
FZ_RNDR_RZNE_PARM_LITE_MENU,
FZ_RNDR_RZNE_PARM_AREA_LN_MENU,
FZ_RNDR_RZNE_PARM_LITE_GLOW,
FZ_RNDR_RZNE_PARM_ALYS,
FZ_RNDR_RZNE_PARM_DCMP,
FZ_RNDR_RZNE_PARM_SCALE,
FZ_RNDR_RZNE_PARM_SCALE_BY,
FZ_RNDR_RZNE_PARM_SET,
FZ_RNDR_RZNE_PARM_SET_TO,
FZ_RNDR_RZNE_PARM_BGND_SHDR,
FZ_RNDR_RZNE_PARM_ENVR,
FZ_RNDR_RZNE_PARM_ENVR_TYPE,
FZ_RNDR_RZNE_PARM_ENVR_SHDR,
FZ_RNDR_RZNE_PARM_ENVR_RES,
FZ_RNDR_RZNE_PARM_DEPTH_EFFECT,
FZ_RNDR_RZNE_PARM_FORE_SHDR,
FZ_RNDR_RZNE_PARM_APPLY_ALPHA,
FZ_RNDR_RZNE_PARM_GEN_POSTP,
FZ_RNDR_RZNE_PARM_EXP_COR,
FZ_RNDR_RZNE_PARM_DEPTH_BLUR,
FZ_RNDR_RZNE_PARM_LENS_FLARE,
FZ_RNDR_RZNE_PARM_STYLE,
FZ_RNDR_RZNE_PARM_GEOM_SILH,
FZ_RNDR_RZNE_PARM_GEOM_SURF,
FZ_RNDR_RZNE_PARM_GI_AO,
FZ_RNDR_RZNE_PARM_GI_FG,
FZ_RNDR_RZNE_PARM_GI_SCENE_SIZE,
FZ_RNDR_RZNE_PARM_GI_SCENE_SIZE_CUSTOM,
FZ_RNDR_RZNE_PARM_GI_QUALITY,
FZ_RNDR_RZNE_PARM_AO_DIST,
FZ_RNDR_RZNE_PARM_AO_DIST_CUSTOM,
FZ_RNDR_RZNE_PARM_AO_CONTRAST,
FZ_RNDR_RZNE_PARM_AO_FALLOFF,
FZ_RNDR_RZNE_PARM_AO_ADD_CONTRAST,
FZ_RNDR_RZNE_PARM_AO_ADD_NOISE,
FZ_RNDR_RZNE_PARM_AO_NUM_RAYS,
FZ_RNDR_RZNE_PARM_FG_LOD,
FZ_RNDR_RZNE_PARM_FG_LOD_CUSTOM,
FZ_RNDR_RZNE_PARM_FG_ADD_RADIOS,
FZ_RNDR_RZNE_PARM_FG_RADIOS_TIME,
FZ_RNDR_RZNE_PARM_FG_RADIOS_BBOX,
FZ_RNDR_RZNE_PARM_FG_RADIOS_KEEP,
FZ_RNDR_RZNE_PARM_FG_RADIOS_QUAL,
FZ_RNDR_RZNE_PARM_FG_SPEC,
FZ_RNDR_RZNE_PARM_FG_SPEC_RAYS,
FZ_RNDR_RZNE_PARM_FG_SCALE,
FZ_RNDR_RZNE_PARM_FG_SAMP_RADIUS,
FZ_RNDR_RZNE_PARM_FG_MIN_RADIUS,
FZ_RNDR_RZNE_PARM_FG_MAX_RADIUS,
FZ_RNDR_RZNE_PARM_FG_MAX_LENGTH,
FZ_RNDR_RZNE_PARM_FG_NUM_RAYS,
FZ_RNDR_RZNE_PARM_FG_INTERP,
FZ_RNDR_RZNE_PARM_FG_BEST_DOME };
Members
FZ_RNDR_RZNE_PARM_TYPE_OBSOLETE
This parameter is no longer supported. it is replaced by the new FZ_RNDR_RZNE_PARM_STYLE parameter.
Type: fz_rndr_rzne_type_enum
Default Value: FZ_RNDR_RZNE_TYPE_FULL_ZBUFFER
FZ_RNDR_RZNE_PARM_MAX_RAYS
Maximum number of recursive rays.
Type: short
Default Value: 8
Range: 1 <= value <= 64
FZ_RNDR_RZNE_PARM_MAX_POLYS_BVOL
Maximum number of polygons per bounded volume.
Type: short
Default Value: 8
Range: 1 <= value <= 32767
FZ_RNDR_RZNE_PARM_MAX_DEPTH_BVOL
Maximum depth of bounding volume subdivision.
Type: short
Default Value: 8
Range: 1 <= value <= 16
FZ_RNDR_RZNE_PARM_MIN_RAY_CONTRIB
Minimum ray contribution.
Type: float
Default Value: 0.1
Range: 0.0 <= value <= 1.0
FZ_RNDR_RZNE_PARM_AA_THRESHOLD
Anti-alias sampling threshold.
Type: float
Default Value: 0.1
Range: 0.0 <= value <= 1.0
FZ_RNDR_RZNE_PARM_EST_MEM_USAGE
Whether or not to display estimated memory usage.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_SET_IMG_SIZE_OBSOLETE
Whether or not to "set image size". No longer used.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_SHADOWS
Whether or not to have shadows.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_SHAD_MENU
What type of shadows to calculate.
Type: fz_rndr_shadows_enum
Default Value: FZ_RNDR_SHADOWS_LITE
FZ_RNDR_RZNE_PARM_TEXTURES
Whether or not to have textures.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_REFL
Whether or not to have reflections.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_TRNS
Whether or not to have transparencies.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_BUMP
Whether or not to have bump mapping.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_SHDR_AA
Whether or not to anti-alias shaders.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_SUPER
Whether or not to super sample.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_SUPER_MENU
What level of super sampling.
Type: fz_rndr_rzne_ssample_enum
Default Value: FZ_RNDR_RZNE_SSAMPLE_LOW
FZ_RNDR_RZNE_PARM_LITE_MENU
How to deal with light intensities.
Type: fz_rndr_rzne_lite_intens_enum
Default Value: FZ_RNDR_RZNE_LITE_INTENS_LITE
FZ_RNDR_RZNE_PARM_AREA_LN_MENU
How to deal with area/line lights
Type: fz_rndr_rzne_lite_area_ln_enum
Default Value: FZ_RNDR_RZNE_LITE_AREA_LN_USE
FZ_RNDR_RZNE_PARM_LITE_GLOW
Whether or not to have light glow.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_ALYS
Whether or not to analyze lighting.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_DCMP
Whether or not to decompose non-planar faces.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_SCALE
Whether or not to do wire frame line width by scale.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_SCALE_BY
Value to scale wire frame line width by.
Type: float
Default Value: 1.0
Range: 0.001 <= value <= 32.0
FZ_RNDR_RZNE_PARM_SET
Whether or not to do wire frame line width by absolute pixel size.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_SET_TO
Absolute value for wire frame line width.
Type: short
Default Value: 1
Range: 1 <= value <= 32
FZ_RNDR_RZNE_PARM_BGND_SHDR
Background shader.
Type: fz_shdr_ptr
Default Value: Project Color
FZ_RNDR_RZNE_PARM_ENVR
Whether or not to have environment mapping.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_ENVR_TYPE
How to environment map.
Type: fz_rndr_rzne_envr_type_enum
Default Value: FZ_RNDR_RZNE_ENVR_TYPE_SPHERICAL
FZ_RNDR_RZNE_PARM_ENVR_SHDR
Environment shader.
Type: fz_shdr_ptr
Default Value: Environment Map
FZ_RNDR_RZNE_PARM_ENVR_RES
Number of pixels for environment map.
Type: fzrt_int
Default Value: 256
Range: 32 <= value <= 16384
FZ_RNDR_RZNE_PARM_DEPTH_EFFECT
Whether or not to have depth effect (foreground shader).
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_FORE_SHDR
Foreground shader (depth effect).
Type: fz_shdr_ptr
Default Value: Fog
FZ_RNDR_RZNE_PARM_APPLY_ALPHA
Whether or not to apply alpha channel.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_GEN_POSTP
Whether or not to generate post-process data.
Type: fzrt_boolean
Default Value: TRUE
FZ_RNDR_RZNE_PARM_EXP_COR
Whether or not to correct exposure.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_DEPTH_BLUR
Whether or not to have depth blur.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_LENS_FLARE
Whether or not to have lens flare.
Type: fzrt_boolean
Default Value: FALSE
FZ_RNDR_RZNE_PARM_STYLE
What type of shading or raytrace algorithm to use for rendering.
Type: fz_rndr_rzne_style_enum
Default Value: FZ_RNDR_RZNE_STYLE_ZBUFFER
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GEOM_SILH
Silhouette quality used when rendering smooth objects using their mathematical surface definition rather than their facets.
Type: float
Default Value: 1
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GEOM_SURF
Surface quality used when rendering smooth objects using their mathematical surface definition rather than their facets.
Type: float
Default Value: 0.5
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GI_AO
Whether or not to enable Ambient Occlusion.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GI_FG
Whether or not to enable Final Gather.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GI_SCENE_SIZE
Global Illumination scene size preset.
Type: fz_rndr_rzne_gi_scene_size_enum
Default Value: FZ_RNDR_RZNE_GI_SCENE_SIZE_ROOM
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GI_SCENE_SIZE_CUSTOM
Global Illumination scene size custom value.
Type: double
Range: value >= 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_GI_QUALITY
Global Illumination simple quality preset.
Type: fz_rndr_rzne_gi_quality_enum
Default Value: FZ_RNDR_RZNE_GI_QUALITY_3
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_DIST
Ambient Occlusion distance.
Type: fz_rndr_rzne_ao_dist_enum
Default Value: FZ_RNDR_RZNE_AO_DIST_MED
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_DIST_CUSTOM
Ambient Occlusion custom distance value.
Type: double
Range: value >= 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_CONTRAST
Ambient Occlusion contrast.
Type: float
Default Value: 1.0
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_FALLOFF
Ambient Occlusion falloff.
Type: float
Default Value: 0.5
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_ADD_CONTRAST
Ambient Occlusion additional contrast.
Type: float
Default Value: 0.0
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_ADD_NOISE
Whether or not to add noise to Ambient Occlusion.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_AO_NUM_RAYS
Number of rays to use for the Ambient Occlusion quality.
Type: fzrt_int
Range: value >= 10
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_LOD
Final Gather level of detail.
Type: fz_rndr_rzne_fg_lod_enum
Default Value: FZ_RNDR_RZNE_FG_LOD_2
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_LOD_CUSTOM
Final Gather level of detail custom value.
Type: double
Range: value > 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_ADD_RADIOS
Whether or not to add Radiosity solution to Final Gather solution.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_RADIOS_TIME
Amount of time (in secs) to spend computing Radiosity solution for Final Gather.
Type: float
Default Value: 60
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_RADIOS_BBOX
Whether or not to use bounding box in the Radiosity solution for Final Gather.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_RADIOS_KEEP
Whether or not to keep the Radiosity solution between renderings for Final Gather.
Type: fzrt_boolean
Default Value: TRUE
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_RADIOS_QUAL
Quality of the Radiosity solution for Final Gather.
Type: float
Default Value: 0.5
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_SPEC
Whether or not to include Specular calculations in Final Gather.
Type: fz_rndr_rzne_fg_spec_enum
Default Value: FZ_RNDR_RZNE_FG_SPEC_DIRECT_NO_DOME
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_SPEC_RAYS
Number of rays to use for the Specular calculations in Final Gather.
Type: fzrt_int
Default Value: 100
Range: value >= 11
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_SCALE
Amount to scale Final Gather results.
Type: float
Default Value: 1.0
Range: value >= 0.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_SAMP_RADIUS
Final Gather initial sampling radius (in pixels).
Type: float
Range: 2 <= value <= 20
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_MIN_RADIUS
Final Gather sampling minimum radius.
Type: float
Range: value > 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_MAX_RADIUS
Final Gather sampling maximum radius.
Type: float
Range: value > 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_MAX_LENGTH
Final Gather maximum ray length.
Type: float
Range: value > 0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_NUM_RAYS
Number of rays to use for Final Gather calculations.
Type: fzrt_int
Range: value >= 101
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_INTERP
Final Gather interpolation quality
Type: float
Range: 0.0 <= value <= 1.0
Availability: 6.5.0.0
FZ_RNDR_RZNE_PARM_FG_BEST_DOME
Whether or not to have best dome light quality for Final Gather.
Type: fzrt_boolean
Default Value: FALSE
Availability: 6.5.0.0
Availability
5.0.0.0
Defined in