ebiten/colorm.go

145 lines
4.4 KiB
Go
Raw Normal View History

// Copyright 2014 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2014-12-09 15:16:04 +01:00
2014-12-09 14:09:22 +01:00
package ebiten
import (
"fmt"
2017-10-14 16:58:09 +02:00
"image/color"
2020-10-03 19:35:13 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/affine"
2014-12-09 14:09:22 +01:00
)
// ColorMDim is a dimension of a ColorM.
2016-10-31 16:13:19 +01:00
const ColorMDim = affine.ColorMDim
// A ColorM represents a matrix to transform coloring when rendering an image.
//
2017-09-30 18:59:34 +02:00
// A ColorM is applied to the straight alpha color
// while an Image's pixels' format is alpha premultiplied.
// Before applying a matrix, a color is un-multiplied, and after applying the matrix,
// the color is multiplied again.
2014-12-26 03:31:20 +01:00
//
// The initial value is identity.
type ColorM struct {
impl affine.ColorM
_ [0]func() // Marks as non-comparable.
2014-12-09 14:09:22 +01:00
}
func (c *ColorM) affineColorM() affine.ColorM {
if c.impl != nil {
return c.impl
}
return affine.ColorMIdentity{}
}
// String returns a string representation of ColorM.
func (c *ColorM) String() string {
return c.affineColorM().String()
}
2017-05-25 15:50:47 +02:00
// Reset resets the ColorM as identity.
func (c *ColorM) Reset() {
c.impl = affine.ColorMIdentity{}
2017-05-25 15:50:47 +02:00
}
2017-10-14 16:58:09 +02:00
// Apply pre-multiplies a vector (r, g, b, a, 1) by the matrix
2017-10-14 17:00:44 +02:00
// where r, g, b, and a are clr's values in straight-alpha format.
2017-10-14 16:58:09 +02:00
// In other words, Apply calculates ColorM * (r, g, b, a, 1)^T.
func (c *ColorM) Apply(clr color.Color) color.Color {
return c.affineColorM().Apply(clr)
2017-10-14 16:58:09 +02:00
}
2014-12-14 14:05:44 +01:00
// Concat multiplies a color matrix with the other color matrix.
2016-02-15 15:08:10 +01:00
// This is same as muptiplying the matrix other and the matrix c in this order.
2014-12-29 11:04:18 +01:00
func (c *ColorM) Concat(other ColorM) {
o := other.impl
if o == nil {
return
}
c.impl = c.affineColorM().Concat(o)
2014-12-09 14:09:22 +01:00
}
2016-02-15 20:46:28 +01:00
// Scale scales the matrix by (r, g, b, a).
2015-01-03 10:35:44 +01:00
func (c *ColorM) Scale(r, g, b, a float64) {
c.impl = c.affineColorM().Scale(float32(r), float32(g), float32(b), float32(a))
2015-01-03 10:35:44 +01:00
}
// ScaleWithColor scales the matrix by clr.
func (c *ColorM) ScaleWithColor(clr color.Color) {
cr, cg, cb, ca := clr.RGBA()
if ca == 0 {
c.Scale(0, 0, 0, 0)
return
}
c.Scale(float64(cr)/float64(ca), float64(cg)/float64(ca), float64(cb)/float64(ca), float64(ca)/0xffff)
}
2016-02-15 20:46:28 +01:00
// Translate translates the matrix by (r, g, b, a).
2015-01-03 10:35:44 +01:00
func (c *ColorM) Translate(r, g, b, a float64) {
c.impl = c.affineColorM().Translate(float32(r), float32(g), float32(b), float32(a))
2015-01-03 10:35:44 +01:00
}
2016-02-06 15:56:02 +01:00
// RotateHue rotates the hue.
2017-09-30 18:59:34 +02:00
// theta represents rotating angle in radian.
2016-02-06 15:56:02 +01:00
func (c *ColorM) RotateHue(theta float64) {
2017-09-30 18:59:34 +02:00
c.ChangeHSV(theta, 1, 1)
}
// ChangeHSV changes HSV (Hue-Saturation-Value) values.
2018-10-12 17:07:48 +02:00
// hueTheta is a radian value to rotate hue.
// saturationScale is a value to scale saturation.
// valueScale is a value to scale value (a.k.a. brightness).
//
// This conversion uses RGB to/from YCrCb conversion.
func (c *ColorM) ChangeHSV(hueTheta float64, saturationScale float64, valueScale float64) {
c.impl = affine.ChangeHSV(c.affineColorM(), hueTheta, float32(saturationScale), float32(valueScale))
2016-02-06 15:56:02 +01:00
}
2016-10-31 16:13:19 +01:00
// Element returns a value of a matrix at (i, j).
func (c *ColorM) Element(i, j int) float64 {
return float64(c.affineColorM().At(i, j))
2016-10-31 16:13:19 +01:00
}
2016-10-31 16:13:19 +01:00
// SetElement sets an element at (i, j).
2017-09-30 18:59:34 +02:00
func (c *ColorM) SetElement(i, j int, element float64) {
c.impl = affine.ColorMSetElement(c.affineColorM(), i, j, float32(element))
}
// IsInvertible returns a boolean value indicating
// whether the matrix c is invertible or not.
func (c *ColorM) IsInvertible() bool {
return c.affineColorM().IsInvertible()
}
// Invert inverts the matrix.
// If c is not invertible, Invert panics.
func (c *ColorM) Invert() {
c.impl = c.affineColorM().Invert()
}
// ReadElements reads the body part and the translation part to the given float32 slices.
//
// len(body) must be 16 and len(translation) must be 4. Otherwise, ReadElements panics.
func (c *ColorM) ReadElements(body []float32, translation []float32) {
if len(body) != 16 {
panic(fmt.Sprintf("ebiten: len(body) must be 16 but %d", len(body)))
}
if len(translation) != 4 {
panic(fmt.Sprintf("ebiten: len(translation) must be 4 but %d", len(translation)))
}
c.affineColorM().Elements(body, translation)
}