wxDCOverlay(3erl)

🌸 NAME 🌸

okay bestie, this is wxDCOverlay(3erl) — the Erlang Module Definition for the wxDCOverlay class. It's literally wxDCOverlay — Functions for wxDCOverlay class, and it's giving main-character energy for overlay + DC situations 💅.

🦋 DESCRIPTION 🦋

so wxDCOverlay connects an overlay with a drawing DC. that's the whole vibe: overlay, meet DC; DC, meet overlay. they're linked.

See: wxOverlay, wxDC

wxWidgets docs: wxDCOverlay

🎀 DATA TYPES 🎀

wxDCOverlay() = wx:wx_object()

that's the type, no cap.

✨ EXPORTS ✨

💖 new(Overlay, Dc) -> wxDCOverlay()

new(Overlay, Dc) -> wxDCOverlay()

Types:

• Overlay = wxOverlay:wxOverlay()
• Dc = wxDC:wxDC()

convenience wrapper behavior, same deal, but it uses the entire area of the dc. iconic.

🦋 new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()

new(Overlay, Dc, X, Y, Width, Height) -> wxDCOverlay()

Types:

• Overlay = wxOverlay:wxOverlay()
• Dc = wxDC:wxDC()
• X = Y = Width = Height = integer()

connects this overlay to the corresponding drawing dc. and if the overlay isn't initialized yet? this call will do that too — it handles the init, bestie.

🫶 destroy(This :: wxDCOverlay()) -> ok

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

removes the connection between the overlay and the dc. link severed, respectfully.

🧚 clear(This) -> ok

clear(This) -> ok

Types:

• This = wxDCOverlay()

clears the layer, restoring the state at the last init. reset button energy, fr fr.

---

later bestie 💖 this page is from the wxWidgets team, version wx 2.2.2.1, manual wxDCOverlay(3erl) — and ngl there was no date printed in the footer, so I'm not inventing one 🌈.