Built in Entities

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.

1. Built-in AOV Models

1.1. The depth_aov Model

1.2. The diffuse_aov Model

1.3. The direct_diffuse_aov Model

1.4. The direct_glossy_aov Model

1.5. The emission_aov Model

1.6. The glossy_aov Model

1.7. The indirect_diffuse_aov Model

1.8. The indirect_glossy_aov Model

1.9. The normal_aov Model

1.10. The uv_aov Model

2. Built-in BSDF Models

2.1. The ashikhmin_brdf Model

Parameter	Presence	Description
diffuse_reflectance	required	Diffuse Reflectance
diffuse_reflectance_multiplier	optional	The default value is 1.0.
glossy_reflectance	required	Glossy Reflectance
glossy_reflectance_multiplier	optional	The default value is 1.0.
fresnel_multiplier	optional	The default value is 1.0.
shininess_u	required	Shininess U
shininess_v	required	Shininess V

2.2. The blinn_brdf Model

Parameter	Presence	Description
exponent	required	Exponent
ior	required	Index of Refraction

2.3. The bsdf_blend Model

Parameter	Presence	Description
bsdf0	required	BSDF 1
bsdf1	required	BSDF 2
weight	required	Weight

2.4. The bsdf_mix Model

Parameter	Presence	Description
bsdf0	required	BSDF 1
weight0	required	Weight 1
bsdf1	required	BSDF 2
weight1	required	Weight 2

2.5. The diffuse_btdf Model

Parameter	Presence	Description
transmittance	required	Transmittance
transmittance_multiplier	optional	The default value is 1.0.

2.6. The disney_brdf Model

Parameter	Presence	Description
base_color	required	Base Color
subsurface	optional	The default value is 0.0.
metallic	optional	The default value is 0.0.
specular	optional	The default value is 0.0.
specular_tint	optional	The default value is 0.0.
anisotropic	optional	The default value is 0.0.
roughness	optional	The default value is 0.1.
sheen	optional	The default value is 0.0.
sheen_tint	optional	The default value is 0.0.
clearcoat	optional	The default value is 0.0.
clearcoat_gloss	optional	The default value is 1.0.

2.7. The glass_bsdf Model

Parameter	Presence	Description
mdf	required	Microfacet Distribution Function. Possible values are: beckmann (Beckmann), ggx (GGX), std (STD).
surface_transmittance	required	Surface Transmittance
surface_transmittance_multiplier	optional	The default value is 1.0.
reflection_tint	optional	The default value is 1.0.
refraction_tint	optional	The default value is 1.0.
ior	required	Index of Refraction
roughness	optional	The default value is 0.15.
highlight_falloff	optional	The default value is 0.4.
anisotropy	optional	The default value is 0.0.
volume_parameterization	required	Volume Absorption Parameterization. Possible values are: absorption (Absorption), transmittance (Transmittance).
volume_transmittance	optional	The default value is 1.0.
volume_transmittance_distance	optional	The default value is 0.0.
volume_absorption	optional	The default value is 0.0.
volume_density	optional	The default value is 0.0.
volume_scale	optional	The default value is 1.0.

2.8. The glossy_brdf Model

Parameter	Presence	Description
mdf	required	Microfacet Distribution Function. Possible values are: beckmann (Beckmann), ggx (GGX), std (STD).
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.
roughness	optional	The default value is 0.15.
highlight_falloff	optional	The default value is 0.4.
anisotropy	optional	The default value is 0.0.
ior	required	Index of Refraction

2.9. The kelemen_brdf Model

Parameter	Presence	Description
matte_reflectance	required	Matte Reflectance
matte_reflectance_multiplier	optional	The default value is 1.0.
specular_reflectance	required	Specular Reflectance
specular_reflectance_multiplier	optional	The default value is 1.0.
roughness	required	Roughness

2.10. The lambertian_brdf Model

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.

2.11. The metal_brdf Model

Parameter	Presence	Description
mdf	required	Microfacet Distribution Function. Possible values are: beckmann (Beckmann), ggx (GGX), std (STD).
normal_reflectance	required	Normal Reflectance
edge_tint	required	Edge Tint
reflectance_multiplier	optional	The default value is 1.0.
roughness	optional	The default value is 0.15.
highlight_falloff	optional	The default value is 0.4.
anisotropy	optional	The default value is 0.0.

2.12. The orennayar_brdf Model

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.
roughness	required	Roughness

2.13. The plastic_brdf Model

Parameter	Presence	Description
mdf	required	Microfacet Distribution Function. Possible values are: beckmann (Beckmann), ggx (GGX), gtr1 (GTR1), std (STD).
specular_reflectance	required	Specular Reflectance
specular_reflectance_multiplier	optional	The default value is 1.0.
roughness	optional	The default value is 0.15.
highlight_falloff	optional	The default value is 0.4.
ior	required	Index of Refraction
diffuse_reflectance	required	Diffuse Reflectance
diffuse_reflectance_multiplier	optional	The default value is 1.0.
internal_scattering	optional	The default value is 1.0.

2.14. The sheen_brdf Model

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.

2.15. The specular_brdf Model

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.

2.16. The specular_btdf Model

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.
transmittance	required	Transmittance
transmittance_multiplier	optional	The default value is 1.0.
fresnel_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
volume_density	optional	The default value is 0.0.
volume_scale	optional	The default value is 1.0.

3. Built-in BSSRDF Models

3.1. The better_dipole_bssrdf Model

Parameter	Presence	Description
weight	optional	The default value is 1.0.
reflectance	required	Diffuse Surface Reflectance
reflectance_multiplier	optional	The default value is 1.0.
mfp	required	Mean Free Path
mfp_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
fresnel_weight	optional	The default value is 1.0.

3.2. The directional_dipole_bssrdf Model

Parameter	Presence	Description
weight	optional	The default value is 1.0.
reflectance	required	Diffuse Surface Reflectance
reflectance_multiplier	optional	The default value is 1.0.
mfp	required	Mean Free Path
mfp_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
fresnel_weight	optional	The default value is 1.0.

3.3. The gaussian_bssrdf Model

Parameter	Presence	Description
weight	optional	The default value is 1.0.
reflectance	required	Reflectance
reflectance_multiplier	optional	The default value is 1.0.
mfp	required	Mean Free Path
mfp_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
fresnel_weight	optional	The default value is 1.0.

3.4. The normalized_diffusion_bssrdf Model

Parameter	Presence	Description
weight	optional	The default value is 1.0.
reflectance	required	Diffuse Surface Reflectance
reflectance_multiplier	optional	The default value is 1.0.
mfp	required	Mean Free Path
mfp_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
fresnel_weight	optional	The default value is 1.0.

3.5. The standard_dipole_bssrdf Model

Parameter	Presence	Description
weight	optional	The default value is 1.0.
reflectance	required	Diffuse Surface Reflectance
reflectance_multiplier	optional	The default value is 1.0.
mfp	required	Mean Free Path
mfp_multiplier	optional	The default value is 1.0.
ior	required	Index of Refraction
fresnel_weight	optional	The default value is 1.0.

4. Built-in Camera Models

4.1. The orthographic_camera Model

Parameter	Presence	Description
shutter_open_time	optional	The default value is 0.0.
shutter_close_time	optional	The default value is 1.0.
film_dimensions	required	Film Dimensions
film_width	required	Film Width
film_height	required	Film Height
aspect_ratio	required	Aspect Ratio
near_z	optional	The default value is -0.001.

4.2. The pinhole_camera Model

Parameter	Presence	Description
shutter_open_time	optional	The default value is 0.0.
shutter_close_time	optional	The default value is 1.0.
film_dimensions	required	Film Dimensions
film_width	required	Film Width
film_height	required	Film Height
aspect_ratio	required	Aspect Ratio
focal_length	required	Focal Length
horizontal_fov	required	Horizontal FOV
near_z	optional	The default value is -0.001.

4.3. The spherical_camera Model

Parameter	Presence	Description
shutter_open_time	optional	The default value is 0.0.
shutter_close_time	optional	The default value is 1.0.

4.4. The thinlens_camera Model

Parameter	Presence	Description
shutter_open_time	optional	The default value is 0.0.
shutter_close_time	optional	The default value is 1.0.
film_dimensions	required	Film Dimensions
film_width	required	Film Width
film_height	required	Film Height
aspect_ratio	required	Aspect Ratio
focal_length	required	Focal Length
horizontal_fov	required	Horizontal FOV
f_stop	required	F-Number
focal_distance	optional	The default value is 1.0.
autofocus_target	optional	The default value is 0.5 0.5.
diaphragm_blades	optional	The default value is 0.
diaphragm_tilt_angle	optional	The default value is 0.0.
diaphragm_map	optional	Diaphragm Map
near_z	optional	The default value is -0.001.

5.1. The color Model

Parameter	Presence	Description
color_space	required	Color Space. Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), spectral (Spectral), srgb (sRGB).
wavelength_range	optional	The default value is 400.0 700.0.
color	required	Color
alpha	optional	The default value is 1.0.
multiplier	optional	The default value is 1.0.

6. Built-in EDF Models

6.1. The cone_edf Model

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
angle	required	Angle
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.
light_near_start	optional	The default value is 0.0.

6.2. The diffuse_edf Model

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.
light_near_start	optional	The default value is 0.0.

7.1. The generic_environment Model

Parameter	Presence	Description
environment_edf	optional	Environment EDF
environment_shader	optional	Environment Shader

8. Built-in Environment EDF Models

8.1. The constant_environment_edf Model

Parameter	Presence	Description
radiance	required	Radiance

8.2. The constant_hemisphere_environment_edf Model

Parameter	Presence	Description
upper_hemi_radiance	required	Upper Hemisphere Radiance
lower_hemi_radiance	required	Lower Hemisphere Radiance

8.3. The gradient_environment_edf Model

Parameter	Presence	Description
horizon_radiance	required	Horizon Radiance
zenith_radiance	required	Zenith Radiance

8.4. The hosek_environment_edf Model

Parameter	Presence	Description
sun_theta	required	Sun Theta Angle
sun_phi	required	Sun Phi Angle
turbidity	required	Turbidity
turbidity_multiplier	optional	The default value is 2.0.
luminance_multiplier	optional	The default value is 1.0.
luminance_gamma	optional	The default value is 1.0.
saturation_multiplier	optional	The default value is 1.0.
horizon_shift	optional	The default value is 0.0.
ground_albedo	optional	The default value is 0.3.

8.5. The latlong_map_environment_edf Model

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
horizontal_shift	optional	The default value is 0.0.
vertical_shift	optional	The default value is 0.0.

8.6. The mirrorball_map_environment_edf Model

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	The default value is 1.0.

8.7. The osl_environment_edf Model

Parameter	Presence	Description
osl_background	optional	OSL Background

8.8. The preetham_environment_edf Model

Parameter	Presence	Description
sun_theta	required	Sun Theta Angle
sun_phi	required	Sun Phi Angle
turbidity	required	Turbidity
turbidity_multiplier	optional	The default value is 2.0.
luminance_multiplier	optional	The default value is 1.0.
luminance_gamma	optional	The default value is 1.0.
saturation_multiplier	optional	The default value is 1.0.
horizon_shift	optional	The default value is 0.0.

9. Built-in Environment Shader Models

9.1. The background_environment_shader Model

Parameter	Presence	Description
color	required	Color
alpha	optional	The default value is 1.0.

9.2. The edf_environment_shader Model

Parameter	Presence	Description
environment_edf	required	Environment EDF
alpha_value	optional	The default value is 1.0.

10.1. The frame Model

Parameter	Presence	Description
camera	optional	Camera
resolution	required	Resolution
crop_window	optional	Crop Window
tile_size	required	Tile Size
filter	optional	The default value is blackman-harris.
filter_size	optional	The default value is 1.5.

11. Built-in Light Models

11.1. The directional_light Model

Parameter	Presence	Description
irradiance	required	Irradiance
irradiance_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

11.2. The max_omni_light Model

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	The default value is 1.0.
decay_start	optional	The default value is 0.0.
decay_exponent	optional	The default value is 2.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

11.3. The max_spot_light Model

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	The default value is 1.0.
inner_angle	required	Inner Angle
outer_angle	required	Outer Angle
tilt_angle	optional	The default value is 0.0.
decay_start	optional	The default value is 0.0.
decay_exponent	optional	The default value is 2.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

11.4. The point_light Model

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

11.5. The spot_light Model

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	The default value is 1.0.
exposure	optional	The default value is 0.0.
inner_angle	required	Inner Angle
outer_angle	required	Outer Angle
tilt_angle	optional	The default value is 0.0.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

11.6. The sun_light Model

Parameter	Presence	Description
environment_edf	optional	Bind To
turbidity	required	Turbidity
radiance_multiplier	optional	The default value is 1.0.
size_multiplier	optional	The default value is 1.0.
distance	optional	The default value is 149.6.
cast_indirect_light	optional	The default value is true.
importance_multiplier	optional	The default value is 1.0.

12. Built-in Material Models

12.1. The disney_material Model

Parameter	Presence	Description
surface_shader	optional	Surface Shader
edf	optional	EDF
alpha_map	optional	Alpha Map
displacement_map	optional	Displacement Map
displacement_method	required	Displacement Method. Possible values are: bump (Bump Mapping), normal (Normal Mapping).
bump_amplitude	optional	The default value is 1.0.
bump_offset	optional	The default value is 0.5.
normal_map_up	optional	The default value is z.

12.2. The generic_material Model

Parameter	Presence	Description
surface_shader	optional	Surface Shader
bsdf	optional	BSDF
bssrdf	optional	BSSRDF
edf	optional	EDF
volume	optional	Volume
alpha_map	optional	Alpha Map
displacement_map	optional	Displacement Map
displacement_method	required	Displacement Method. Possible values are: bump (Bump Mapping), normal (Normal Mapping).
bump_amplitude	optional	The default value is 1.0.
bump_offset	optional	The default value is 0.5.
normal_map_up	optional	The default value is z.

12.3. The osl_material Model

Parameter	Presence	Description
surface_shader	optional	Surface Shader
osl_surface	optional	OSL Surface
alpha_map	optional	Alpha Map

13. Built-in Object Models

13.1. The curve_object Model

13.2. The mesh_object Model

Parameter	Presence	Description
alpha_map	optional	Alpha Map

14. Built-in Surface Shader Models

14.1. The ao_surface_shader Model

Parameter	Presence	Description
sampling_method	required	Sampling Method. Possible values are: cosine (Cosine-Weighted Sampling), uniform (Uniform Sampling).
samples	required	Samples
max_distance	required	Maximum Occlusion Distance

14.2. The constant_surface_shader Model

Parameter	Presence	Description
color	required	Color
alpha_source	optional	The default value is color.
color_multiplier	optional	The default value is 1.0.
alpha_multiplier	optional	The default value is 1.0.

14.3. The diagnostic_surface_shader Model

Parameter	Presence	Description
mode	required	Mode. Possible values are: ambient_occlusion (Ambient Occlusion), assembly_instances (Assembly Instances), barycentric (Barycentric Coordinates), bitangent (Bitangents), color (Color), coverage (Coverage), depth (Depth), facing_ratio (Facing Ratio), geometric_normal (Geometric Normals), materials (Materials), object_instances (Object Instances), original_shading_normal (Original Shading Normals), primitives (Primitives), ray_spread (Ray Spread), regions (Regions), 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_wireframe (World-space Wireframe).

14.4. The physical_surface_shader Model

Parameter	Presence	Description
lighting_samples	optional	The default value is 1.

15. Built-in Texture Models

15.1. The disk_texture_2d Model

Parameter	Presence	Description
filename	required	File Path
color_space	required	Color Space. Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), srgb (sRGB).

15.2. The memory_texture_2d Model

Parameter	Presence	Description
color_space	required	Color Space. Possible values are: ciexyz (CIE XYZ), linear_rgb (Linear RGB), srgb (sRGB).

16. Built-in Volume Models

16.1. The generic_volume Model

Parameter	Presence	Description
absorption	required	Absorption Coefficient
absorption_multiplier	optional	The default value is 1.0.
scattering	required	Scattering Coefficient
scattering_multiplier	optional	The default value is 1.0.
phase_function_model	required	Phase Function Model. Possible values are: henyey (Henyey-Greenstein), isotropic (Isotropic).
average_cosine	optional	The default value is 0.0.