mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Enable hsl shifting of named images

Browse source
This commit is contained in:
Samuel Attard 2017-10-10 17:05:13 +11:00
parent 767a178bd1
commit b5ba8699f3
No known key found for this signature in database
GPG key ID: E89DDE5742D58C4E
2 changed files with 50 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/api/native-image.md
View file

@ -157,9 +157,10 @@ Returns `NativeImage`
Creates a new `NativeImage` instance from `dataURL`.
### `nativeImage.createFromNamedImage(imageName)` _macOS_
### `nativeImage.createFromNamedImage(imageName[, hslShift])` _macOS_
* `imageName` String
* `hslShift` Number[]
Returns `NativeImage`
@ -167,6 +168,23 @@ Creates a new `NativeImage` instance from the NSImage that maps to the
given image name. See [`NSImageName`](https://developer.apple.com/documentation/appkit/nsimagename?language=objc)
for a list of possible values.
The `hslShift` is applied to the image with the following rules
* `hsl_shift[0]` (hue): The absolute hue value for the image - 0 and 1 map
to 0 and 360 on the hue color wheel (red).
* `hsl_shift[1]` (saturation): A saturation shift for the image, with the
following key values:
0 = remove all color.
0.5 = leave unchanged.
1 = fully saturate the image.
* `hsl_shift[2]` (lightness): A lightness shift for the image, with the
following key values:
0 = remove all lightness (make all pixels black).
0.5 = leave unchanged.
1 = full lightness (make all pixels white).
This means that `[-1, 0, 1]` will make the image completely white and
`[-1, 1, 0]` will make the image completely black.
## Class: NativeImage
> Natively wrap images such as tray, dock, and application icons.