Categorygithub.com/esimov/gomp
modulepackage
1.0.2
Repository: https://github.com/esimov/gomp.git
Documentation: pkg.go.dev

# README

gomp

Coverage CI go.dev reference release license

Go library for image blending and alpha compositing using advanced features like the Porter-Duff operator and blending modes.

About

The reason why this package has been developed is because the image/draw package from Go's standard library defines only one operation: drawing a source image onto the destination image, through an optional image mask. This is performed pixel by pixel and it's based on the classic "Compositing Digital Images" paper by Porter and Duff. This paper presented 12 different composition operation, but the Draw method uses only two of them: source over destination and source.

When dealing with image composition this is simply not enough. This library aims to overcome this deficiency by integrating the missing operators.

Alpha compositing
compositing

Blending modes

For convenience, this package implements also some of the most used blending modes in Photoshop. Similarly to the alpha compositing, blending modes defines the result of compositing a source and a destination but without being constrained to the alpha channel. The implementation follows the blending formulas presented in the W3C document: Compositing and Blending. These blending modes are not covered by Porter and Duff, but have been included into this package for convenience.

Blending modes
blending

Installation

$ go install github.com/esimov/gomp@latest

API

The API of the library is inspired by the PorterDuff.Mode class from the Android SDK.

Alpha compositing

op := gomp.InitOp()
op.Set(gomp.SrcOver)
bmp := gomp.NewBitmap(image.Rect(0, 0, size, size))
imop.Draw(bmp, source, backdrop, nil)

Blending modes

op := gomp.NewBlend()
op.Set(gomp.Multiply)
bmp := gomp.NewBitmap(image.Rect(0, 0, size, size))
imop.Draw(bmp, source, backdrop, op)

You can combine the alpha compositing with blending modes at the same step, you just need to replace the last parameter of the Draw method with the initialized blending operation.

Alpha compositing and blending modes combined

imop := gomp.InitOp()
blop := gomp.NewBlend()
blop.Set(gomp.Multiply)
imop.Set(gomp.SrcOver)
bmp := gomp.NewBitmap(image.Rect(0, 0, size, size))
imop.Draw(bmp, srcImg, bgr, blop)

Operators

Image compositingSeparable blending modesNon-separable blending modes
ClearNormalHue
CopyDarkenSaturation
DstLightenColorMode
SrcOverMultiplyLuminosity
DstOverScreen
SrcInOverlay
DstInSoftLight
SrcOutHardLight
DstOutColorDodge
SrcAtopColorBurn
DstAtopDifference
Exclusion

Examples

The images used in this document for visualizing the alpha compositing operation and the blending modes have been generated using this library. They can be found in the examples folder.

Author

License

Copyright © 2022 Endre Simo

This software is distributed under the MIT license. See the LICENSE file for the full license text.

# Packages

No description provided by the author

# Functions

Abs returns the absolut value of x.
Contains returns true if a value is available in the collection.
ImgToNRGBA converts any image type to *image.NRGBA with min-point at (0, 0).
InitOp initializes a new composition operation.
Max returns the biggest value from the provided parameters.
Min returns the lowest value from the provided parameters.
NewBitmap initializes a new Bitmap.
NewBlend initializes a new Blend.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Non-separable blend modes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Bitmap holds an image type as a placeholder for the Porter-Duff composition operations which can be used as a source or destination image.
Blend struct contains the currently active blend mode and all the supported blend modes.
Color represents the RGB channel of a specific color.
Comp struct contains the currently active composition operation and all the supported operations.