<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxGraphicsGradientStops</title>
</header>
<module>wxGraphicsGradientStops</module>
<modulesummary>Represents a collection of wxGraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush. </modulesummary>
<description><p>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.
      </p><p>Notice that this class is write-once, you can't modify the stops once they had been added.
      </p><p>Since: 2.9.1 
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_graphics_gradient_stops.html">wxGraphicsGradientStops</url></p>
  </description>
<datatypes><datatype><name name="wxGraphicsGradientStops"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>See: <c>new/1</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Initializes the gradient stops with the given boundary colours. </fsummary>
    <desc><p>Initializes the gradient stops with the given boundary colours. 
      </p><p>Creates a <seeerl marker="wxGraphicsGradientStops"><c>wxGraphicsGradientStops</c></seeerl> instance with start colour given by <c>startCol</c> and end colour given by <c>endCol</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="item" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the stop at the given index. </fsummary>
    <desc><p>Returns the stop at the given index. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCount" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of stops. </fsummary>
    <desc><p>Returns the number of stops. 
      </p></desc>
  </func>
  
  <func>
    <name name="setStartColour" arity="2" clause_i="1" since=""/>
    <fsummary>Set the start colour to <c>col</c>. </fsummary>
    <desc><p>Set the start colour to <c>col</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getStartColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the start colour. </fsummary>
    <desc><p>Returns the start colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="setEndColour" arity="2" clause_i="1" since=""/>
    <fsummary>Set the end colour to <c>col</c>. </fsummary>
    <desc><p>Set the end colour to <c>col</c>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getEndColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the end colour. </fsummary>
    <desc><p>Returns the end colour. 
      </p></desc>
  </func>
  
  <func>
    <name name="add" arity="3" clause_i="1" since=""/>
    <fsummary>Add a new stop. </fsummary>
    <desc><p>Add a new stop. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
