formZ SDK | 5.0 API Reference | Project | Modeling | Lights Manager

# fz_lite_parm_env_enum

Description

Parameter identifiers for an environment light. Used for the "which" argument of fz_lite_get_parm_environment and fz_lite_get_parm_environment.

enum fz_lite_parm_env_enum {

FZ_LITE_PARM_ENV_MAP_TYPE,

FZ_LITE_PARM_ENV_FINITE,

FZ_LITE_PARM_ENV_FINIT_CENTER,

FZ_LITE_PARM_ENV_FINIT_SIZE,

FZ_LITE_PARM_ENV_CUBIC_SINGLE_MAP,

FZ_LITE_PARM_ENV_CUBIC_MAP_CROSS,

FZ_LITE_PARM_ENV_CUBIC_MAP_TOP,

FZ_LITE_PARM_ENV_CUBIC_MAP_BOTTOM,

FZ_LITE_PARM_ENV_CUBIC_MAP_LEFT,

FZ_LITE_PARM_ENV_CUBIC_MAP_RIGHT,

FZ_LITE_PARM_ENV_CUBIC_MAP_FRONT,

FZ_LITE_PARM_ENV_CUBIC_MAP_BACK,

FZ_LITE_PARM_ENV_SPHERIC_MAP,

FZ_LITE_PARM_ENV_SPHERIC_LAYOUT_TYPE,

FZ_LITE_PARM_ENV_NUM_SAMPLES,

FZ_LITE_PARM_ENV_SOFTNESS,

FZ_LITE_PARM_ENV_COLOR_FACTOR };

Members

FZ_LITE_PARM_ENV_MAP_TYPE

How to environment map.

Type: fz_rndr_rzne_envr_type_enum

Default Value: FZ_RNDR_RZNE_ENVR_TYPE_CUBIC

FZ_LITE_PARM_ENV_FINITE

is the environment considered finite (TRUE) or infinite (FALSE).

Type: fzrt_boolean

Default Value: FALSE

FZ_LITE_PARM_ENV_FINIT_CENTER

The center of the environment, if it is set to be finite.

Type: fz_xyz_td

Default Value: {0,0,0}

FZ_LITE_PARM_ENV_FINIT_SIZE

The size of the environment, if it is set to be finite.

Type: double

Default Value: 10,000 feet

FZ_LITE_PARM_ENV_CUBIC_SINGLE_MAP

TRUE if using a single (cross) cubic map. FALSE if using six individual maps.

Type: fzrt_boolean

Default Value: FALSE

FZ_LITE_PARM_ENV_CUBIC_MAP_CROSS

Environment light's cubic cross map.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_TOP

Environment light's cubic map at the top.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_BOTTOM

Environment light's cubic map at the bottom.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_LEFT

Environment light's cubic map at the left.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_RIGHT

Environment light's cubic map at the right.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_FRONT

Environment light's cubic map at the front.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_CUBIC_MAP_BACK

Environment light's cubic map at the back.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_SPHERIC_MAP

Environment light's spherical map.

Type: fz_tmap_ptr

FZ_LITE_PARM_ENV_SPHERIC_LAYOUT_TYPE

The layout type of the spherical environment map.

Type: fz_rndr_rzne_envr_sphr_layout_enum

Default Value: FZ_RNDR_RZNE_ENVR_SPHR_LAYOUT_SPHERIC

FZ_LITE_PARM_ENV_NUM_SAMPLES

The number of samples to be used for the environment light.

Type: fzrt_int

Range: value >= 3

Default Value: 10

FZ_LITE_PARM_ENV_SOFTNESS

The softness parameter to be used for the environment light.

Type: double

Range: value >= 0.0

Default Value: 0.5

FZ_LITE_PARM_ENV_COLOR_FACTOR

The color factor parameter to be used for the environment light.

Type: double

Range: 0.0 <= value <= 2.0

Default Value: 0.5

Availability

5.0.0.0

See Also

fz_lite_set_parm_environment_obsolete

Defined in

fz_lite_api.h