SoGLDisplayList(3)

💅 SoGLDisplayList — the manual, but make it cute

okay bestie, gather round, because today we're talking about SoGLDisplayList, a whole class whose entire job is storing and managing OpenGL display lists. yes, it's giving "I babysit your GPU's to-do list" energy and honestly? iconic. 👑

---

✨ NAME ✨

SoGLDisplayList — the class that stores and manages OpenGL display lists. that's it, that's the whole vibe. 🎀

---

🌸 SYNOPSIS 🌸

first things first, you gotta pull it in:

#include <Inventor/elements/SoGLCacheContextElement.h>

🦋 Public Types 🦋

look at this little enum, she's small but she's mighty:

enum Type { DISPLAY_LIST, TEXTURE_OBJECT }

💖 Public Member Functions 💖

here's the whole roster, no gatekeeping:

SoGLDisplayList (SoState *state, Type type, int allocnum=1, SbBool
    mipmaptexobj=FALSE)
void ref (void)
void unref (SoState *state=NULL)
void open (SoState *state, int index=0)
void close (SoState *state)
void call (SoState *state, int index=0)
void addDependency (SoState *state)
SbBool isMipMapTextureObject (void) const
Type getType (void) const
int getNumAllocated (void) const
unsigned int getFirstIndex (void) const
int getContext (void) const
void setTextureTarget (int target)
int getTextureTarget (void) const

---

🌈 Detailed Description 🌈

so, the headline: SoGLDisplayList stores and manages OpenGL display lists. main character behavior, truly.

now the tea ☕: the TEXTURE_OBJECT type is not directly supported in Coin. nope, not happening. Coin handles textures differently, in a much more flexible class called SoGLImage, which also stores some info about the texture used when rendering. so she's the upgrade, she's the glow-up. ✨

but — and this is the important part — old code that uses this element should not stop working. no cap. the texture object extension just won't be used, and the texture gets stored in a display list instead. so your crusty legacy code is safe, she's just taking the scenic route. 🫶

---

🎀 Constructor & Destructor Documentation 🎀

💜 SoGLDisplayList::SoGLDisplayList (SoState * state, Type type, int allocnum = 1, SbBool mipmaptexobj = FALSE)

Constructor. that's it, that's the description. she's born. 🍼✨

---

💅 Member Function Documentation 💅

🍓 void SoGLDisplayList::ref (void )

bumps the reference count up for this display list / texture object. one more bestie holding on. 🫶

🧚 void SoGLDisplayList::unref (SoState * state = NULL)

drops the reference count for this instance. and when the reference count hits 0? the instence is deleted. (yes, that typo is straight from the source, and no, I will not be fixing her — she's part of the lore now. 😭💀)

⭐ void SoGLDisplayList::open (SoState * state, int index = 0)

opens this display list / texture object. come on in, the door's open. 🚪✨

🌸 void SoGLDisplayList::close (SoState * state)

closes this display list / texture object. okay bye, shutting the door behind you. 🚪💨

🔥 void SoGLDisplayList::call (SoState * state, int index = 0)

executes this display list / texture object. go girl, run it. 💫

👑 void SoGLDisplayList::addDependency (SoState * state)

creates a dependency on the display list. she's attached now, no take-backs. 💞

🦋 SbBool SoGLDisplayList::isMipMapTextureObject (void ) const

returns whether the texture object stored in this instance was created with mipmap data. heads up: this method is an extension versus the Open Inventor API — so it's Coin-exclusive, iykyk. 💅

💖 SoGLDisplayList::Type SoGLDisplayList::getType (void ) const

returns the type. display list or texture object. pick your fighter. ⚔️

🌈 int SoGLDisplayList::getNumAllocated (void ) const

returns the number of display lists / texture objects allocated. count 'em. 🔢

✨ unsigned int SoGLDisplayList::getFirstIndex (void ) const

returns the first GL index for this display list. the very first one, the OG. 🥇

💜 int SoGLDisplayList::getContext (void ) const

returns an id for the current context. her little name tag. 🏷️

🎀 void SoGLDisplayList::setTextureTarget (int target)

sets the texture object target.

Since: Coin 2.5

⭐ int SoGLDisplayList::getTextureTarget (void ) const

returns the texture target.

Since: Coin 2.5

---

🌟 Author 🌟

generated automatically by Doxygen for Coin, straight from the source code. the robots wrote her, we just gave her a personality. 🤖💖

---

okay and for the cute sign-off: this whole page comes to you courtesy of Coin, Version 3.1.3 — that's the source and the version, bestie, and this page is SoGLDisplayList(3). slay, drink water, and go ref your display lists responsibly. 💅✨🌸