wxMask(3erl)

💖 wxMask 💖

okay bestie, you're on the wxMask(3erl) page from the Erlang Module Definition manual. it's giving "mask bitmap main character energy," and we're gonna cover every function, type, note, and reference. no skips, fr fr. 🫶

🌸 NAME 🌸

wxMask — Functions for wxMask class. that's the name, that's the vibe. 💅

✨ DESCRIPTION ✨

This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white. yes: black = masked, white = unmasked. iconic contrast, lowkey obsessed. 🖤🤍

When associated with a bitmap and drawn in a device context, the unmasked area of the bitmap will be drawn, and the masked area will not be drawn. so the visible part slays, the masked part sits quietly. periodt. ✨

Note: A mask can be associated also with a bitmap with an alpha channel, but drawing such bitmaps under wxMSW may be slow, so using them should be avoided if drawing performance is an important factor. not me warning you about speed, but yes — if performance matters, maybe don't, bestie. 💀

See: wxBitmap, wxDC:blit/6, wxMemoryDC — the related cast. also, wxWidgets docs: wxMask for the official lore. 📚

🦋 DATA TYPES 🦋

• wxMask() = wx:wx_object() — that's the type alias, exactly as the page says. no cap.

👑 EXPORTS 👑

new()

new() -> wxMask()

Default constructor. literally the default one, zero args, just vibes. ✨

new(Bitmap)

new(Bitmap) -> wxMask()

Types:

• Bitmap = wxBitmap:wxBitmap()

Constructs a mask from a monochrome bitmap. 🎀

new(Bitmap, Index) and new(Bitmap, Colour)

new(Bitmap, Index) -> wxMask()

new(Bitmap, Colour) -> wxMask()

Types:

• Bitmap = wxBitmap:wxBitmap()
• Colour = wx:wx_colour()

Constructs a mask from a bitmap and a colour that indicates the background.

destroy(This :: wxMask())

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

Destroys the wxMask object and the underlying bitmap data. bye bye, bitmap data. 🫡

create(This, Bitmap)

create(This, Bitmap) -> boolean()

Types:

• This = wxMask()
• Bitmap = wxBitmap:wxBitmap()

Constructs a mask from a monochrome bitmap. same iconic monochrome bitmap energy, now with create. ✨

create(This, Bitmap, Index) and create(This, Bitmap, Colour)

create(This, Bitmap, Index) -> boolean()

create(This, Bitmap, Colour) -> boolean()

Types:

• This = wxMask()
• Bitmap = wxBitmap:wxBitmap()
• Colour = wx:wx_colour()

Constructs a mask from a bitmap and a colour that indicates the background.

---

that's a wrap! sign-off from the wxWidgets team, version wx 2.2.2.1, page label wxMask(3erl). love u, bye! 💖💋