2014-12-24 03:04:10 +01:00
// 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
2013-12-02 13:45:10 +01:00
2014-12-22 20:32:36 +01:00
import (
2022-10-15 11:58:56 +02:00
"fmt"
2022-10-02 16:24:15 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/builtinshader"
2022-02-06 12:41:32 +01:00
"github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver"
2022-07-30 19:56:16 +02:00
"github.com/hajimehoshi/ebiten/v2/internal/ui"
2014-12-22 20:32:36 +01:00
)
2018-02-13 18:02:48 +01:00
// Filter represents the type of texture filter to be used when an image is maginified or minified.
2014-12-31 06:57:51 +01:00
type Filter int
2014-12-10 17:06:38 +01:00
const (
2016-08-01 18:47:25 +02:00
// FilterNearest represents nearest (crisp-edged) filter
2022-10-02 16:24:15 +02:00
FilterNearest Filter = Filter ( builtinshader . FilterNearest )
2016-08-01 18:47:25 +02:00
// FilterLinear represents linear filter
2022-10-02 16:24:15 +02:00
FilterLinear Filter = Filter ( builtinshader . FilterLinear )
2014-12-10 17:06:38 +01:00
)
2014-12-31 06:57:51 +01:00
2016-02-29 18:16:32 +01:00
// CompositeMode represents Porter-Duff composition mode.
type CompositeMode int
2016-02-28 16:25:16 +01:00
2016-04-13 18:05:50 +02:00
// This name convention follows CSS compositing: https://drafts.fxtf.org/compositing-2/.
//
2017-05-02 17:10:23 +02:00
// In the comments,
2016-04-13 18:05:50 +02:00
// c_src, c_dst and c_out represent alpha-premultiplied RGB values of source, destination and output respectively. α _src and α _dst represent alpha values of source and destination respectively.
2016-02-28 16:25:16 +01:00
const (
2016-04-13 18:05:50 +02:00
// Regular alpha blending
// c_out = c_src + c_dst × (1 - α _src)
2022-10-15 11:58:56 +02:00
CompositeModeSourceOver CompositeMode = iota
2016-04-13 18:05:50 +02:00
// c_out = 0
2022-10-15 11:58:56 +02:00
CompositeModeClear
2016-04-13 18:05:50 +02:00
// c_out = c_src
2022-10-15 11:58:56 +02:00
CompositeModeCopy
2016-04-13 18:05:50 +02:00
// c_out = c_dst
2022-10-15 11:58:56 +02:00
CompositeModeDestination
2016-04-13 18:05:50 +02:00
2016-04-13 18:09:11 +02:00
// c_out = c_src × (1 - α _dst) + c_dst
2022-10-15 11:58:56 +02:00
CompositeModeDestinationOver
2016-04-13 18:09:11 +02:00
2016-04-13 18:05:50 +02:00
// c_out = c_src × α _dst
2022-10-15 11:58:56 +02:00
CompositeModeSourceIn
2016-04-13 18:05:50 +02:00
// c_out = c_dst × α _src
2022-10-15 11:58:56 +02:00
CompositeModeDestinationIn
2016-04-13 18:05:50 +02:00
// c_out = c_src × (1 - α _dst)
2022-10-15 11:58:56 +02:00
CompositeModeSourceOut
2016-04-13 18:05:50 +02:00
// c_out = c_dst × (1 - α _src)
2022-10-15 11:58:56 +02:00
CompositeModeDestinationOut
2016-04-13 18:05:50 +02:00
// c_out = c_src × α _dst + c_dst × (1 - α _src)
2022-10-15 11:58:56 +02:00
CompositeModeSourceAtop
2016-04-13 18:05:50 +02:00
// c_out = c_src × (1 - α _dst) + c_dst × α _src
2022-10-15 11:58:56 +02:00
CompositeModeDestinationAtop
2016-04-13 18:05:50 +02:00
// c_out = c_src × (1 - α _dst) + c_dst × (1 - α _src)
2022-10-15 11:58:56 +02:00
CompositeModeXor
2016-04-13 18:05:50 +02:00
// Sum of source and destination (a.k.a. 'plus' or 'additive')
// c_out = c_src + c_dst
2022-10-15 11:58:56 +02:00
CompositeModeLighter
2020-07-18 14:37:17 +02:00
// The product of source and destination (a.k.a 'multiply blend mode')
// c_out = c_src * c_dst
2022-10-15 11:58:56 +02:00
CompositeModeMultiply
2016-02-28 16:25:16 +01:00
)
2022-07-30 19:56:16 +02:00
2022-10-15 11:58:56 +02:00
func ( c CompositeMode ) blend ( ) graphicsdriver . Blend {
src , dst := c . blendFactors ( )
return graphicsdriver . Blend {
BlendFactorSourceColor : src ,
BlendFactorSourceAlpha : src ,
BlendFactorDestinationColor : dst ,
BlendFactorDestinationAlpha : dst ,
BlendOperationColor : graphicsdriver . BlendOperationAdd ,
BlendOperationAlpha : graphicsdriver . BlendOperationAdd ,
}
}
func ( c CompositeMode ) blendFactors ( ) ( src graphicsdriver . BlendFactor , dst graphicsdriver . BlendFactor ) {
switch c {
case CompositeModeSourceOver :
return graphicsdriver . BlendFactorOne , graphicsdriver . BlendFactorOneMinusSourceAlpha
case CompositeModeClear :
return graphicsdriver . BlendFactorZero , graphicsdriver . BlendFactorZero
case CompositeModeCopy :
return graphicsdriver . BlendFactorOne , graphicsdriver . BlendFactorZero
case CompositeModeDestination :
return graphicsdriver . BlendFactorZero , graphicsdriver . BlendFactorOne
case CompositeModeDestinationOver :
return graphicsdriver . BlendFactorOneMinusDestinationAlpha , graphicsdriver . BlendFactorOne
case CompositeModeSourceIn :
return graphicsdriver . BlendFactorDestinationAlpha , graphicsdriver . BlendFactorZero
case CompositeModeDestinationIn :
return graphicsdriver . BlendFactorZero , graphicsdriver . BlendFactorSourceAlpha
case CompositeModeSourceOut :
return graphicsdriver . BlendFactorOneMinusDestinationAlpha , graphicsdriver . BlendFactorZero
case CompositeModeDestinationOut :
return graphicsdriver . BlendFactorZero , graphicsdriver . BlendFactorOneMinusSourceAlpha
case CompositeModeSourceAtop :
return graphicsdriver . BlendFactorDestinationAlpha , graphicsdriver . BlendFactorOneMinusSourceAlpha
case CompositeModeDestinationAtop :
return graphicsdriver . BlendFactorOneMinusDestinationAlpha , graphicsdriver . BlendFactorSourceAlpha
case CompositeModeXor :
return graphicsdriver . BlendFactorOneMinusDestinationAlpha , graphicsdriver . BlendFactorOneMinusSourceAlpha
case CompositeModeLighter :
return graphicsdriver . BlendFactorOne , graphicsdriver . BlendFactorOne
case CompositeModeMultiply :
return graphicsdriver . BlendFactorDestinationColor , graphicsdriver . BlendFactorZero
default :
panic ( fmt . Sprintf ( "ebiten: invalid composite mode: %d" , c ) )
}
}
2022-07-30 19:56:16 +02:00
// GraphicsLibrary represets graphics libraries supported by the engine.
type GraphicsLibrary = ui . GraphicsLibrary
const (
// GraphicsLibraryUnknown represents the state at which graphics library cannot be determined,
// e.g. hasn't loaded yet or failed to initialize.
2022-10-08 15:44:39 +02:00
GraphicsLibraryUnknown GraphicsLibrary = ui . GraphicsLibraryUnknown
2022-08-07 21:37:03 +02:00
// GraphicsLibraryOpenGL represents the graphics library OpenGL.
2022-10-08 15:44:39 +02:00
GraphicsLibraryOpenGL GraphicsLibrary = ui . GraphicsLibraryOpenGL
2022-08-07 21:37:03 +02:00
// GraphicsLibraryDirectX represents the graphics library Microsoft DirectX.
2022-10-08 15:44:39 +02:00
GraphicsLibraryDirectX GraphicsLibrary = ui . GraphicsLibraryDirectX
2022-08-07 21:37:03 +02:00
// GraphicsLibraryMetal represents the graphics library Apple's Metal.
2022-10-08 15:44:39 +02:00
GraphicsLibraryMetal GraphicsLibrary = ui . GraphicsLibraryMetal
2022-07-30 19:56:16 +02:00
)
// DebugInfo is a struct to store debug info about the graphics.
type DebugInfo struct {
// GraphicsLibrary represents the graphics library currently in use.
GraphicsLibrary GraphicsLibrary
}
// ReadDebugInfo writes debug info (e.g. current graphics library) into a provided struct.
func ReadDebugInfo ( d * DebugInfo ) {
d . GraphicsLibrary = ui . GetGraphicsLibrary ( )
}