wxGraphi...ientStops(3erl)

📦
version 25.3.2.8 · 5 versions
, in ubuntu noble

💖 wxGraphi...ientStops(3erl) 💖

okay bestie, welcome to the Erlang Module Definition for wxGraphi...ientStops(3erl) — this is the wxWidgets docs page for wxGraphicsGradientStops, and it’s lowkey the little collection-of-gradient-stops class you didn’t know you needed. It’s giving main character energy for gradient brushes, no cap. Let’s get into it, fr fr.

🌸 NAME 🌸

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

🦋 DESCRIPTION 🦋

The way that this works: the stops are maintained in order of position. If two or more stops are added with the same position then the one(s) added later come later. This can be useful for producing discontinuities in the colour gradient.

⚠️ Notice that this class is write-once — you can't modify the stops once they had been added. So no take-backs, bestie. Periodt. 💅

Since: 2.9.1

wxWidgets docs: wxGraphicsGradientStops

🎀 DATA TYPES 🎀

  • wxGraphicsGradientStops() = wx:wx_object()

✨ EXPORTS ✨

💖 new() -> wxGraphicsGradientStops()

No options, just the zero-argument constructor. Fresh gradient-stops object energy. ✨

new(Options :: [Option]) -> wxGraphicsGradientStops()

Types:

Option = {startCol, wx:wx_colour()} | {endCol, wx:wx_colour()}

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.

item(This, N) -> {wx:wx_colour4(), float()}

Types:

This = wxGraphicsGradientStops()
N = integer()

Returns the stop at the given index.

getCount(This) -> integer()

Types:

This = wxGraphicsGradientStops()

Returns the number of stops.

setStartColour(This, Col) -> ok

Types:

This = wxGraphicsGradientStops()
Col = wx:wx_colour()

Set the start colour to Col.

getStartColour(This) -> wx:wx_colour4()

Types:

This = wxGraphicsGradientStops()

Returns the start colour.

setEndColour(This, Col) -> ok

Types:

This = wxGraphicsGradientStops()
Col = wx:wx_colour()

Set the end colour to Col.

getEndColour(This) -> wx:wx_colour4()

Types:

This = wxGraphicsGradientStops()

Returns the end colour.

add(This, Col, Pos) -> ok

Types:

This = wxGraphicsGradientStops()
Col = wx:wx_colour()
Pos = number()

Add a new stop. Slay.

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

Destroys the object.

💌 cute sign-off: source = wxWidgets team, version = wx 2.2.2.1, date = not shown in the original footer (so no fake date, ngl), and the footer id is wxGraphi...ientStops(3erl). 🫶

📦 where this page comes from