Built in Entities - appleseedhq/appleseed GitHub Wiki
For convenience, appleseed includes a number of built-in entity models, providing a robust foundation with no external dependencies. This document describes these built-in entity models in details.
This document was generated automatically using the dumpmetadata tool that ships with appleseed.
In Windows the command to save the output as a markdown file named metadata.md would be: dumpmetadata.exe --format markdown > metadata.md
1. Built-in AOV Models
1.1. The albedo_aov Model
1.2. The cryptomatte_material_aov Model
1.3. The cryptomatte_object_aov Model
1.4. The depth_aov Model
1.5. The diffuse_aov Model
1.6. The direct_diffuse_aov Model
1.7. The direct_glossy_aov Model
1.8. The emission_aov Model
1.9. The glossy_aov Model
1.10. The indirect_diffuse_aov Model
1.11. The indirect_glossy_aov Model
1.12. The invalid_samples_aov Model
1.13. The normal_aov Model
1.14. The npr_contour_aov Model
1.15. The npr_shading_aov Model
1.16. The pixel_error_aov Model
1.17. The pixel_sample_count_aov Model
1.18. The pixel_time_aov Model
1.19. The pixel_variation_aov Model
1.20. The position_aov Model
1.21. The screen_space_velocity_aov Model
1.22. The uv_aov Model
2. Built-in BSDF Models
2.1. The ashikhmin_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
diffuse_reflectance |
Diffuse Reflectance |
required |
0.5 |
|
diffuse_reflectance_multiplier |
Diffuse Reflectance Multiplier |
optional |
1.0 |
|
glossy_reflectance |
Glossy Reflectance |
required |
0.5 |
|
glossy_reflectance_multiplier |
Glossy Reflectance Multiplier |
optional |
1.0 |
|
fresnel_multiplier |
Fresnel Multiplier |
optional |
1.0 |
|
shininess_u |
Shininess U |
required |
100.0 |
|
shininess_v |
Shininess V |
required |
100.0 |
|
2.2. The blinn_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
exponent |
Exponent |
required |
0.5 |
|
ior |
Index of Refraction |
required |
1.5 |
|
2.3. The bsdf_blend Model
| Parameter |
Label |
Presence |
Default |
Description |
bsdf0 |
BSDF 1 |
required |
None |
|
bsdf1 |
BSDF 2 |
required |
None |
|
weight |
Weight |
required |
0.5 |
|
2.4. The bsdf_mix Model
| Parameter |
Label |
Presence |
Default |
Description |
bsdf0 |
BSDF 1 |
required |
None |
|
weight0 |
Weight 1 |
required |
0.5 |
|
bsdf1 |
BSDF 2 |
required |
None |
|
weight1 |
Weight 2 |
required |
0.5 |
|
2.5. The diffuse_btdf Model
| Parameter |
Label |
Presence |
Default |
Description |
transmittance |
Transmittance |
required |
0.5 |
|
transmittance_multiplier |
Transmittance Multiplier |
optional |
1.0 |
|
2.6. The disney_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
base_color |
Base Color |
required |
0.9 |
|
subsurface |
Subsurface |
optional |
0.0 |
|
metallic |
Metallic |
optional |
0.0 |
|
specular |
Specular |
optional |
0.0 |
|
specular_tint |
Specular Tint |
optional |
0.0 |
|
anisotropic |
Anisotropic |
optional |
0.0 |
|
roughness |
Roughness |
optional |
0.1 |
|
sheen |
Sheen |
optional |
0.0 |
|
sheen_tint |
Sheen Tint |
optional |
0.0 |
|
clearcoat |
Clearcoat |
optional |
0.0 |
|
clearcoat_gloss |
Clearcoat Gloss |
optional |
1.0 |
|
2.7. The glass_bsdf Model
| Parameter |
Label |
Presence |
Default |
Description |
surface_transmittance |
Surface Transmittance |
required |
0.99 |
|
surface_transmittance_multiplier |
Surface Transmittance Multiplier |
optional |
1.0 |
|
reflection_tint |
Reflection Tint |
optional |
1.0 |
|
refraction_tint |
Refraction Tint |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.5 |
|
roughness |
Roughness |
optional |
0.15 |
|
anisotropy |
Anisotropy |
optional |
0.0 |
|
volume_parameterization |
Volume Absorption Parameterization |
required |
transmittance |
Possible values are: absorption (Absorption), transmittance (Transmittance). |
volume_transmittance |
Volume Transmittance |
optional |
1.0 |
|
volume_transmittance_distance |
Volume Transmittance Distance |
optional |
0.0 |
|
volume_absorption |
Volume Absorption |
optional |
0.0 |
|
volume_density |
Volume Density |
optional |
0.0 |
|
volume_scale |
Volume Scale |
optional |
1.0 |
|
energy_compensation |
Energy Compensation |
optional |
0.0 |
|
2.8. The glossy_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.75 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
anisotropy |
Anisotropy |
optional |
0.0 |
|
ior |
Index of Refraction |
required |
1.5 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
energy_compensation |
Energy Compensation |
optional |
0.0 |
|
2.9. The hair_bsdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.0 |
|
melanin |
Melanin Concentration |
optional |
0.3 |
|
melanin_redness |
Melanin Redness |
optional |
0.0 |
|
eta |
Index of Refraction |
optional |
1.55 |
|
beta_M |
Longitudinal Roughness |
optional |
0.3 |
|
beta_N |
Azimuthal Roughness |
optional |
0.3 |
|
alpha |
Cuticle Scale Angle |
optional |
2.0 |
|
2.10. The kelemen_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
matte_reflectance |
Matte Reflectance |
required |
0.5 |
|
matte_reflectance_multiplier |
Matte Reflectance Multiplier |
optional |
1.0 |
|
specular_reflectance |
Specular Reflectance |
required |
0.5 |
|
specular_reflectance_multiplier |
Specular Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
required |
0.5 |
|
2.11. The lambertian_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
2.12. The metal_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
normal_reflectance |
Normal Reflectance |
required |
0.92 |
|
edge_tint |
Edge Tint |
required |
0.98 |
|
edge_tint_weight |
Edge Tint Weight |
optional |
1.0 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
anisotropy |
Anisotropy |
optional |
0.0 |
|
energy_compensation |
Energy Compensation |
optional |
0.0 |
|
2.13. The microfacet_normal_mapping_blinn_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
exponent |
Exponent |
required |
0.5 |
|
ior |
Index of Refraction |
required |
1.5 |
|
2.14. The microfacet_normal_mapping_glossy_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.75 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
anisotropy |
Anisotropy |
optional |
0.0 |
|
ior |
Index of Refraction |
required |
1.5 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
energy_compensation |
Energy Compensation |
optional |
0.0 |
|
2.15. The microfacet_normal_mapping_lambertian_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
2.16. The microfacet_normal_mapping_metal_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
normal_reflectance |
Normal Reflectance |
required |
0.92 |
|
edge_tint |
Edge Tint |
required |
0.98 |
|
edge_tint_weight |
Edge Tint Weight |
optional |
1.0 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
anisotropy |
Anisotropy |
optional |
0.0 |
|
energy_compensation |
Energy Compensation |
optional |
0.0 |
|
2.17. The microfacet_normal_mapping_plastic_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
diffuse_reflectance |
Diffuse Reflectance |
required |
0.5 |
|
diffuse_reflectance_multiplier |
Diffuse Reflectance Multiplier |
optional |
1.0 |
|
specular_reflectance |
Specular Reflectance |
required |
1.0 |
|
specular_reflectance_multiplier |
Specular Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
ior |
Index of Refraction |
required |
1.5 |
|
internal_scattering |
Internal Scattering |
optional |
1.0 |
|
2.18. The microfacet_normal_mapping_sheen_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
2.19. The orennayar_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
required |
0.1 |
|
2.20. The plastic_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
diffuse_reflectance |
Diffuse Reflectance |
required |
0.5 |
|
diffuse_reflectance_multiplier |
Diffuse Reflectance Multiplier |
optional |
1.0 |
|
specular_reflectance |
Specular Reflectance |
required |
1.0 |
|
specular_reflectance_multiplier |
Specular Reflectance Multiplier |
optional |
1.0 |
|
roughness |
Roughness |
optional |
0.15 |
|
ior |
Index of Refraction |
required |
1.5 |
|
internal_scattering |
Internal Scattering |
optional |
1.0 |
|
2.21. The sheen_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
2.22. The specular_brdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
2.23. The specular_btdf Model
| Parameter |
Label |
Presence |
Default |
Description |
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
transmittance |
Transmittance |
required |
0.5 |
|
transmittance_multiplier |
Transmittance Multiplier |
optional |
1.0 |
|
fresnel_multiplier |
Fresnel Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.5 |
|
volume_density |
Volume Density |
optional |
0.0 |
|
volume_scale |
Volume Scale |
optional |
1.0 |
|
3. Built-in BSSRDF Models
3.1. The better_dipole_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Diffuse Surface Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Diffuse Surface Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
3.2. The directional_dipole_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Diffuse Surface Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Diffuse Surface Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
3.3. The gaussian_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
3.4. The normalized_diffusion_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Diffuse Surface Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Diffuse Surface Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
3.5. The randomwalk_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Diffuse Surface Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Diffuse Surface Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
volume_anisotropy |
Volume Anisotropy |
optional |
0.0 |
|
surface_bsdf_model |
Surface BSDF Model |
optional |
diffuse |
Possible values are: diffuse (Diffuse BTDF), glass (Glass BSDF). |
surface_roughness |
Surface Roughness |
optional |
1.0 |
|
3.6. The standard_dipole_bssrdf Model
| Parameter |
Label |
Presence |
Default |
Description |
weight |
Weight |
optional |
1.0 |
|
reflectance |
Diffuse Surface Reflectance |
required |
0.5 |
|
reflectance_multiplier |
Diffuse Surface Reflectance Multiplier |
optional |
1.0 |
|
mfp |
Mean Free Path |
required |
0.5 |
|
mfp_multiplier |
Mean Free Path Multiplier |
optional |
1.0 |
|
ior |
Index of Refraction |
required |
1.3 |
|
fresnel_weight |
Fresnel Weight |
optional |
1.0 |
|
4. Built-in Camera Models
4.1. The fisheyelens_camera Model
| Parameter |
Label |
Presence |
Default |
Description |
shutter_open_begin_time |
Shutter Open Begin Time |
optional |
0.0 |
|
shutter_open_end_time |
Shutter Open End Time |
optional |
0.0 |
|
shutter_close_begin_time |
Shutter Close Begin Time |
optional |
1.0 |
|
shutter_close_end_time |
Shutter Close End Time |
optional |
1.0 |
|
shutter_curve_control_points |
Shutter Curve Control Points |
optional |
None |
|
film_dimensions |
Film Dimensions |
required |
None |
|
film_width |
Film Width |
required |
None |
|
film_height |
Film Height |
required |
None |
|
aspect_ratio |
Aspect Ratio |
required |
None |
|
focal_length |
Focal Length |
required |
None |
|
horizontal_fov |
Horizontal FOV |
required |
None |
|
near_z |
Near Z |
optional |
-0.001 |
|
shift_x |
Shift X |
optional |
0.0 |
|
shift_y |
Shift Y |
optional |
0.0 |
|
projection_type |
Projection Type |
required |
equisolid_angle |
Possible values are: equidistant (Equidistant), equisolid_angle (Equisolid Angle), stereographic (Stereographic), thoby (Thoby). |
4.2. The orthographic_camera Model
| Parameter |
Label |
Presence |
Default |
Description |
shutter_open_begin_time |
Shutter Open Begin Time |
optional |
0.0 |
|
shutter_open_end_time |
Shutter Open End Time |
optional |
0.0 |
|
shutter_close_begin_time |
Shutter Close Begin Time |
optional |
1.0 |
|
shutter_close_end_time |
Shutter Close End Time |
optional |
1.0 |
|
shutter_curve_control_points |
Shutter Curve Control Points |
optional |
None |
|
film_dimensions |
Film Dimensions |
required |
None |
|
film_width |
Film Width |
required |
None |
|
film_height |
Film Height |
required |
None |
|
aspect_ratio |
Aspect Ratio |
required |
None |
|
near_z |
Near Z |
optional |
-0.001 |
|
4.3. The pinhole_camera Model
| Parameter |
Label |
Presence |
Default |
Description |
shutter_open_begin_time |
Shutter Open Begin Time |
optional |
0.0 |
|
shutter_open_end_time |
Shutter Open End Time |
optional |
0.0 |
|
shutter_close_begin_time |
Shutter Close Begin Time |
optional |
1.0 |
|
shutter_close_end_time |
Shutter Close End Time |
optional |
1.0 |
|
shutter_curve_control_points |
Shutter Curve Control Points |
optional |
None |
|
film_dimensions |
Film Dimensions |
required |
None |
|
film_width |
Film Width |
required |
None |
|
film_height |
Film Height |
required |
None |
|
aspect_ratio |
Aspect Ratio |
required |
None |
|
focal_length |
Focal Length |
required |
None |
|
horizontal_fov |
Horizontal FOV |
required |
None |
|
near_z |
Near Z |
optional |
-0.001 |
|
shift_x |
Shift X |
optional |
0.0 |
|
shift_y |
Shift Y |
optional |
0.0 |
|
4.4. The spherical_camera Model
| Parameter |
Label |
Presence |
Default |
Description |
shutter_open_begin_time |
Shutter Open Begin Time |
optional |
0.0 |
|
shutter_open_end_time |
Shutter Open End Time |
optional |
0.0 |
|
shutter_close_begin_time |
Shutter Close Begin Time |
optional |
1.0 |
|
shutter_close_end_time |
Shutter Close End Time |
optional |
1.0 |
|
shutter_curve_control_points |
Shutter Curve Control Points |
optional |
None |
|
4.5. The thinlens_camera Model
| Parameter |
Label |
Presence |
Default |
Description |
shutter_open_begin_time |
Shutter Open Begin Time |
optional |
0.0 |
|
shutter_open_end_time |
Shutter Open End Time |
optional |
0.0 |
|
shutter_close_begin_time |
Shutter Close Begin Time |
optional |
1.0 |
|
shutter_close_end_time |
Shutter Close End Time |
optional |
1.0 |
|
shutter_curve_control_points |
Shutter Curve Control Points |
optional |
None |
|
film_dimensions |
Film Dimensions |
required |
None |
|
film_width |
Film Width |
required |
None |
|
film_height |
Film Height |
required |
None |
|
aspect_ratio |
Aspect Ratio |
required |
None |
|
focal_length |
Focal Length |
required |
None |
|
horizontal_fov |
Horizontal FOV |
required |
None |
|
f_stop |
F-number |
required |
8.0 |
|
autofocus_enabled |
Enable autofocus |
optional |
true |
|
focal_distance |
Focal Distance |
optional |
1.0 |
|
autofocus_target |
Autofocus Target |
optional |
0.5 0.5 |
|
diaphragm_blades |
Diaphragm Blades |
optional |
0 |
|
diaphragm_tilt_angle |
Diaphragm Tilt Angle |
optional |
0.0 |
|
diaphragm_map |
Diaphragm Map |
optional |
None |
|
near_z |
Near Z |
optional |
-0.001 |
|
shift_x |
Shift X |
optional |
0.0 |
|
shift_y |
Shift Y |
optional |
0.0 |
|
5.1. The color Model
| Parameter |
Label |
Presence |
Default |
Description |
color_space |
Color Space |
required |
srgb |
Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), spectral (Spectral), srgb (sRGB). |
wavelength_range |
Wavelength Range |
optional |
400.0 700.0 |
|
color |
Color |
required |
0.0 0.0 0.0 |
|
alpha |
Alpha |
optional |
1.0 |
|
multiplier |
Multiplier |
optional |
1.0 |
|
6. Built-in EDF Models
6.1. The cone_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
radiance |
Radiance |
required |
1.0 |
|
radiance_multiplier |
Radiance Multiplier |
optional |
1.0 |
|
exposure |
Exposure |
optional |
0.0 |
Exposure |
angle |
Angle |
required |
90.0 |
|
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, area lights using this material contribute to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for area lights using this material with respect to the other area lights |
light_near_start |
Light Near Start |
optional |
0.0 |
|
6.2. The diffuse_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
radiance |
Radiance |
required |
1.0 |
|
radiance_multiplier |
Radiance Multiplier |
optional |
1.0 |
|
exposure |
Exposure |
optional |
0.0 |
Exposure |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, area lights using this material contribute to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for area lights using this material with respect to the other area lights |
light_near_start |
Light Near Start |
optional |
0.0 |
|
7.1. The generic_environment Model
| Parameter |
Label |
Presence |
Default |
Description |
environment_edf |
Environment EDF |
optional |
None |
|
environment_shader |
Environment Shader |
optional |
None |
|
8. Built-in Environment EDF Models
8.1. The constant_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
radiance |
Radiance |
required |
1.0 |
Environment radiance |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.2. The constant_hemisphere_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
upper_hemi_radiance |
Upper Hemisphere Radiance |
required |
0.7 |
Upper hemisphere radiance |
lower_hemi_radiance |
Lower Hemisphere Radiance |
required |
0.3 |
Lower hemisphere radiance |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.3. The gradient_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
horizon_radiance |
Horizon Radiance |
required |
0.3 |
Horizon radiance |
zenith_radiance |
Zenith Radiance |
required |
0.7 |
Zenith radiance |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.4. The hosek_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
sun_theta |
Sun Theta Angle |
required |
45.0 |
Sun polar (vertical) angle in degrees |
sun_phi |
Sun Phi Angle |
required |
0.0 |
Sun azimuthal (horizontal) angle in degrees |
turbidity |
Turbidity |
required |
1.0 |
Atmospheric haziness |
turbidity_multiplier |
Turbidity Multiplier |
optional |
2.0 |
Atmospheric haziness multiplier |
luminance_multiplier |
Luminance Multiplier |
optional |
1.0 |
Sky luminance multiplier |
luminance_gamma |
Luminance Gamma |
optional |
1.0 |
Sky luminance gamma |
saturation_multiplier |
Saturation Multiplier |
optional |
1.0 |
Sky color saturation multiplier |
horizon_shift |
Horizon Shift |
optional |
0.0 |
Shift the horizon vertically |
ground_albedo |
Ground Albedo |
optional |
0.3 |
Ground albedo (reflection coefficient of the ground) |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.5. The latlong_map_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
radiance |
Radiance |
required |
1.0 |
Environment texture |
radiance_multiplier |
Radiance Multiplier |
optional |
1.0 |
Environment texture radiance multiplier |
exposure |
Exposure |
optional |
0.0 |
Environment exposure |
horizontal_shift |
Horizontal Shift |
optional |
0.0 |
Environment texture horizontal shift in degrees |
vertical_shift |
Vertical Shift |
optional |
0.0 |
Environment texture vertical shift in degrees |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.6. The mirrorball_map_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
radiance |
Radiance |
required |
1.0 |
Environment texture |
radiance_multiplier |
Radiance Multiplier |
optional |
1.0 |
Environment texture radiance multiplier |
exposure |
Exposure |
optional |
0.0 |
Environment exposure |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.7. The osl_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
osl_background |
OSL Background |
optional |
None |
|
importance_map_size |
Importance Map size |
optional |
1024 |
Importance map size: width = size, height = size/2 |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
8.8. The preetham_environment_edf Model
| Parameter |
Label |
Presence |
Default |
Description |
sun_theta |
Sun Theta Angle |
required |
45.0 |
Sun polar (vertical) angle in degrees |
sun_phi |
Sun Phi Angle |
required |
0.0 |
Sun azimuthal (horizontal) angle in degrees |
turbidity |
Turbidity |
required |
1.0 |
Atmospheric haziness |
turbidity_multiplier |
Turbidity Multiplier |
optional |
2.0 |
Atmospheric haziness multiplier |
luminance_multiplier |
Luminance Multiplier |
optional |
1.0 |
Sky luminance multiplier |
luminance_gamma |
Luminance Gamma |
optional |
1.0 |
Sky luminance gamma |
saturation_multiplier |
Saturation Multiplier |
optional |
1.0 |
Sky color saturation multiplier |
horizon_shift |
Horizon Shift |
optional |
0.0 |
Shift the horizon vertically |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, the environment casts shadows |
9. Built-in Environment Shader Models
9.1. The background_environment_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
color |
Color |
required |
0.5 |
|
alpha |
Alpha |
optional |
1.0 |
|
9.2. The edf_environment_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
environment_edf |
Environment EDF |
required |
None |
|
alpha_value |
Alpha Value |
optional |
1.0 |
|
10.1. The frame Model
| Parameter |
Label |
Presence |
Default |
Description |
camera |
Camera |
optional |
None |
|
resolution |
Resolution |
required |
None |
|
crop_window |
Crop Window |
optional |
None |
|
tile_size |
Tile Size |
required |
None |
|
filter |
Filter |
optional |
blackman-harris |
Possible values are: blackman-harris (Blackman-Harris), box (Box), gaussian (Gaussian), triangle (Triangle). |
filter_size |
Filter Size |
optional |
1.5 |
|
noise_seed |
Noise Seed |
optional |
0 |
|
enable_dithering |
Dithering |
optional |
true |
|
denoiser |
Denoiser |
required |
off |
Possible values are: off (Off), on (On), write_outputs (Write Outputs). |
skip_denoised |
Skip Denoised Pixels |
optional |
true |
|
random_pixel_order |
Random Pixel Order |
optional |
true |
|
prefilter_spikes |
Prefilter Spikes |
optional |
true |
|
spike_threshold |
Spike Threshold |
optional |
2.0 |
|
patch_distance_threshold |
Patch Distance |
optional |
1.0 |
|
denoise_scales |
Denoise Scales |
optional |
3 |
|
mark_invalid_pixels |
Mark Invalid Pixels |
optional |
false |
|
11. Built-in Light Models
11.1. The directional_light Model
| Parameter |
Label |
Presence |
Default |
Description |
irradiance |
Irradiance |
required |
1.0 |
Light intensity |
irradiance_multiplier |
Irradiance Multiplier |
optional |
1.0 |
Light intensity multiplier |
exposure |
Exposure |
optional |
0.0 |
Light exposure |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
11.2. The max_omni_light Model
| Parameter |
Label |
Presence |
Default |
Description |
intensity |
Intensity |
required |
1.0 |
Light intensity |
intensity_multiplier |
Intensity Multiplier |
optional |
1.0 |
Light intensity multiplier |
decay_start |
Decay Start |
optional |
0.0 |
Distance at which light decay starts |
decay_exponent |
Decay Exponent |
optional |
2.0 |
Exponent of the light decay function |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
11.3. The max_spot_light Model
| Parameter |
Label |
Presence |
Default |
Description |
intensity |
Intensity |
required |
1.0 |
Light intensity |
intensity_multiplier |
Intensity Multiplier |
optional |
1.0 |
Light intensity multiplier |
inner_angle |
Inner Angle |
required |
20.0 |
Cone distribution inner angle |
outer_angle |
Outer Angle |
required |
30.0 |
Cone distribution outer angle |
tilt_angle |
Tilt Angle |
optional |
0.0 |
Rotate the spot light around its axis; only useful when using the light intensity is textured (gobo) |
decay_start |
Decay Start |
optional |
0.0 |
Distance at which light decay starts |
decay_exponent |
Decay Exponent |
optional |
2.0 |
Exponent of the light decay function |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
11.4. The point_light Model
| Parameter |
Label |
Presence |
Default |
Description |
intensity |
Intensity |
required |
1.0 |
Light intensity |
intensity_multiplier |
Intensity Multiplier |
optional |
1.0 |
Light intensity multiplier |
exposure |
Exposure |
optional |
0.0 |
Light exposure |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
11.5. The spot_light Model
| Parameter |
Label |
Presence |
Default |
Description |
intensity |
Intensity |
required |
1.0 |
Light intensity |
intensity_multiplier |
Intensity Multiplier |
optional |
1.0 |
Light intensity multiplier |
exposure |
Exposure |
optional |
0.0 |
Light exposure |
inner_angle |
Inner Angle |
required |
20.0 |
Cone distribution inner angle |
outer_angle |
Outer Angle |
required |
30.0 |
Cone distribution outer angle |
tilt_angle |
Tilt Angle |
optional |
0.0 |
Rotate the spot light around the emission axis; only useful when the light intensity is textured (gobo) |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
11.6. The sun_light Model
| Parameter |
Label |
Presence |
Default |
Description |
environment_edf |
Bind To |
optional |
None |
If an environment EDF is bound, use the sun angles and turbidity values from the environment |
turbidity |
Turbidity |
required |
2.0 |
Atmospheric haziness |
radiance_multiplier |
Radiance Multiplier |
optional |
1.0 |
Light intensity multiplier |
size_multiplier |
Size Multiplier |
optional |
1.0 |
The size multiplier allows to make the sun bigger or smaller, hence making it cast softer or harder shadows |
distance |
Distance |
optional |
149.6 |
Distance between Sun and scene (millions of km) |
cast_indirect_light |
Cast Indirect Light |
optional |
true |
If enabled, this light contributes to indirect lighting |
importance_multiplier |
Importance Multiplier |
optional |
1.0 |
Adjust the sampling effort for this light with respect to the other lights |
cast_shadows |
Cast Shadows |
optional |
true |
If enabled, this light casts shadows |
12. Built-in Material Models
12.1. The generic_material Model
| Parameter |
Label |
Presence |
Default |
Description |
surface_shader |
Surface Shader |
optional |
None |
|
bsdf |
BSDF |
optional |
None |
|
bssrdf |
BSSRDF |
optional |
None |
|
edf |
EDF |
optional |
None |
|
volume |
Volume |
optional |
None |
|
alpha_map |
Alpha Map |
optional |
None |
|
displacement_map |
Displacement Map |
optional |
None |
|
displacement_method |
Displacement Method |
required |
bump |
Possible values are: bump (Bump Mapping), normal (Normal Mapping). |
bump_amplitude |
Bump Amplitude |
optional |
1.0 |
|
bump_offset |
Bump Offset |
optional |
0.5 |
|
normal_map_up |
Normal Map Up Vector |
optional |
z |
Possible values are: z (Blue Channel (Z)), y (Green Channel (Y)). |
default_tangent_mode |
Default Tangent Mode |
optional |
uv |
Possible values are: local_x (Local X direction), local_y (Local Y direction), local_z (Local Z direction), radial (Radial), uv (UV Coordinates). |
12.2. The osl_material Model
| Parameter |
Label |
Presence |
Default |
Description |
surface_shader |
Surface Shader |
optional |
None |
|
osl_surface |
OSL Surface |
optional |
None |
|
alpha_map |
Alpha Map |
optional |
None |
|
default_tangent_mode |
Default Tangent Mode |
optional |
uv |
Possible values are: local_x (Local X direction), local_y (Local Y direction), local_z (Local Z direction), radial (Radial), uv (UV Coordinates). |
13. Built-in Object Models
13.1. The curve_object Model
13.2. The disk_object Model
| Parameter |
Label |
Presence |
Default |
Description |
radius |
Radius |
optional |
1.0 |
|
13.3. The mesh_object Model
| Parameter |
Label |
Presence |
Default |
Description |
alpha_map |
Alpha Map |
optional |
None |
|
13.4. The rectangle_object Model
| Parameter |
Label |
Presence |
Default |
Description |
width |
Width |
optional |
1.0 |
|
height |
Height |
optional |
1.0 |
|
13.5. The sphere_object Model
| Parameter |
Label |
Presence |
Default |
Description |
radius |
Radius |
optional |
1.0 |
|
14. Built-in Post-Processing Stage Models
14.1. The bloom_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
iterations |
Radius |
optional |
4 |
|
intensity |
Intensity |
optional |
0.1 |
|
threshold |
Threshold |
optional |
1.0 |
|
soft_knee |
Soft Knee |
optional |
0.5 |
|
debug_blur |
Debug Blur |
optional |
false |
|
14.2. The chromatic_aberration_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
strength |
Strength |
optional |
0.4 |
|
fringe_smoothness |
Fringe Smoothness |
optional |
6 |
|
14.3. The color_map_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
color_map |
Color Map |
required |
inferno |
Applied color map. Possible values are: custom (Custom), inferno (Inferno), jet (Jet), magma (Magma), plasma (Plasma), turbo (Turbo), viridis (Viridis). |
color_map_file_path |
Color Map File Path |
optional |
None |
Path to a custom color map image |
auto_range |
Auto Range |
optional |
true |
Maps the full range of luminance values to the color map |
range_min |
Range Min |
optional |
0.0 |
Luminance value mapped to the first row in the colormap |
range_max |
Range Max |
optional |
1.0 |
Luminance value mapped to the last row in the colormap |
add_legend_bar |
Add Legend Bar |
optional |
true |
Include a legend bar next to the color map |
legend_bar_ticks |
Legend Bar Ticks |
optional |
8 |
Set the number of divisions in the legend bar |
render_isolines |
Render Isolines |
optional |
false |
Draw lines of equal relative luminance |
line_thickness |
Line Thickness |
optional |
1.0 |
Set the thickness of luminance isolines |
14.4. The render_stamp_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
format_string |
Format String |
optional |
`appleseed {lib-version} |
Time: {render-time}` |
| Available predefined variables: |
|
|
|
|
| {lib-name}, {lib-version}, |
|
|
|
|
| {lib-cpu-features}, {lib-config}, |
|
|
|
|
| {lib-build-date}, {lib-build-time}, |
|
|
|
|
| {render-time}, {peak-memory} |
|
|
|
|
scale_factor |
Scale Factor |
optional |
1.0 |
Controls the size of the render stamp |
14.5. The tone_map_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
tone_map_operator |
Operator |
required |
linear |
Possible values are: aces_narkowicz (ACES (Narkowicz)), aces_unreal (ACES (Unreal)), filmic_hejl (Filmic (Hejl)), filmic_piecewise (Filmic (Piecewise)), filmic_uncharted (Filmic (Uncharted)), linear (Linear), reinhard (Reinhard), reinhard_extended (Reinhard (Extended)). |
clamp_colors |
Clamp Colors |
optional |
true |
|
aces_narkowicz_exposure_bias |
Exposure bias |
optional |
0.8 |
|
filmic_uncharted_A |
Shoulder Strength (A) |
optional |
0.22 |
|
filmic_uncharted_B |
Linear Strength (B) |
optional |
0.30 |
|
filmic_uncharted_C |
Linear Angle (C) |
optional |
0.10 |
|
filmic_uncharted_D |
Toe Strength (D) |
optional |
0.20 |
|
filmic_uncharted_E |
Toe Numerator (E) |
optional |
0.01 |
|
filmic_uncharted_F |
Toe Denominator (F) |
optional |
0.30 |
|
filmic_uncharted_W |
Linear white point |
optional |
11.2 |
|
filmic_uncharted_exposure_bias |
Exposure bias |
optional |
2.0 |
|
filmic_piecewise_toe_strength |
Toe Strength |
optional |
0.0 |
|
filmic_piecewise_toe_length |
Toe Length |
optional |
0.5 |
|
filmic_piecewise_shoulder_strength |
Shoulder Strength |
optional |
0.0 |
|
filmic_piecewise_shoulder_length |
Shoulder Length (F-stops) |
optional |
0.5 |
|
filmic_piecewise_shoulder_angle |
Shoulder Angle |
optional |
0.0 |
|
reinhard_use_luminance |
Use Luminance |
optional |
true |
|
reinhard_extended_max_white |
Max White |
optional |
1.0 |
|
reinhard_extended_use_luminance |
Use Luminance |
optional |
true |
|
14.6. The vignette_post_processing_stage Model
| Parameter |
Label |
Presence |
Default |
Description |
order |
Order |
required |
0 |
Determines the order in which this stage is applied |
intensity |
Intensity |
optional |
0.5 |
Strength of the vignetting effect |
| (higher values lead to stronger darkening of the image edges) |
|
|
|
|
anisotropy |
Anisotropy |
optional |
0.0 |
Vignette's degree of deviation from a circle |
| (0.0 = perfectly rounded, 1.0 = mimics the image aspect ratio) |
|
|
|
|
15. Built-in Surface Shader Models
15.1. The ao_surface_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
sampling_method |
Sampling Method |
required |
uniform |
Possible values are: cosine (Cosine-Weighted Sampling), uniform (Uniform Sampling). |
samples |
Samples |
required |
16 |
|
max_distance |
Maximum Occlusion Distance |
required |
1.0 |
|
15.2. The constant_surface_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
color |
Color |
required |
0.5 |
|
alpha_source |
Alpha Source |
optional |
color |
Possible values are: color (Alpha channel of the color), material (Alpha map of the object and/or material). |
color_multiplier |
Color Multiplier |
optional |
1.0 |
|
alpha_multiplier |
Alpha Multiplier |
optional |
1.0 |
|
15.3. The diagnostic_surface_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
mode |
Mode |
required |
coverage |
Possible values are: albedo (Albedo), ambient_occlusion (Ambient Occlusion), assemblies (Assemblies), assembly_instances (Assembly Instances), barycentric (Barycentric Coordinates), bitangent (Bitangents), coverage (Coverage), depth (Depth), facing_ratio (Facing Ratio), geometric_normal (Geometric Normals), materials (Materials), object_instances (Object Instances), objects (Objects), original_shading_normal (Original Shading Normals), primitives (Primitives), ray_spread (Ray Spread), screen_space_velocity (Screen-Space Velocity), screen_space_wireframe (Screen-Space Wireframe), shading_normal (Shading Normals), sides (Sides), tangent (Tangents), uv (UV Coordinates), world_space_position (World-Space Position), world_space_velocity (World-Space Velocity), world_space_wireframe (World-Space Wireframe). |
15.4. The physical_surface_shader Model
| Parameter |
Label |
Presence |
Default |
Description |
lighting_samples |
Lighting Samples |
optional |
1 |
|
16. Built-in Texture Models
16.1. The disk_texture_2d Model
| Parameter |
Label |
Presence |
Default |
Description |
filename |
File Path |
required |
None |
|
color_space |
Color Space |
required |
srgb |
Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), srgb (sRGB). |
16.2. The memory_texture_2d Model
| Parameter |
Label |
Presence |
Default |
Description |
color_space |
Color Space |
required |
srgb |
Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), srgb (sRGB). |
17. Built-in Volume Models
17.1. The generic_volume Model
| Parameter |
Label |
Presence |
Default |
Description |
absorption |
Absorption Coefficient |
required |
0.5 |
|
absorption_multiplier |
Absorption Coefficient Multiplier |
optional |
1.0 |
|
scattering |
Scattering Coefficient |
required |
0.5 |
|
scattering_multiplier |
Scattering Coefficient Multiplier |
optional |
1.0 |
|
phase_function_model |
Phase Function Model |
required |
isotropic |
Possible values are: henyey (Henyey-Greenstein), isotropic (Isotropic). |
average_cosine |
Average Cosine (g) |
optional |
0.0 |
|