Skip to content

Commit d0201ea

Browse files
authored
docs: Add missing documentation of ImageBuf locking methods (#4267)
Signed-off-by: Larry Gritz <lg@larrygritz.com>
1 parent 4ff7643 commit d0201ea

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/doc/imagebuf.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,13 @@ Miscellaneous
230230
.. doxygenfunction:: OIIO::ImageBuf::pixelindex
231231
.. doxygenfunction:: OIIO::ImageBuf::WrapMode_from_string
232232

233+
.. cpp:function:: void lock() const
234+
void unlock() const
235+
236+
Manually lock or unlock the mutex that protects the ImageBuf from
237+
concurrent access by multiple threads. Use with caution -- this should
238+
almost never be needed in ordinary user code.
239+
233240

234241

235242
Iterators -- the fast way of accessing individual pixels

0 commit comments

Comments
 (0)