create_sub_zbuffer(3alleg4)

📦 version 4.4.3.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 create_sub_zbuffer 💖

okay so bestie, welcome to the Allegro manual — this lil page is create_sub_zbuffer(3alleg4) and it's literally about making a sub-z-buffer. yes, a z-buffer inside another z-buffer. nesting era. 🪆✨

✨ NAME ✨

create_sub_zbuffer — Creates a sub-z-buffer. Allegro game programming library.

🦋 SYNOPSIS 🦋

#include <allegro.h>

ZBUFFER *create_sub_zbuffer(ZBUFFER *parent, int x, int y, int width,
       int height);

🌸 DESCRIPTION 🌸

So here's the vibe: this function creates a sub-z-buffer, which is like a z-buffer that shares drawing memory with a z-buffer you already made, but it can be a different size. sharing is caring, no cap. 💅

The same rules as for sub-bitmaps apply here, so listen up:

  • the sub-z-buffer's width and height can extend beyond the right and bottom edges of the parent — they'll get clipped, nbd
  • but the origin point (x, y) must lie within the parent region. that part is not negotiable, bestie 🚫

Now for the part that actually matters. When you're drawing z-buffered to a bitmap, the top left corner of the bitmap always maps to the top left corner of the current z-buffer. periodt. So this function is mainly useful when you want to draw to a sub-bitmap and use the corresponding sub-area of the z-buffer alongside it. 💫

Other cases? Like if you just wanna draw to a sub-bitmap of screen and not to other parts of screen — then you'd usually want a normal z-buffer (not a sub-z-buffer, okay??) the size of the visible screen. 🙈

And pls, hear me on this: you do NOT need to first create a z-buffer the size of the virtual screen and then make a sub-z-buffer of that. skipping the middleman is the move. 👑

🎀 RETURN VALUE 🎀

Returns the pointer to the sub ZBUFFER, or NULL if there was an error. 😭

Remember to destroy the ZBUFFER once you are done with it, to avoid having memory leaks. leaks are not the vibe, bestie. 🫶

🌈 SEE ALSO 🌈

and that's the whole page, iykyk 💜 this was the Allegro manual, version 4.4.3, all about create_sub_zbuffer(3alleg4) — go forth and nest your z-buffers responsibly, mwah 🎀✨

📦 where this page comes from