al_clear_depth_buffer(3)

💅 al_clear_depth_buffer(3) — the depth buffer clear page, but make it cute 💅

okay so this whole page lives in the Library Functions Manual, and it's the Allegro 5 API page for al_clear_depth_buffer(3). yes bestie, we are clearing a depth buffer and we are going to be normal about it. 🫶✨

---

🎀 NAME 🎀

al_clear_depth_buffer — Allegro 5 API. That's the name, that's the vibe, periodt. 💅

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

void al_clear_depth_buffer(float z)

🌊 DESCRIPTION 🌊

Okay so al_clear_depth_buffer clears the depth buffer — confined by the clipping rectangle, bestie, don't forget that part — to the given value. 🫧

A depth buffer is only available if it was requested with al_set_new_display_option(3) and the requirement could be met by the al_create_display(3) call creating the current display. no buffer, no clearing, that's the rule. 💀

Operations involving the depth buffer are also affected by al_set_render_state(3). keep that in mind, iykyk. 🧚

For example, if ALLEGRO_DEPTH_FUNCTION is set to ALLEGRO_RENDER_LESS, then a depth buffer value of 1 represents infinite distance — and thus 1 is a good value to use when clearing the depth buffer. iconic little fact. 🌈⭐

🦋 SINCE 🦋

5.1.2 — that's when this one showed up, periodt. 🎀

👑 SEE ALSO 👑

• al_clear_to_color(3) — another page on the list, bestie. 💖
• al_set_clipping_rectangle(3) — the clipping rectangle, because the clear is confined by it. ✨
• al_set_render_state(3) — render state can affect depth-buffer operations. 🦋
• al_set_new_display_option(3) — where you request the depth buffer in the first place. 🌸

---

xoxo bestie 💜 this was the Allegro reference manual page for al_clear_depth_buffer(3) — and the footer isn't showing a date here, so no fake date from me, fr fr. 🎀💖