Skip to content

Commit e536c6a

Browse files
committed
docs: Document the optional "colorspace" parameter for texture funcs (#1969)
Signed-off-by: Larry Gritz <[email protected]>
1 parent 1778aaa commit e536c6a

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

src/doc/stdlib.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,14 @@ the computations are performed component-by-component (separately for `x`,
943943
: The value to return for any channels that are requested,
944944
but not present in the texture file (default: 0).
945945

946+
`"interp",` *`string`*
947+
: Overrides the texture interpolation method: `"smartcubic"` (the
948+
default), `"cubic"`, `"linear"`, or `"closest"`.
949+
950+
`"colorspace"`, *`string`*
951+
: Specifies the color space of the data in the texture file.
952+
(This option was added to OSL in version 1.14.)
953+
946954
`"missingcolor",` *`color`*, `"missingalpha",` *`float`*
947955
: If present, supplies a missing color (and alpha value) that will
948956
be used for missing or broken textures -- *instead of* treating
@@ -962,10 +970,6 @@ the computations are performed component-by-component (separately for `x`,
962970
calls to the renderer, thus leaving it up to the shader to handle any
963971
errors. The error message stored will be `""` if no error occurred.
964972

965-
`"interp",` *`string`*
966-
: Overrides the texture interpolation method: `"smartcubic"` (the
967-
default), `"cubic"`, `"linear"`, or `"closest"`.
968-
969973

970974
*`type`* **`texture3d`** `(string filename, point p,` *`...params...`* `)` <br> *`type`* **`texture3d`** `(string filename, point p, vector dpdx, vector dpdy, vector dpdz,` *`...params...`* `)`
971975

@@ -1034,6 +1038,10 @@ the computations are performed component-by-component (separately for `x`,
10341038
as an error, you must not supply the optional ``"missingcolor"``
10351039
parameter.
10361040

1041+
`"colorspace"`, *`string`*
1042+
: Specifies the color space of the data in the texture file.
1043+
(This option was added to OSL in version 1.14.)
1044+
10371045
`"time"`, *`float`*
10381046
: A time value to use if the volume texture specifies a time-varying
10391047
local transformation (default: 0).
@@ -1095,6 +1103,10 @@ the computations are performed component-by-component (separately for `x`,
10951103
as an error, you must not supply the optional `"missingcolor"`
10961104
parameter.
10971105

1106+
`"colorspace"`, *`string`*
1107+
: Specifies the color space of the data in the texture file.
1108+
(This option was added to OSL in version 1.14.)
1109+
10981110
"alpha", *`floatvariable`*
10991111
: The alpha channel (presumed to be the next channel following the
11001112
channels returned by the `environment()` call) will be stored in the

0 commit comments

Comments
 (0)