Skip to content

Commit e81beb1

Browse files
committed
docs: Fixes to documentation of new oren_nayar_diffuse_bsdf parameters (#1820)
Fixes to documentation of new oren_nayar_diffuse_bsdf parameters * The new parameter was explained, but not added to the function prototype in the docs. * The semi-deprecated languagespec.tex was fixed, but it slipped our minds that we've shifted the docs to markdown for ReadTheDocs (the real place we should have changed was stdlib.md). Signed-off-by: Larry Gritz <[email protected]>
1 parent b0e2a45 commit e81beb1

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/doc/languagespec.tex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
6868
}
6969
\date{{\large Date: 27 Oct 2023 \\
70-
% (with corrections, 24 Nov 2021)
70+
(with corrections, 24 May 2024)
7171
}
7272
\bigskip
7373
\bigskip
@@ -4640,7 +4640,7 @@ \section{Material Closures}
46404640

46414641
\subsection{Surface BSDF closures}
46424642

4643-
\apiitem{\closurecolor\ {\ce oren_nayar_diffuse_bsdf}(normal N, color albedo, float roughness)}
4643+
\apiitem{\closurecolor\ {\ce oren_nayar_diffuse_bsdf}(normal N, color albedo, float roughness, int energy_compensation=0)}
46444644
\indexapi{oren_nayar_diffuse_bsdf()}
46454645

46464646
Constructs a diffuse reflection BSDF based on the Oren-Nayar reflectance

src/doc/stdlib.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1266,7 +1266,7 @@ properties of the physically-based shading nodes of MaterialX v1.38
12661266

12671267
### Surface BSDF closures
12681268

1269-
`closure color` **`oren_nayar_diffuse_bsdf`** `(normal N, color albedo, float roughness)`
1269+
`closure color` **`oren_nayar_diffuse_bsdf`** `(normal N, color albedo, float roughness, int energy_compensation=0)`
12701270

12711271
: Constructs a diffuse reflection BSDF based on the Oren-Nayar reflectance
12721272
model.
@@ -1282,10 +1282,14 @@ properties of the physically-based shading nodes of MaterialX v1.38
12821282
`roughness`
12831283
: Surface roughness [0,1]. A value of 0.0 gives Lambertian reflectance.
12841284

1285+
`energy_compensation`
1286+
: Optional int parameter to select if energy compensation should be applied.
1287+
12851288
The Oren-Nayar reflection model is described in M. Oren and S. K.
12861289
Nayar, "Generalization of Lambert's Reflectance Model," Proceedings of
12871290
SIGGRAPH 1994, pp.239-246 (July, 1994).
12881291

1292+
The energy compensated model is described in the white paper: "An energy-preserving Qualitative Oren-Nayar model" by Jamie Portsmouth.
12891293

12901294
`closure color` **`burley_diffuse_bsdf`** `(normal N, color albedo, float roughness)`
12911295

0 commit comments

Comments
 (0)