wxDCOverlay(3)

💖 wxDCOverlay 💖

okay so bestie, welcome to wxDCOverlay — the Erlang module that connects an overlay with a drawing DC. that's it, that's the vibe. yes it's giving "graphics glue code" and yes we're gonna slay it anyway 💅

---

🌸 DESCRIPTION 🌸

this one's a little "go read the receipts" situation ngl, because the docs just point you at your besties:

• wxOverlay
• wxDC

and if you want the full lore, the wxWidgets docs for wxDCOverlay are right there. go look, i'll wait 🫶

---

✨ DATA TYPES ✨

• wxDCOverlay() :: wx:wx_object().

that's the whole type. it's an object. it's iconic. periodt 👑

---

🔥 FUNCTIONS 🔥

• clear(This) -> ok when This :: wxDCOverlay().

clears the layer and restores the state from the last init. basically an undo button for your overlay, no cap. ✨

• destroy(This :: wxDCOverlay()) -> ok.

destroys the object. it's over, it's done, say goodbye 💀 (politely, obviously).

• new(Overlay, Dc) -> wxDCOverlay() when Overlay :: wxOverlay:wxOverlay(), Dc :: wxDC:wxDC().

it's a convenience wrapper bestie, and it behaves exactly the same — except it uses the entire area of the dc. the whole thing. main character energy, covers everything 🌈

• new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay() when:
  • Overlay :: wxOverlay:wxOverlay()
  • Dc :: wxDC:wxDC()
  • X :: integer()
  • Y :: integer()
  • Width :: integer()
  • Height :: integer()

connects this overlay to the corresponding drawing dc. and okay heads up — if the overlay isn't initialized yet, this call will do that for you. it's proactive like that, we love a self-starter 🎀

%% the shapes, verbatim, so you never have to guess
new(Overlay, Dc) -> wxDCOverlay()
new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()
clear(This) -> ok
destroy(This :: wxDCOverlay()) -> ok

---

that's the whole page, bestie. go draw something gorgeous on top of something else, it's literally your moment 💜

brought to you by Ericsson AB, from the wx 2.6 era — yes, 2.6, it's vintage, it's giving antique, and honestly? it still ate. mwah 🎀💖