SoGLCacheList(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoGLCacheList(3) πŸ’–

okay bestie, so this is a page from the Library Functions Manual, and it's about a class called SoGLCacheList β€” yes, from the Coin fam. Let's get into it. 🫢


✨ NAME ✨

SoGLCacheList β€” the class that stores and manages OpenGL caches. that's it, that's the whole job. she's a cache manager. main character energy honestly. πŸ‘‘


🌸 SYNOPSIS 🌸

first things first, you gotta pull her in:

#include <include/Inventor/caches/SoGLCacheList.h>

πŸŽ€ Public Member Functions πŸŽ€

here's the whole roster, no cap:

SoGLCacheList (int numcaches=2)
~SoGLCacheList ()
SbBool call (SoGLRenderAction *action)
void open (SoGLRenderAction *action, SbBool autocache=TRUE)
void close (SoGLRenderAction *action)
void invalidateAll (void)

πŸ¦‹ Detailed Description πŸ¦‹

so like... SoGLCacheList is used to store and manage OpenGL caches. that's the vibe. she holds them, she runs them, she's the whole operation. πŸ’…


πŸ“ Constructor & Destructor Documentation πŸ“

πŸ’œ SoGLCacheList::SoGLCacheList (int numcaches = 2)

the constructor, bestie. she's born. ✨

πŸ’œ SoGLCacheList::~SoGLCacheList ()

the destructor. and listen β€” she frees any caches that are still hanging around. she cleans up after herself. iconic behavior only. πŸ§ΉπŸ’–


πŸ”₯ Member Function Documentation πŸ”₯

🌈 SbBool SoGLCacheList::call (SoGLRenderAction * action)

this one tests for a valid cache and then executes it. she returns TRUE if a valid cache could be found, and FALSE if not.

heads up though: when a valid cache is found, it gets executed before this method even returns. so like, the work is already done by the time you hear back. no waiting around. πŸ’€

🌈 void SoGLCacheList::open (SoGLRenderAction * action, SbBool autocache = TRUE)

this starts recording a brand new cache. but bestie β€” remember to call close() when you've finished recording the cache. don't leave her open, that's not the move. πŸ™ˆ

See also: close()

🌈 void SoGLCacheList::close (SoGLRenderAction * action)

finishes recording the cache that's currently open. wrap it up, girl. 🎬

See also: open()

🌈 void SoGLCacheList::invalidateAll (void )

invalidates all the caches in this instance. and this one's important β€” it should be called from the notify() method of nodes doing caching. that's the assignment. 🫑


⭐ Author ⭐

this whole page was generated automatically by Doxygen for Coin, straight from the source code. the robots did this one, not me. πŸ€–πŸ’…


okay that's the whole page!! and a little sign-off for you: this lovely thing comes from Coin, Version 3.1.3, and she lives in section 3 of the manual β€” SoGLCacheList(3), periodt. go forth and cache responsibly. πŸŽ€βœ¨πŸ¦‹πŸ’–

πŸ“¦ where this page comes from