openPBRSurface

Go to: Related nodes. Attributes.

OpenPBR Surface is a specification of a surface shading model intended as a standard for computer graphics. It aims to provide a material representation capable of accurately modeling the vast majority of CG materials used in practical visual effects and feature animation productions.

OpenPBR Surface is an open standard hosted by the Academy Software Foundation (ASWF), and is organized as a subproject of MaterialX.

In the table below, important attribute have their names indicated in bold in the description column.

Related nodes

standardSurface, lambert, phongE, phong, blinn, anisotropic, volumeShader, simpleVolumeShader, surfaceShader, displacementShader, layeredShader, useBackground, defaultShaderList, shadingMap

Attributes (124)

Attribute quick index omitted (too many attributes to show them all).

Long name (short name)	Type	Default	Flags
baseColor (bc)	float3
Color of the reflection from the diffuse and metallic base.
baseColorR (bcr) float 0.8 Base color red value.
baseColorG (bcg) float 0.8 Base color green value.
baseColorB (bcb) float 0.8 Base color blue value.
baseDiffuseRoughness (dr)	float	0
Roughness of the diffuse reflection. Higher values cause the surface to appear flatter.
baseMetalness (m)	float	0
Specifies how metallic the base material appears (dials the base from pure dielectric to pure metal).
baseWeight (b)	float	1.0
Multiplier on the intensity of the reflection from the diffuse and metallic base.
coatColor (ctc)	float3
The color of the clear-coat layer's transparency, due to absorption in the coat.
coatColorR (ctcr) float 1 Coat color red value.
coatColorG (ctcg) float 1 Coat color green value.
coatColorB (ctcb) float 1 Coat color blue value.
coatDarkening (ctdk)	float	1
Modulates the physical coat darkening effect.
coatIOR (ctior)	float	1.6
The index of refraction of the clear-coat layer.
coatRoughness (ctr)	float	0
The roughness of the clear-coat reflections. The lower the value, the sharper the reflection.
coatRoughnessAnisotropy (cta)	float	0
The directional bias of the roughness of the clear-coat layer, resulting in increasingly stretched highlights along the coat tangent direction.
coatWeight (ct)	float	0
The presence weight of a reflective clear-coat layer on top of the material. Use for materials such as car paint or an oily layer.
emissionColor (ec)	float3
The color of the emitted light.
emissionColorR (ecr) float 1 Emission color red value.
emissionColorG (ecg) float 1 Emission color green value.
emissionColorB (ecb) float 1 Emission color blue value.
emissionLuminance (elu)	float	0
The amount of emitted light, as a luminance in nits.
fuzzColor (fzc)	float3
The color of the fuzz layer.
fuzzColorR (fzcr) float 1 Fuzz color red value.
fuzzColorG (fzcg) float 1 Fuzz color green value.
fuzzColorB (fzcb) float 1 Fuzz color blue value.
fuzzRoughness (fzr)	float	0.5
The roughness of the fuzz layer.
fuzzWeight (fw)	float	0
The presence weight of a fuzz layer that can be used to approximate microfibers, for fabrics such as velvet and satin as well as dust grains.
geometryCoatNormal (gctn)	float3
Input normal for coat layer. Not editable, but connectable for bump mapping.
geometryCoatNormalX (gctnx) float 0 Geometry coat normal X value.
geometryCoatNormalY (gctny) float 0 Geometry coat normal Y value.
geometryCoatNormalZ (gctnz) float 0 Geometry coat normal Z value.
geometryCoatTangent (gctt)	float3
Input tangent for coat layer. Not editable, but connectable for bump mapping.
geometryCoatTangentX (gcttx) float 0 Geometry coat tangent X value.
geometryCoatTangentY (gctty) float 0 Geometry coat tangent Y value.
geometryCoatTangentZ (gcttz) float 0 Geometry coat tangent Z value.
geometryOpacity (geop)	float	1
The opacity of the entire material.
geometryThinWalled (getw)	bool	false
If true the surface is double-sided and represents an infinitesimally thin shell. Suitable for extremely geometrically thin objects such as leaves or paper.
hardwareShader (hws)	float3
Attribute to be connected to a hardware shader in order to override drawing in the 3d view.
hardwareShaderR (hwr) float 0.0 Red component.
hardwareShaderG (hwg) float 0.0 Green component.
hardwareShaderB (hwb) float 0.0 Blue component.
lightDataArray (ltd)	lightData	nullptr
The lighting information this node computes.
lightDirection (ld) float3 The light direction. lightDirectionX (ldx) float 1.0 The x component of the direction. lightDirectionY (ldy) float 1.0 The y component of the direction. lightDirectionZ (ldz) float 1.0 The z component of the direction.
lightIntensity (li) float3 The light intensity (it's a colour). lightIntensityR (lir) float 1.0 light intensity red value lightIntensityG (lig) float 1.0 light intensity green value lightIntensityB (lib) float 1.0 light intensity blue value
lightAmbient (la) bool true The boolean that indicates if the light has an ambient component.
lightDiffuse (ldf) bool true The boolean that indicates if the light has a diffuse component.
lightSpecular (ls) bool false The boolean that indicates if the light has a specular component.
lightShadowFraction (lsf) float 0.0 The visibility fraction to the light. value is in [0,1]
preShadowIntensity (psi) float 0.0 The light intensity without taking shadow into account.
lightBlindData (lbd) addr 0 The light's blind data.
normalCamera (n)	float3
Normal Camera represents the surface normals in the camera's space. (These are used to calculate shading.) To do Bump Mapping, connect the output of a bump node to this attribute.
normalCameraX (nx) float 1.0 normal camera x value
normalCameraY (ny) float 1.0 normal camera Y value
normalCameraZ (nz) float 1.0 normal camera Z value
objectId (oi)	addr	0
Unique integer that identifies the object being rendered.
outColor (oc)	float3
Out Color is the final output color generated by this node. If you are using this node as one of the layers in a Layered Shader, then you will need to connect this attribute to the Color input of the Layered Shader.
outColorR (ocr) float 0.0 out color red value
outColorG (ocg) float 0.0 out color green value
outColorB (ocb) float 0.0 out color blue value
outTransparency (ot)	float3
Out Transparency is the final output transparency generated by this node. If you are using this node as one of the layers in a Layered Shader, then you will need to connect this attribute to the Transparency input of the Layered Shader.
outTransparencyR (otr) float 0.0 out transparency red value
outTransparencyG (otg) float 0.0 out transparency green value
outTransparencyB (otb) float 0.0 out transparency blue value
pointCamera (pc)	float3
surface intersection point in camera space
pointCameraX (px) float 1.0 point camera x component
pointCameraY (py) float 1.0 point camera y component
pointCameraZ (pz) float 1.0 point camera z component
primitiveId (pi)	integer	0
triangle id
rayDepth (rd)	short	0
current ray depth
rayDirection (rad)	float3
The ray direction.
rayDirectionX (rdx) float 0.0 The x component of the direction.
rayDirectionY (rdy) float 0.0 The y component of the direction.
rayDirectionZ (rdz) float 1.0 The z component of the direction.
rayInstance (ryi)	integer	0
Unique ray identifier controlling the sampling distribution for volume light depth map shadows, fluid volume rendering, light fog, ray traced shadows, and motion blur.
raySampler (rtr)	addr	0
ray sample pointer
specularColor (sc)	float3
Color of the specular reflection (controls the physical edge-tint for metals, and a non-physical overall tint for dielectrics).
specularColorR (scr) float 1 Specular color red value.
specularColorG (scg) float 1 Specular color green value.
specularColorB (spb) float 1 Specular color blue value.
specularIOR (sior)	float	1.5
Index of refraction of the dielectric base.
specularRoughness (sr)	float	0.3
The roughness of the specular reflection. Lower numbers produce sharper reflections, higher numbers produce blurrier reflections.
specularRoughnessAnisotropy (sa)	float	0
The directional bias of the roughness of the metal/dielectric base, resulting in increasingly stretched highlights along the tangent direction.
specularWeight (s)	float	1.0
Multiplies the specular reflectivity.
subsurfaceColor (subc)	float3
The observed reflection color of the subsurface scattering medium.
subsurfaceColorR (subcr) float 0.8 Subsurface color red value.
subsurfaceColorG (subcg) float 0.8 Subsurface color green value.
subsurfaceColorB (subcb) float 0.8 Subsurface color blue value.
subsurfaceRadius (subs)	float	1
Length scale of the subsurface scattering mean free path.
subsurfaceRadiusScale (subr)	float3
RGB multiplier to subsurface_radius, giving the per-channel scattering mean-free-paths.
subsurfaceRadiusScaleR (subrr) float 1 Subsurface radius scale red value.
subsurfaceRadiusScaleG (subrg) float 0.5 Subsurface radius scale green value.
subsurfaceRadiusScaleB (subrb) float 0.25 Subsurface radius scale blue value.
subsurfaceScatterAnisotropy (suba)	float	0
Controls the phase-function of subsurface scattering, where zero scatters light evenly, positive values scatter forwards, and negative values scatter backwards.
subsurfaceWeight (sub)	float	0
Mixture weight which dials the opaque dielectric base between diffuse reflection and subsurface scattering. A value of 1.0 indicates full subsurface scattering and a value 0 for diffuse reflection only.
tangentUCamera (utan)	float3
u-tangent at sample point
tangentUCameraX (utnx) float 1.0 Tangent X value.
tangentUCameraY (utny) float 1.0 Tangent Y value.
tangentUCameraZ (utnz) float 1.0 Tangent Z value.
thinFilmIOR (tfior)	float	1.4
The index of refraction of the thin-film.
thinFilmThickness (tft)	float	0.5
The thickness of the thin-film layer on the base (in micrometers).
thinFilmWeight (tfw)	float	0
Coverage weight of the thin-film. Use for materials such as multi-tone car paint or soap bubbles.
transmissionColor (trc)	float3
Controls color of the transparent base due to Beer's law volumetric absorption under the surface (reverts to a non-physical tint when transmission_depth is zero).
transmissionColorR (trcr) float 1 Transmission color red value.
transmissionColorG (trcg) float 1 Transmission color green value.
transmissionColorB (trcb) float 1 Transmission color blue value.
transmissionDepth (td)	float	0
Specifies the distance light travels inside the transparent base before it becomes exactly the transmission_color according to Beer's law.
transmissionDispersionAbbeNumber (tdan)	float	20
Physical Abbe number of the dielectric medium, describing how much the dielectric index of refraction varies across wavelengths.
transmissionDispersionScale (tdi)	float	0
Linearly scales the amount of dispersion.
transmissionScatter (ts)	float3
Controls the color of light volumetrically scattered inside the transparent base. Suitable for materials with visually significant scattering such as honey, fruit juice, murky water, opalescent glass, or milky glass.
transmissionScatterR (tsr) float 0 Transmission scatter red value.
transmissionScatterG (tsg) float 0 Transmission scatter green value.
transmissionScatterB (tsb) float 0 Transmission scatter blue value.
transmissionScatterAnisotropy (tsa)	float	0
The amount of directional bias, or anisotropy, of the volumetric scattering in the transparent base.
transmissionWeight (t)	float	0
Mixture weight between the transparent and opaque dielectric base. The greater the value the more transparent the material.
triangleNormalCamera (tnc)	float3
Triangle Normal In Camera Space This is the normal of the visible triangle in the camera space. This normal is used to check the reflection direction is not in the opposite direction of the normal of the visible triangle.
triangleNormalCameraX (tnx) float 0.0 Triangle normal X value.
triangleNormalCameraY (tny) float 1.0 Triangle normal Y value.
triangleNormalCameraZ (tnz) float 0.0 Triangle normal Z value.