# {py:mod}`simvx.core.gradient`

```{py:module} simvx.core.gradient
```

```{autodoc2-docstring} simvx.core.gradient
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`GradientDirection <simvx.core.gradient.GradientDirection>`
  - ```{autodoc2-docstring} simvx.core.gradient.GradientDirection
    :summary:
    ```
* - {py:obj}`Gradient <simvx.core.gradient.Gradient>`
  - ```{autodoc2-docstring} simvx.core.gradient.Gradient
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`reject_gradient <simvx.core.gradient.reject_gradient>`
  - ```{autodoc2-docstring} simvx.core.gradient.reject_gradient
    :summary:
    ```
* - {py:obj}`fill_corner_colours <simvx.core.gradient.fill_corner_colours>`
  - ```{autodoc2-docstring} simvx.core.gradient.fill_corner_colours
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.gradient.__all__>`
  - ```{autodoc2-docstring} simvx.core.gradient.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.gradient.__all__
:value: >
   ['Gradient', 'GradientDirection', 'fill_corner_colours', 'reject_gradient']

```{autodoc2-docstring} simvx.core.gradient.__all__
```

````

`````{py:class} GradientDirection()
:canonical: simvx.core.gradient.GradientDirection

Bases: {py:obj}`enum.StrEnum`

```{autodoc2-docstring} simvx.core.gradient.GradientDirection
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.gradient.GradientDirection.__init__
```

````{py:attribute} VERTICAL
:canonical: simvx.core.gradient.GradientDirection.VERTICAL
:value: >
   'vertical'

```{autodoc2-docstring} simvx.core.gradient.GradientDirection.VERTICAL
```

````

````{py:attribute} HORIZONTAL
:canonical: simvx.core.gradient.GradientDirection.HORIZONTAL
:value: >
   'horizontal'

```{autodoc2-docstring} simvx.core.gradient.GradientDirection.HORIZONTAL
```

````

````{py:method} __new__(*values)
:canonical: simvx.core.gradient.GradientDirection.__new__

````

````{py:method} __add__()
:canonical: simvx.core.gradient.GradientDirection.__add__

````

````{py:method} __contains__()
:canonical: simvx.core.gradient.GradientDirection.__contains__

````

````{py:method} __delattr__()
:canonical: simvx.core.gradient.GradientDirection.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.gradient.GradientDirection.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core.gradient.GradientDirection.__eq__

````

````{py:method} __format__()
:canonical: simvx.core.gradient.GradientDirection.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.gradient.GradientDirection.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.gradient.GradientDirection.__getattribute__

````

````{py:method} __getitem__()
:canonical: simvx.core.gradient.GradientDirection.__getitem__

````

````{py:method} __getnewargs__()
:canonical: simvx.core.gradient.GradientDirection.__getnewargs__

````

````{py:method} __getstate__()
:canonical: simvx.core.gradient.GradientDirection.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.gradient.GradientDirection.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.gradient.GradientDirection.__hash__

````

````{py:method} __iter__()
:canonical: simvx.core.gradient.GradientDirection.__iter__

````

````{py:method} __le__()
:canonical: simvx.core.gradient.GradientDirection.__le__

````

````{py:method} __len__()
:canonical: simvx.core.gradient.GradientDirection.__len__

````

````{py:method} __lt__()
:canonical: simvx.core.gradient.GradientDirection.__lt__

````

````{py:method} __mod__()
:canonical: simvx.core.gradient.GradientDirection.__mod__

````

````{py:method} __mul__()
:canonical: simvx.core.gradient.GradientDirection.__mul__

````

````{py:method} __ne__()
:canonical: simvx.core.gradient.GradientDirection.__ne__

````

````{py:method} __reduce__()
:canonical: simvx.core.gradient.GradientDirection.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.gradient.GradientDirection.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.gradient.GradientDirection.__repr__

````

````{py:method} __rmod__()
:canonical: simvx.core.gradient.GradientDirection.__rmod__

````

````{py:method} __rmul__()
:canonical: simvx.core.gradient.GradientDirection.__rmul__

````

````{py:method} __setattr__()
:canonical: simvx.core.gradient.GradientDirection.__setattr__

````

````{py:method} __sizeof__()
:canonical: simvx.core.gradient.GradientDirection.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.gradient.GradientDirection.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.gradient.GradientDirection.__subclasshook__

````

````{py:method} capitalize()
:canonical: simvx.core.gradient.GradientDirection.capitalize

````

````{py:method} casefold()
:canonical: simvx.core.gradient.GradientDirection.casefold

````

````{py:method} center()
:canonical: simvx.core.gradient.GradientDirection.center

````

````{py:method} count()
:canonical: simvx.core.gradient.GradientDirection.count

````

````{py:method} encode()
:canonical: simvx.core.gradient.GradientDirection.encode

````

````{py:method} endswith()
:canonical: simvx.core.gradient.GradientDirection.endswith

````

````{py:method} expandtabs()
:canonical: simvx.core.gradient.GradientDirection.expandtabs

````

````{py:method} find()
:canonical: simvx.core.gradient.GradientDirection.find

````

````{py:method} format()
:canonical: simvx.core.gradient.GradientDirection.format

````

````{py:method} format_map()
:canonical: simvx.core.gradient.GradientDirection.format_map

````

````{py:method} index()
:canonical: simvx.core.gradient.GradientDirection.index

````

````{py:method} isalnum()
:canonical: simvx.core.gradient.GradientDirection.isalnum

````

````{py:method} isalpha()
:canonical: simvx.core.gradient.GradientDirection.isalpha

````

````{py:method} isascii()
:canonical: simvx.core.gradient.GradientDirection.isascii

````

````{py:method} isdecimal()
:canonical: simvx.core.gradient.GradientDirection.isdecimal

````

````{py:method} isdigit()
:canonical: simvx.core.gradient.GradientDirection.isdigit

````

````{py:method} isidentifier()
:canonical: simvx.core.gradient.GradientDirection.isidentifier

````

````{py:method} islower()
:canonical: simvx.core.gradient.GradientDirection.islower

````

````{py:method} isnumeric()
:canonical: simvx.core.gradient.GradientDirection.isnumeric

````

````{py:method} isprintable()
:canonical: simvx.core.gradient.GradientDirection.isprintable

````

````{py:method} isspace()
:canonical: simvx.core.gradient.GradientDirection.isspace

````

````{py:method} istitle()
:canonical: simvx.core.gradient.GradientDirection.istitle

````

````{py:method} isupper()
:canonical: simvx.core.gradient.GradientDirection.isupper

````

````{py:method} join()
:canonical: simvx.core.gradient.GradientDirection.join

````

````{py:method} ljust()
:canonical: simvx.core.gradient.GradientDirection.ljust

````

````{py:method} lower()
:canonical: simvx.core.gradient.GradientDirection.lower

````

````{py:method} lstrip()
:canonical: simvx.core.gradient.GradientDirection.lstrip

````

````{py:method} partition()
:canonical: simvx.core.gradient.GradientDirection.partition

````

````{py:method} removeprefix()
:canonical: simvx.core.gradient.GradientDirection.removeprefix

````

````{py:method} removesuffix()
:canonical: simvx.core.gradient.GradientDirection.removesuffix

````

````{py:method} replace()
:canonical: simvx.core.gradient.GradientDirection.replace

````

````{py:method} rfind()
:canonical: simvx.core.gradient.GradientDirection.rfind

````

````{py:method} rindex()
:canonical: simvx.core.gradient.GradientDirection.rindex

````

````{py:method} rjust()
:canonical: simvx.core.gradient.GradientDirection.rjust

````

````{py:method} rpartition()
:canonical: simvx.core.gradient.GradientDirection.rpartition

````

````{py:method} rsplit()
:canonical: simvx.core.gradient.GradientDirection.rsplit

````

````{py:method} rstrip()
:canonical: simvx.core.gradient.GradientDirection.rstrip

````

````{py:method} split()
:canonical: simvx.core.gradient.GradientDirection.split

````

````{py:method} splitlines()
:canonical: simvx.core.gradient.GradientDirection.splitlines

````

````{py:method} startswith()
:canonical: simvx.core.gradient.GradientDirection.startswith

````

````{py:method} strip()
:canonical: simvx.core.gradient.GradientDirection.strip

````

````{py:method} swapcase()
:canonical: simvx.core.gradient.GradientDirection.swapcase

````

````{py:method} title()
:canonical: simvx.core.gradient.GradientDirection.title

````

````{py:method} translate()
:canonical: simvx.core.gradient.GradientDirection.translate

````

````{py:method} upper()
:canonical: simvx.core.gradient.GradientDirection.upper

````

````{py:method} zfill()
:canonical: simvx.core.gradient.GradientDirection.zfill

````

````{py:method} __deepcopy__(memo)
:canonical: simvx.core.gradient.GradientDirection.__deepcopy__

````

````{py:method} __copy__()
:canonical: simvx.core.gradient.GradientDirection.__copy__

````

````{py:method} name()
:canonical: simvx.core.gradient.GradientDirection.name

````

````{py:method} value()
:canonical: simvx.core.gradient.GradientDirection.value

````

`````

`````{py:class} Gradient
:canonical: simvx.core.gradient.Gradient

```{autodoc2-docstring} simvx.core.gradient.Gradient
```

````{py:attribute} start
:canonical: simvx.core.gradient.Gradient.start
:type: simvx.core.gradient.ColourValue
:value: >
   None

```{autodoc2-docstring} simvx.core.gradient.Gradient.start
```

````

````{py:attribute} end
:canonical: simvx.core.gradient.Gradient.end
:type: simvx.core.gradient.ColourValue
:value: >
   None

```{autodoc2-docstring} simvx.core.gradient.Gradient.end
```

````

````{py:attribute} direction
:canonical: simvx.core.gradient.Gradient.direction
:type: simvx.core.gradient.GradientDirection
:value: >
   None

```{autodoc2-docstring} simvx.core.gradient.Gradient.direction
```

````

````{py:method} __post_init__() -> None
:canonical: simvx.core.gradient.Gradient.__post_init__

```{autodoc2-docstring} simvx.core.gradient.Gradient.__post_init__
```

````

````{py:method} corner_colours() -> tuple[simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue]
:canonical: simvx.core.gradient.Gradient.corner_colours

```{autodoc2-docstring} simvx.core.gradient.Gradient.corner_colours
```

````

`````

````{py:function} reject_gradient(fill, primitive: str) -> None
:canonical: simvx.core.gradient.reject_gradient

```{autodoc2-docstring} simvx.core.gradient.reject_gradient
```
````

````{py:function} fill_corner_colours(fill) -> tuple[simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue, simvx.core.gradient.ColourValue]
:canonical: simvx.core.gradient.fill_corner_colours

```{autodoc2-docstring} simvx.core.gradient.fill_corner_colours
```
````