Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-12-19 07:15:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add boolean feature for bitwise image operations (#501)

Browse Source
This commit is contained in:
Matt Hirsch
2016-07-11 04:51:43 -04:00
committed by Lovell Fuller
parent 99f960bf56
commit d17e8d3450
14 changed files with 256 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/api.md
View File

@@ -519,6 +519,21 @@ sharp('input.png')
```
In the above example if `input.png` is a 3 channel RGB image, `output.png` will be a 1 channel grayscale image where each pixel `P = R & G & B`. For example, if `I(1,1) = [247, 170, 14] = [0b11110111, 0b10101010, 0b00001111]` then `O(1,1) = 0b11110111 & 0b10101010 & 0b00001111 = 0b00000010 = 2`.
#### boolean(image, operation)
Perform a bitwise boolean operation with `image`.
`image` is one of the following.
* Buffer contianing PNG, WebP, GIF or SVG image data, or
* String containing the path to an image file
This operation creates an output image where each pixel is the result of the selected bitwise boolean `operation`, between the corresponding pixels of the input images. The boolean operation can be one of the following:
* `and` performs a bitwise and operation, like the c-operator `&`
* `or` performs a bitwise or operation, like the c-operator `|`
* `eor` performs a bitwise exclusive or operation, like the c-operator `^`
### Output