---
title: "Set White Point"
---

### Description

A white point definition is used to adjust the colors.
This method allows to set custom values. If not explicitly
set a default specification is used. The [get_whitepoint](colorspace.colorlib.HSV.get_whitepoint.qmd)
method can be used to extract the currently used definition.

### Usage

<pre><code class='language-python'>HSV.set_whitepoint(**kwargs)</code></pre>

### Arguments

<dl class="pyp-list param-list">
  <dt style = "white-space: nowrap; font-family: monospace; vertical-align: top">
   <code id="colorspace.colorlib.HSV.set_whitepoint:**kwargs">**kwargs</code>
  </dt>
 <dd>Named arguments. Allowed are `X`, `Y`, and `Z`,
each of which must be float: White specification for
dimension `X`/`Y`/`Z`.</dd>
</dl>

### Examples

```{python}
#| echo: true
#| warning: true
#| error: true
from colorspace import hexcols
c = hexcols("#ff0000")
c.set_whitepoint(X = 100., Y = 100., Z = 101.)
c.get_whitepoint()
```




### Raises

<ul class="python-raises">
<li><code class="text-warning">ValueError</code>: If named argument is not one of `X`, `Y`, `Z`.
</ul>

