SbMutex(3)

💖 SbMutex(3) 💖

okay bestie, welcome to the Library Functions Manual section, this one's SbMutex(3) and it's lowkey iconic 🫶

---

✨ NAME ✨

SbMutex — a basic class for managing a mutex. yes that's literally it, she's simple, she's foundational, she's the friend who holds the group's stuff while everyone else goes to the bathroom 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/threads/SbMutex.h>

🎀 Public Member Functions

SbMutex (void)
~SbMutex ()
int lock (void)
SbBool tryLock (void)
int unlock (void)

---

🦋 Detailed Description 🦋

A basic class for managing a mutex.

This class provides a portable framework around the mutex interface of the underlying native thread-handling toolkit. so like, whatever weird thread stuff your platform is doing under the hood? she's the cute little wrapper that makes it look the same everywhere 🧚✨

---

🍓 Constructor & Destructor Documentation 🍓

SbMutex::SbMutex (void ) [inline]

Constructor. she's born 💖

SbMutex::~SbMutex () [inline]

Destructor. she's gone 😭 gone but never forgotten fr fr

---

👑 Member Function Documentation 👑

int SbMutex::lock (void ) [inline]

This method locks the mutex. 0 is returned on success. ✨

If the mutex was previously unlocked, the thread will lock the mutex and continue running. If the mutex was already locked when this call is made, the thread will be suspended until the other thread holding the mutex releases it. like, you're waiting outside the fitting room, bestie, you're not getting in until she's done 🎀

This is a blocking operation. no cap, you will simply be sitting there until it's your turn 💀

SbBool SbMutex::tryLock (void ) [inline]

This method tries to lock the mutex, and returns whether it was locked or not. This is a non-blocking operation. she's the "hey are you done? no? okay cool cool cool, byeee" of mutex operations 🙈

int SbMutex::unlock (void ) [inline]

This method unlocks the mutex. go on, release her, she's free now 🦋✨

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. yes bestie, no human wrote this, it's giving robot poetry 🤖🌸

---

okay that's the whole page, you ate that, go forth and lock responsibly 💅✨

this was SbMutex(3) from Coin, Version 3.1.3 — mwah, take care of her 🫶💖🌈