SoQtCursor::CustomCursor(3)

Hiii bestie! 💖 You're looking at SoQtCursor::CustomCursor(3) from the SoQt manual — yes, the manual name is SoQt, and this page is all about the SoQtCursor::CustomCursor class. It's the little class that carries bitmap data for SoQtCursor custom cursors. Obsessed? Same. ✨

🎀 NAME 🎀

SoQtCursor::CustomCursor — the class used to specify bitmap data for SoQtCursor custom cursors. That's literally the whole vibe: custom-cursor bitmap data, served fresh. 💅

✨ SYNOPSIS ✨

🌸 Public Attributes 🌸

• SbVec2s dim — size of the cursor data.
• SbVec2s hotspot — position of the cursor hotspot.
• unsigned char * bitmap — the bitmap data bits.
• unsigned char * mask — the mask data bits.

💖 Detailed Description 💖

The SoQtCursor::CustomCursor class is used to specify bitmap data for SoQtCursor custom cursors. That's it, that's the plot. 🫶 If you're making a custom cursor, this is the data setup that holds its bitmap info.

🦋 Member Data Documentation 🦋

🍓 SbVec2s SoQtCursor::CustomCursor::dim

Size of cursor data. Can be anything from 1 pixel wide and high, up to maximum 32 pixels in each dimension. There is a cap, bestie: 32. 😭

🧚 SbVec2s SoQtCursor::CustomCursor::hotspot

Position of cursor hotspot, i.e. the pixel of the cursor which is considered to be the "pick point" when interacting with the canvas or widgets.

The hotspot position should be specified relative to the uppermost, leftmost corner (which is position <0, 0>). 🎯

👑 unsigned char* SoQtCursor::CustomCursor::bitmap

The size of the array of bitmap data should be equal to (width+7)/8*height, as each cursor pixel is specified with just two bits, one in the bitmap array, one in the mask array.

The bitmap and mask bits should be laid out as follows:

B=1 and M=1 == black
B=0 and M=1 == white
B=0 and M=0 == transparency
B=1 and M=0 will give undefined results for some platforms, so avoid.

⚠️ Bestie, that last line is important: B=1 and M=0 will give undefined results for some platforms, so avoid it. Periodt. 💀

🌈 unsigned char* SoQtCursor::CustomCursor::mask

See doc of SoQtCursor::CustomCursor::bitmap. 👀

👑 Author 👑

Generated automatically by Doxygen for SoQt from the source code.

---

Cute little sign-off from the footer: source/version says version 1.6.2, dated Sat Jan 6 2024 12:20:55. Byeee bestie! 🫶🎀✨