| Version: 3.3.1

Public Member Functions | List of all members
wxGraphicsGradientStops Class Reference
Class List by Category » Graphics Device Interface (GDI)

`#include <wx/graphics.h>`

## Detailed Description

Represents a collection of wxGraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush.

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.

##

Library: wxCore
Category: Graphics Device Interface (GDI)

Since
  2.9.1

## Public Member Functions
| wxGraphicsGradientStops (wxColour startCol=wxTransparentColour, wxColour endCol=wxTransparentColour)
| Initializes the gradient stops with the given boundary colours. More...
wxGraphicsGradientStop | Item (unsigned n) const
size_t | GetCount () const
void | SetStartColour (wxColour col)
| Set the start colour to col. More...
wxColour | GetStartColour () const
void | SetEndColour (wxColour col)
| Set the end colour to col. More...
wxColour | GetEndColour () const
void | Add (const wxGraphicsGradientStop &stop)
| Add a new stop. More...
void | Add (wxColour col, float pos)
| Add a new stop. More...

## Constructor & Destructor Documentation

## ◆ wxGraphicsGradientStops()

wxGraphicsGradientStops::wxGraphicsGradientStops | ( | wxColour | startCol = `wxTransparentColour`,
|  | wxColour | endCol = `wxTransparentColour`
| ) |  |

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.

## Member Function Documentation

## ◆ Add() [1/2]

void wxGraphicsGradientStops::Add | ( | const wxGraphicsGradientStop & | stop | ) |

Add a new stop.

## ◆ Add() [2/2]

void wxGraphicsGradientStops::Add | ( | wxColour | col,
|  | float | pos
| ) |  |

Add a new stop.

## ◆ GetCount()

size_t wxGraphicsGradientStops::GetCount | ( |  | ) | const

Returns
  The number of stops.

## ◆ GetEndColour()

wxColour wxGraphicsGradientStops::GetEndColour | ( |  | ) | const

Returns
  The end colour.

## ◆ GetStartColour()

wxColour wxGraphicsGradientStops::GetStartColour | ( |  | ) | const

Returns
  The start colour.

## ◆ Item()

wxGraphicsGradientStop wxGraphicsGradientStops::Item | ( | unsigned | n | ) | const

Returns
  The stop at the given index.

Parameters

  n | The index, must be in [0, GetCount()) range.

## ◆ SetEndColour()

void wxGraphicsGradientStops::SetEndColour | ( | wxColour | col | ) |

Set the end colour to col.

## ◆ SetStartColour()

void wxGraphicsGradientStops::SetStartColour | ( | wxColour | col | ) |

Set the start colour to col.