wxGraphicsGradientStops(3)

💖 wxGraphicsGradientStops(3) — Erlang Module Definition 💖

okay bestie, gather round, because today we're talking about wxGraphicsGradientStops, a whole module in the wx Erlang docs, and honestly? it's giving palette curator. it's giving "I hold all the little colour stops so your gradient can pop off." 🎀

---

✨ NAME ✨

wxGraphicsGradientStops — represents a collection of wxGraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush. 🌈

---

🌸 DESCRIPTION 🌸

so the vibe here is: your stops stay in order of position. that's the whole personality. if two or more stops get added with the same position, then the one(s) added later come later. not a bug, not a glitch — that's actually useful, because it lets you produce discontinuities in the colour gradient. hard edges?? we love a hard edge when we asked for one. 💅

⚠️ important heads up, bestie: this class is write-once. you cannot modify the stops once they've been added. no take-backs. no edits. it's done, it's iconic, it's locked in. 🔒

Since: 2.9.1 ⭐

wxWidgets docs: wxGraphicsGradientStops 🦋

---

🧚 DATA TYPES 🧚

• wxGraphicsGradientStops() :: wx:wx_object().

---

👑 FUNCTIONS 👑

• add(This, Col, Pos) -> ok — add a new stop. that's it, that's the function, go off. ✨

add(This, Col, Pos) -> ok
             when
                 This :: wxGraphicsGradientStops(),
                 Col :: wx:wx_colour(),
                 Pos :: number().

• destroy(This :: wxGraphicsGradientStops()) -> ok. — destroys the object. rip little gradient collection, you served. 💀
• getCount(This) -> integer() when This :: wxGraphicsGradientStops(). — returns the number of stops. counting era. 🔢
• getEndColour(This) -> wx:wx_colour4() when This :: wxGraphicsGradientStops(). — returns the end colour. the finale. the last look. 💜
• getStartColour(This) -> wx:wx_colour4() when This :: wxGraphicsGradientStops(). — returns the start colour. the opening act. 🌸
• item(This, N) -> {wx:wx_colour4(), float()} when This :: wxGraphicsGradientStops(), N :: integer(). — returns the stop at the given index. yes, you can just grab one by number, no cap. 🙈
• new([Option]) -> wxGraphicsGradientStops() — initializes the gradient stops with the given boundary colours. creates a wxGraphicsGradientStops instance with start colour given by startCol and end colour given by endCol. the Option type is {startCol, wx:wx_colour()} | {endCol, wx:wx_colour()}. 🫶

new([Option]) -> wxGraphicsGradientStops()
             when
                 Option ::
                     {startCol, wx:wx_colour()} |
                     {endCol, wx:wx_colour()}.

• setEndColour(This, Col) -> ok — set the end colour to col. (even though, reminder, this class is write-once — the original doc says so, i'm just the messenger bestie 😭)

setEndColour(This, Col) -> ok
                      when
                          This :: wxGraphicsGradientStops(),
                          Col :: wx:wx_colour().

• setStartColour(This, Col) -> ok — set the start colour to col. same energy, different end of the gradient. 🎀

setStartColour(This, Col) -> ok
                        when
                            This :: wxGraphicsGradientStops(),
                            Col :: wx:wx_colour().

---

💖 reminder bestie: every stop, every colour, every position — they all matter, and they all have to be in the right order. that's the whole point. main character energy for your gradient. periodt. 👑

---

and that's the tea!! 🍓 this page came to you from Ericsson AB, wx version 2.6, under the wxGraphicsGradientStops(3) name. go make something pretty, ily, bye!! 🌈✨🦋