wl_shm_pool(3)

🌸 wl_shm_pool(3) 🌸

okay so bestie, welcome to the Library Functions Manual πŸ’– this one's all about wl_shm_pool β€” the shared-memory pool struct from Wayland, and no cap it's lowkey just a struct with a little refcount drama going on. let's get into it ✨


✨ NAME ✨

wl_shm_pool β€” it's giving shared memory pool, it's giving struct, it's giving main character energy 🫢


πŸŽ€ SYNOPSIS πŸŽ€

πŸ’… Public Member Functions

void wl_shm_pool_unref (struct wl_shm_pool *pool)

πŸ¦‹ Data Fields

struct wl_resource * resource
int internal_refcount
int external_refcount
char * data
ssize_t size
ssize_t new_size
int mmap_fd
int mmap_flags
int mmap_prot
bool sigbus_is_impossible

periodt. that's the whole vibe check, every field accounted for, nothing skipped πŸ’―


πŸ‘‘ Member Function Documentation πŸ‘‘

πŸ’– void wl_shm_pool_unref (struct wl_shm_pool * pool)

Unreference a shm_pool β€” literally what it says on the tin, bestie.

Parameters

  • pool β€” the pool object 🫧

Drops a reference to a wl_shm_pool object. okay so listen, this is only necessary if the compositor has explicitly taken a reference with wl_shm_buffer_ref_pool(). if it hasn't? then don't worry about it, the pool gets automatically destroyed when appropriate. the universe handles it for you, it's very self-sufficient like that 🌈

See also

  • wl_shm_buffer_ref_pool
fr fr, if you're out here calling wl_shm_pool_unref on a pool nobody ever ref'd, that's not the move. read the paragraph again. we love a careful queen πŸ’…

🌸 Field Documentation 🌸

here's the full roster, alphabetical order because Doxygen said so, and we respect the algorithm ✨

  • char* wl_shm_pool::data β€” the data πŸ’Ύ
  • int wl_shm_pool::external_refcount β€” the outside refcount πŸ‘€
  • int wl_shm_pool::internal_refcount β€” the inside refcount 🫢
  • int wl_shm_pool::mmap_fd β€” the mmap fd πŸ“‚
  • int wl_shm_pool::mmap_flags β€” the mmap flags 🚩
  • int wl_shm_pool::mmap_prot β€” the mmap prot πŸ›‘οΈ
  • ssize_t wl_shm_pool::new_size β€” the new size πŸ†•
  • struct wl_resource* wl_shm_pool::resource β€” the resource πŸŽ€
  • bool wl_shm_pool::sigbus_is_impossible β€” the bool that says whether SIGBUS is impossible πŸ’€ (iconic name, no notes)
  • ssize_t wl_shm_pool::size β€” the size πŸ“

🧚 Author 🧚

Generated automatically by Doxygen for Wayland from the source code. so nobody hand-wrote this, the machine did it, and honestly? it ate πŸ€–βœ¨


and that's the whole page, bestie!! πŸ¦‹ this little cutie came from the Wayland project, Version 1.26.0, and you're reading wl_shm_pool(3) πŸ’œ go forth and reference your pools responsibly, mwah πŸŽ€πŸ’–πŸŒŸ