SbFifo(3)

💖 SbFifo(3) — Library Functions Manual 💖

okay bestie, gather round, because today we're talking about SbFifo from the Coin library, and it's literally the class for managing a pointer first-in, first-out queue. yes. a queue. the data structure. she's iconic, she's thread-aware, she's giving main character energy in your scene graph. ✨

---

🌸 NAME 🌸

SbFifo — a class for managing a pointer first-in, first-out queue. that's it, that's the whole vibe. 💅

---

🎀 SYNOPSIS 🎀

#include <Inventor/threads/SbFifo.h>

✨ Public Member Functions ✨

void assign (void *ptr, uint32_t type)
void retrieve (void *&ptr, uint32_t &type)
SbBool tryRetrieve (void *&ptr, uint32_t &type)
unsigned int size (void) const
void lock (void) const
void unlock (void) const
SbBool peek (void *&item, uint32_t &type) const
SbBool contains (void *item) const
SbBool reclaim (void *item)

look at her. nine little methods. all of them doing their thing. no cap. 👑

---

🦋 Detailed Description 🦋

A class for managing a pointer first-in, first-out queue.

that's the whole thing. she queues pointers. first one in is the first one out. fifo. you knew that. but now you know you know that. 🍓

---

💜 Member Function Documentation 💜

💅 void SbFifo::assign (void * ptr, uint32_t type) [inline]

Puts pointer ptr of type type into the fifo. 📥

the type argument is just meant as a user data tag, and a 0 value can be given as the type argument if type data is uninteresting. so like, if you don't care what kind of thing you're shoving in there, just pass 0 and move on with your day. she won't judge. 🫶

---

💅 void SbFifo::retrieve (void *& ptr, uint32_t & type) [inline]

Reads a pointer from the queue. Blocks until a pointer is available for reading.

ngl, she will wait for you. she will sit there, arms crossed, until a pointer shows up. so maybe don't call her on the main thread unless you're ready to commit. 😭

---

💅 SbBool SbFifo::tryRetrieve (void *& ptr, uint32_t & type) [inline]

Tries to read a pointer from the queue. If no data can be read, FALSE is returned, and TRUE otherwise. The function does not block.

this is the chill version of retrieve(). she peeks in, and if there's nothing there she's like "okay cool, bye" and hands you a FALSE. no waiting, no drama. the respectful queen we all deserve. ✨

---

💅 unsigned int SbFifo::size (void ) const [inline]

Returns number of pointers currently in the queue.

just a headcount. how many pointers are currently vibing in the fifo. 🔢

---

💅 void SbFifo::lock (void ) const [inline]

Blocks until the queue can be locked.

she's asking for the aux cord. if somebody else has it, she waits her turn. polite. patient. 🌈

---

💅 void SbFifo::unlock (void ) const [inline]

Unlocks the queue.

you gave the aux cord back. thank you for your service. 🎀

---

💅 SbBool SbFifo::peek (void *& item, uint32_t & type) const [inline]

Peeks at the head item of the queue without removing it. In the case where the fifo is empty, FALSE is returned.

⚠️ bestie listen to me. the queue must be locked with SbFifo::lock() before using this function, then unlocked. do not skip this step. this is not optional. i am holding your hand when i say this. 🙈

---

💅 SbBool SbFifo::contains (void * item) const [inline]

Returns TRUE or FALSE depending on whether the item is in the queue.

is she there or is she not there. that's the whole question. 💀

⚠️ again — the queue must be locked with SbFifo::lock() before using this function, then unlocked. same rules, same energy, every single time. 🔥

---

💅 SbBool SbFifo::reclaim (void * item) [inline]

This function removes the given item from the queue. Returns TRUE or FALSE depending on whether the item was in the queue in the first place.

so if she was there, she's gone now, and you get a TRUE. if she was never there, you get a FALSE and honestly? valid. 🫶

⚠️ you already know what i'm gonna say. the queue must be locked with SbFifo::lock() before using this function, then unlocked. lock it. use it. unlock it. periodt. 💅

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. she didn't write herself, bestie. a robot did. and honestly? she ate. 🤖✨

---

and that's the whole page!! that was SbFifo(3) from Coin, Version 2.5.0, living in section 3 of the manual (Library Functions Manual) — go forth and queue your pointers responsibly, lock before you peek, and never forget to unlock. mwah. 💖🦋🌸🎀