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.

Table of Contents

• 1. Built-in BSDF Models
• 2. Built-in Camera Models
• 3. Built-in EDF Models
• 4. Built-in Environment Models
• 5. Built-in Environment EDF Models
• 6. Built-in Environment Shader Models
• 7. Built-in Light Models
• 8. Built-in Material Models
• 9. Built-in Object Models
• 10. Built-in Render Layer Assignment Rule Models
• 11. Built-in Surface Shader Models
• 12. Built-in Texture Models

1. Built-in BSDF Models

1.1. The ashikhmin_brdf Model

Parameters

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

1.2. The bsdf_blend Model

Parameters

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

1.3. The bsdf_mix Model

Parameters

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

1.4. The diffuse_btdf Model

Parameters

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

1.5. The disney_brdf Model

Parameters

Parameter	Presence	Description
base_color	required	Base Color
subsurface	optional	Subsurface. The default value is 0.0.
metallic	optional	Metallic. The default value is 0.0.
specular	optional	Specular. The default value is 0.5.
specular_tint	optional	Specular Tint. The default value is 0.0.
anisotropic	optional	Anisotropic. The default value is 0.0.
roughness	optional	Roughness. The default value is 0.5.
sheen	optional	Sheen. The default value is 0.0.
sheen_tint	optional	Sheen Tint. The default value is 0.5.
clearcoat	optional	Clearcoat. The default value is 0.0.
clearcoat_gloss	optional	Clearcoat Gloss. The default value is 1.0.

1.6. The kelemen_brdf Model

Parameters

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

1.7. The lambertian_brdf Model

Parameters

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

1.8. The microfacet_brdf Model

Parameters

Parameter	Presence	Description
mdf	required	Microfacet Distribution Function
glossiness	required	Glossiness
glossiness_multiplier	optional	Glossiness Multiplier. The default value is 1.0.
reflectance	required	Reflectance
reflectance_multiplier	optional	Reflectance Multiplier. The default value is 1.0.
fresnel_multiplier	optional	Fresnel Multiplier. The default value is 1.0.

1.9. The orennayar_brdf Model

Parameters

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

1.10. The specular_brdf Model

Parameters

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

1.11. The specular_btdf Model

Parameters

Parameter	Presence	Description
reflectance	required	Reflectance
reflectance_multiplier	optional	Reflectance Multiplier. The default value is 1.0.
transmittance	required	Transmittance
transmittance_multiplier	optional	Transmittance Multiplier. The default value is 1.0.
fresnel_multiplier	optional	Fresnel Multiplier. The default value is 1.0.
from_ior	required	From Index of Refraction
to_ior	required	To Index of Refraction

2. Built-in Camera Models

2.1. The pinhole_camera Model

Parameters

Parameter	Presence	Description
shutter_open_time	optional	Shutter Open Time. The default value is 0.0.
shutter_close_time	optional	Shutter Close Time. 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

2.2. The spherical_camera Model

Parameters

Parameter	Presence	Description
shutter_open_time	optional	Shutter Open Time. The default value is 0.0.
shutter_close_time	optional	Shutter Close Time. The default value is 1.0.

2.3. The thinlens_camera Model

Parameters

Parameter	Presence	Description
shutter_open_time	optional	Shutter Open Time. The default value is 0.0.
shutter_close_time	optional	Shutter Close Time. 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	required	Focal Distance
autofocus_target	required	Autofocus Target
diaphragm_blades	optional	Diaphragm Blades. The default value is 0.
diaphragm_tilt_angle	optional	Diaphragm Tilt Angle. The default value is 0.0.
diaphragm_map	optional	Diaphragm Map

3. Built-in EDF Models

3.1. The cone_edf Model

Parameters

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	Radiance Multiplier. The default value is 1.0.
angle	required	Angle
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.
light_near_start	optional	Light Near Start. The default value is 0.0.

3.2. The diffuse_edf Model

Parameters

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	Radiance Multiplier. The default value is 1.0.
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.
light_near_start	optional	Light Near Start. The default value is 0.0.

5. Built-in Environment EDF Models

5.1. The constant_environment_edf Model

Parameters

Parameter	Presence	Description
radiance	required	Radiance

5.2. The constant_hemisphere_environment_edf Model

Parameters

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

5.3. The gradient_environment_edf Model

Parameters

Parameter	Presence	Description
horizon_radiance	required	Horizon Radiance
zenith_radiance	required	Zenith Radiance

5.4. The hosek_environment_edf Model

Parameters

Parameter	Presence	Description
sun_theta	required	Sun Theta Angle
sun_phi	required	Sun Phi Angle
turbidity	required	Turbidity
turbidity_multiplier	optional	Turbidity Multiplier. The default value is 2.0.
ground_albedo	optional	Ground Albedo. The default value is 0.3.
luminance_multiplier	optional	Luminance Multiplier. The default value is 1.0.
luminance_gamma	optional	Luminance Gamma. The default value is 1.0.
saturation_multiplier	optional	Saturation Multiplier. The default value is 1.0.
horizon_shift	optional	Horizon Shift. The default value is 0.0.

5.5. The latlong_map_environment_edf Model

Parameters

Parameter	Presence	Description
radiance	required	Radiance
radiance_multiplier	optional	Radiance Multiplier. The default value is 1.0.
horizontal_shift	optional	Horizontal Shift. The default value is 0.0.
vertical_shift	optional	Vertical Shift. The default value is 0.0.

5.6. The mirrorball_map_environment_edf Model

Parameters

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

5.7. The preetham_environment_edf Model

Parameters

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

6. Built-in Environment Shader Models

6.1. The edf_environment_shader Model

Parameters

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

7. Built-in Light Models

7.1. The directional_light Model

Parameters

Parameter	Presence	Description
irradiance	required	Irradiance
irradiance_multiplier	optional	Irradiance Multiplier. The default value is 1.0.
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.

7.2. The point_light Model

Parameters

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	Intensity Multiplier. The default value is 1.0.
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.

7.3. The spot_light Model

Parameters

Parameter	Presence	Description
intensity	required	Intensity
intensity_multiplier	optional	Intensity Multiplier. The default value is 1.0.
inner_angle	required	Inner Angle
outer_angle	required	Outer Angle
tilt_angle	optional	Tilt Angle. The default value is 0.0.
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.

7.4. The sun_light Model

Parameters

Parameter	Presence	Description
environment_edf	optional	Bind To
turbidity	required	Turbidity
radiance_multiplier	optional	Radiance Multiplier. The default value is 1.0.
cast_indirect_light	optional	Cast Indirect Light. The default value is true.
importance_multiplier	optional	Importance Multiplier. The default value is 1.0.

10. Built-in Render Layer Assignment Rule Models

10.1. The regex Model

Description

A regex render layer assignment rule allows to assign one or multiple entities whose paths match a given Perl regular expression (cheat sheet, examples) to a given render layer.

Parameters

Parameter	Presence	Description
render_layer	required	Render Layer
entity_type	optional	Entity Type. None by default.
order	required	Order
pattern	Required	The regular expression pattern used to select entities.

Example

The following rule, called "rule1", assigns all object instances from the "truck" assembly to a render layer called "truck_layer":

<render_layer_assignment name="rule1" model="regex">
    <parameter name="render_layer" value="truck_layer" />
    <parameter name="entity_type" value="object_instance" />
    <parameter name="order" value="1" />
    <parameter name="pattern" value="scene/truck/.*" />
</render_layer_assignment>

11. Built-in Surface Shader Models

11.1. The ao_surface_shader Model

Parameters

Parameter	Presence	Description
sampling_method	required	Sampling Method
samples	required	Samples
max_distance	required	Maximum Occlusion Distance

11.2. The constant_surface_shader Model

Parameters

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

11.3. The diagnostic_surface_shader Model

Parameters

Parameter	Presence	Description
mode	required	Mode

11.4. The physical_surface_shader Model

Parameters

Parameter	Presence	Description
color_multiplier	optional	Color Multiplier. The default value is 1.0.
alpha_multiplier	optional	Alpha Multiplier. The default value is 1.0.
translucency	optional	Translucency. The default value is 0.0.
front_lighting_samples	optional	Front Lighting Samples. The default value is 1.
back_lighting_samples	optional	Back Lighting Samples. The default value is 1.
aerial_persp_mode	optional	Aerial Perspective Mode. The default value is none.
aerial_persp_sky_color	optional	Aerial Perspective Sky Color. The default value is 0.5.
aerial_persp_distance	optional	Aerial Perspective Distance. The default value is 1000.0.
aerial_persp_intensity	optional	Aerial Perspective Intensity. The default value is 0.01.

11.5. The surface_shader_collection Model

Parameters

Parameter	Presence	Description
surface_shader1	required	Surface Shader 1
surface_shader2	optional	Surface Shader 2. None by default.
surface_shader3	optional	Surface Shader 3. None by default.
surface_shader4	optional	Surface Shader 4. None by default.
surface_shader5	optional	Surface Shader 5. None by default.
surface_shader6	optional	Surface Shader 6. None by default.
surface_shader7	optional	Surface Shader 7. None by default.
surface_shader8	optional	Surface Shader 8. None by default.

12. Built-in Texture Models

12.1. The disk_texture_2d Model

Parameters

Parameter	Presence	Description
filename	required	File Path
color_space	required	Color Space

12.2. The writable_texture_2d Model

No parameters.