maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE Namespace Reference

Detailed Description

This bundle is modeled after the open standard Autodesk Standard Surface version 1.0.1, see https://autodesk.github.io/standard-surface/ .

Functions
	MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.material.portbundle.standardsurface")
	MAXON_ATTRIBUTE (Float, BASE, "base")
	MAXON_ATTRIBUTE (Color, BASE_COLOR, "base_color")
	MAXON_ATTRIBUTE (Float, DIFFUSE_ROUGHNESS, "diffuse_roughness")
	MAXON_ATTRIBUTE (Float, METALNESS, "metalness")
	MAXON_ATTRIBUTE (Float, SPECULAR, "specular")
	MAXON_ATTRIBUTE (Color, SPECULAR_COLOR, "specular_color")
	MAXON_ATTRIBUTE (Float, SPECULAR_ROUGHNESS, "specular_roughness")
	MAXON_ATTRIBUTE (Float, SPECULAR_IOR, "specular_IOR")
	MAXON_ATTRIBUTE (Float, SPECULAR_ANISOTROPY, "specular_anisotropy")
	MAXON_ATTRIBUTE (Float, SPECULAR_ROTATION, "specular_rotation")
	MAXON_ATTRIBUTE (Float, TRANSMISSION, "transmission")
	MAXON_ATTRIBUTE (Color, TRANSMISSION_COLOR, "transmission_color")
	MAXON_ATTRIBUTE (Float, TRANSMISSION_DEPTH, "transmission_depth")
	MAXON_ATTRIBUTE (Color, TRANSMISSION_SCATTER, "transmission_scatter")
	MAXON_ATTRIBUTE (Float, TRANSMISSION_SCATTER_ANISOTROPY, "transmission_scatter_anisotropy")
	MAXON_ATTRIBUTE (Float, TRANSMISSION_DISPERSION, "transmission_dispersion")
	MAXON_ATTRIBUTE (Float, TRANSMISSION_EXTRA_ROUGHNESS, "transmission_extra_roughness")
	MAXON_ATTRIBUTE (Float, SUBSURFACE, "subsurface")
	MAXON_ATTRIBUTE (Color, SUBSURFACE_COLOR, "subsurface_color")
	MAXON_ATTRIBUTE (Color, SUBSURFACE_RADIUS, "subsurface_radius")
	MAXON_ATTRIBUTE (Float, SUBSURFACE_SCALE, "subsurface_scale")
	MAXON_ATTRIBUTE (Float, SUBSURFACE_ANISOTROPY, "subsurface_anisotropy")
	MAXON_ATTRIBUTE (Float, COAT, "coat")
	MAXON_ATTRIBUTE (Color, COAT_COLOR, "coat_color")
	MAXON_ATTRIBUTE (Float, COAT_ROUGHNESS, "coat_roughness")
	MAXON_ATTRIBUTE (Float, COAT_ANISOTROPY, "coat_anisotropy")
	MAXON_ATTRIBUTE (Float, COAT_ROTATION, "coat_rotation")
	MAXON_ATTRIBUTE (Float, COAT_IOR, "coat_IOR")
	MAXON_ATTRIBUTE (Vector, COAT_NORMAL, "coat_normal")
	MAXON_ATTRIBUTE (Float, COAT_AFFECT_COLOR, "coat_affect_color")
	MAXON_ATTRIBUTE (Float, COAT_AFFECT_ROUGHNESS, "coat_affect_roughness")
	MAXON_ATTRIBUTE (Float, SHEEN, "sheen")
	MAXON_ATTRIBUTE (Color, SHEEN_COLOR, "sheen_color")
	MAXON_ATTRIBUTE (Float, SHEEN_ROUGHNESS, "sheen_roughness")
	MAXON_ATTRIBUTE (Float, EMISSION, "emission")
	MAXON_ATTRIBUTE (Color, EMISSION_COLOR, "emission_color")
	MAXON_ATTRIBUTE (Float, THIN_FILM_THICKNESS, "thin_film_thickness")
	MAXON_ATTRIBUTE (Float, THIN_FILM_IOR, "thin_film_IOR")
	MAXON_ATTRIBUTE (Bool, THIN_WALLED, "thin_walled")
	MAXON_ATTRIBUTE (Color, OPACITY, "opacity")
	MAXON_ATTRIBUTE (Vector, SURFACE_NORMAL, "surface_normal")
	MAXON_ATTRIBUTE (Float, SURFACE_NORMAL_WEIGHT, "surface_normal_weight")
	MAXON_ATTRIBUTE (Group, GROUP_BASE, "group.base")
	MAXON_ATTRIBUTE (Group, GROUP_SPECULAR, "group.specular")
	MAXON_ATTRIBUTE (Group, GROUP_TRANSMISSION, "group.transmission")
	MAXON_ATTRIBUTE (Group, GROUP_SUBSURFACE, "group.subsurface")
	MAXON_ATTRIBUTE (Group, GROUP_COATING, "group.coating")
	MAXON_ATTRIBUTE (Group, GROUP_SHEEN, "group.sheen")
	MAXON_ATTRIBUTE (Group, GROUP_EMISSION, "group.emission")
	MAXON_ATTRIBUTE (Group, GROUP_THIN_FILM, "group.thin_film")
	MAXON_ATTRIBUTE (Group, GROUP_SURFACE, "group.surface")

Function Documentation

MAXON_RESOURCE_DATABASE_SCOPE()

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_RESOURCE_DATABASE_SCOPE

(

"net.maxon.material.portbundle.standardsurface"

)

MAXON_ATTRIBUTE() [1/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		BASE	,
		"base"
	)

reflection weight of diffuse_brdf

MAXON_ATTRIBUTE() [2/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		BASE_COLOR	,
		"base_color"
	)

reflection color of diffuse_brdf

MAXON_ATTRIBUTE() [3/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		DIFFUSE_ROUGHNESS	,
		"diffuse_roughness"
	)

reflection roughness of diffuse_brdf

MAXON_ATTRIBUTE() [4/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		METALNESS	,
		"metalness"
	)

MAXON_ATTRIBUTE() [5/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SPECULAR	,
		"specular"
	)

specular reflection weight

MAXON_ATTRIBUTE() [6/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		SPECULAR_COLOR	,
		"specular_color"
	)

specular reflection color

MAXON_ATTRIBUTE() [7/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SPECULAR_ROUGHNESS	,
		"specular_roughness"
	)

reflection roughness; squared internally before passed to the BSDF to achieve a more uniform roughness look over the parameter range

MAXON_ATTRIBUTE() [8/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SPECULAR_IOR	,
		"specular_IOR"
	)

refractive index of specular_brdf

MAXON_ATTRIBUTE() [9/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SPECULAR_ANISOTROPY	,
		"specular_anisotropy"
	)

reflection anisotropy of specular_brdf; range [0,1]

MAXON_ATTRIBUTE() [10/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SPECULAR_ROTATION	,
		"specular_rotation"
	)

orientation of anisotropy; range [0,1] (1 means 180 degrees)

MAXON_ATTRIBUTE() [11/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		TRANSMISSION	,
		"transmission"
	)

transmission weight

MAXON_ATTRIBUTE() [12/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		TRANSMISSION_COLOR	,
		"transmission_color"
	)

transmission color, i.e. tint

MAXON_ATTRIBUTE() [13/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		TRANSMISSION_DEPTH	,
		"transmission_depth"
	)

the distance travelled inside the material by white light before its color becomes exactly transmission_color by Beer's law, determining the extinction coefficient of the interior medium; if zero, transmission_color acts as a constant (on-surface) transmission tint; range [0,infinity)

MAXON_ATTRIBUTE() [14/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		TRANSMISSION_SCATTER	,
		"transmission_scatter"
	)

scattering coefficient of the interior medium

MAXON_ATTRIBUTE() [15/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		TRANSMISSION_SCATTER_ANISOTROPY	,
		"transmission_scatter_anisotropy"
	)

the anisotropy of the Henyey-Greenstein phase function of the interior medium; range [-1,1]

MAXON_ATTRIBUTE() [16/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		TRANSMISSION_DISPERSION	,
		"transmission_dispersion"
	)

dispersion Abbe number, describing how much the index of refraction varies across wavelengths

MAXON_ATTRIBUTE() [17/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		TRANSMISSION_EXTRA_ROUGHNESS	,
		"transmission_extra_roughness"
	)

additional (positive or negative) roughness on top of specular_roughness

MAXON_ATTRIBUTE() [18/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SUBSURFACE	,
		"subsurface"
	)

subsurface scattering weight

MAXON_ATTRIBUTE() [19/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		SUBSURFACE_COLOR	,
		"subsurface_color"
	)

subsurface color, used by subsurface(...) closure

MAXON_ATTRIBUTE() [20/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		SUBSURFACE_RADIUS	,
		"subsurface_radius"
	)

subsurface radii (i.e. mean free paths) of the red, green, and blue channels

MAXON_ATTRIBUTE() [21/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SUBSURFACE_SCALE	,
		"subsurface_scale"
	)

scalar scale for subsurface_radius

MAXON_ATTRIBUTE() [22/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SUBSURFACE_ANISOTROPY	,
		"subsurface_anisotropy"
	)

anisotropy of the subsurface medium phase function; range [-1,1]

MAXON_ATTRIBUTE() [23/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT	,
		"coat"
	)

reflection weight (reflection color is fixed to white)

MAXON_ATTRIBUTE() [24/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		COAT_COLOR	,
		"coat_color"
	)

tint color for the light coming from all layers below

MAXON_ATTRIBUTE() [25/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_ROUGHNESS	,
		"coat_roughness"
	)

coat reflection roughness; squared internally before passed to the BSDF to achieve a more linear perceptual response [Burley2012]

MAXON_ATTRIBUTE() [26/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_ANISOTROPY	,
		"coat_anisotropy"
	)

reflection anisotropy of coat_brdf; range [0,1]

MAXON_ATTRIBUTE() [27/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_ROTATION	,
		"coat_rotation"
	)

orientation of anisotropy; range [0,1] (where 1 means 180 degrees)

MAXON_ATTRIBUTE() [28/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_IOR	,
		"coat_IOR"
	)

refractive index of coat_brdf

MAXON_ATTRIBUTE() [29/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Vector	,
		COAT_NORMAL	,
		"coat_normal"
	)

shading normal for the coating reflections; optional, overrides the default shading normal; has no effect on the closure combination weights

MAXON_ATTRIBUTE() [30/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_AFFECT_COLOR	,
		"coat_affect_color"
	)

how much to additionally modulate diffuse reflection and subsurface scattering saturation; range [0,1]

MAXON_ATTRIBUTE() [31/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		COAT_AFFECT_ROUGHNESS	,
		"coat_affect_roughness"
	)

how much to affect the roughness of the specular reflection layers below; range [0,1]

MAXON_ATTRIBUTE() [32/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SHEEN	,
		"sheen"
	)

reflection weight of sheen_brdf

MAXON_ATTRIBUTE() [33/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		SHEEN_COLOR	,
		"sheen_color"
	)

reflection color of sheen_brdf

MAXON_ATTRIBUTE() [34/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SHEEN_ROUGHNESS	,
		"sheen_roughness"
	)

reflection roughness of sheen_brdf; range [0,1]

MAXON_ATTRIBUTE() [35/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		EMISSION	,
		"emission"
	)

emission color multiplier

MAXON_ATTRIBUTE() [36/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		EMISSION_COLOR	,
		"emission_color"
	)

emission color

MAXON_ATTRIBUTE() [37/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		THIN_FILM_THICKNESS	,
		"thin_film_thickness"
	)

thickness of the film (in nanometres)

MAXON_ATTRIBUTE() [38/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		THIN_FILM_IOR	,
		"thin_film_IOR"
	)

refractive index of the film

MAXON_ATTRIBUTE() [39/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Bool	,
		THIN_WALLED	,
		"thin_walled"
	)

if true, the object is considered infinitely thin and the surface double-sided

MAXON_ATTRIBUTE() [40/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Color	,
		OPACITY	,
		"opacity"
	)

the (colored) opacity of the surface (fully opaque by default)

MAXON_ATTRIBUTE() [41/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Vector	,
		SURFACE_NORMAL	,
		"surface_normal"
	)

(not subject to standard) Data is expected to be in [0,1] range with the geometric normal = [0.5, 0.5, 1.0]. The tangent frame is oriented in accordance with OpenGL and Unity.

MAXON_ATTRIBUTE() [42/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Float	,
		SURFACE_NORMAL_WEIGHT	,
		"surface_normal_weight"
	)

(not subject to standard)

MAXON_ATTRIBUTE() [43/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_BASE	,
		"group.base"
	)

MAXON_ATTRIBUTE() [44/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_SPECULAR	,
		"group.specular"
	)

MAXON_ATTRIBUTE() [45/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_TRANSMISSION	,
		"group.transmission"
	)

MAXON_ATTRIBUTE() [46/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_SUBSURFACE	,
		"group.subsurface"
	)

MAXON_ATTRIBUTE() [47/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_COATING	,
		"group.coating"
	)

MAXON_ATTRIBUTE() [48/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_SHEEN	,
		"group.sheen"
	)

MAXON_ATTRIBUTE() [49/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_EMISSION	,
		"group.emission"
	)

MAXON_ATTRIBUTE() [50/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_THIN_FILM	,
		"group.thin_film"
	)

MAXON_ATTRIBUTE() [51/51]

maxon::MATERIAL::PORTBUNDLE::STANDARDSURFACE::MAXON_ATTRIBUTE	(	Group	,
		GROUP_SURFACE	,
		"group.surface"
	)