mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-11-10 04:57:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

ebiten: Add comments for DrawTrianglesWithShader(Options)

Browse Source
This commit is contained in:
Hajime Hoshi 2020-07-20 20:37:04 +09:00
parent bb1d08a681
commit e34bb20dcd
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
image.go
View File

@ -346,9 +346,19 @@ func (i *Image) DrawTriangles(vertices []Vertex, indices []uint16, img *Image, o
i.buffered.DrawTriangles([graphics.ShaderImageNum]*buffered.Image{img.buffered}, vs, is, options.ColorM.impl, mode, filter, driver.Address(options.Address), sr, nil, nil)
}
// DrawTrianglesOptionsWithShaderOptions represents options to render triangles on an image with a shader.
//
// Note that this API is experimental.
type DrawTrianglesWithShaderOptions struct {
Uniforms []interface{}
Images [4]*Image
// Uniforms is a set of uniform variables for a shader.
Uniforms []interface{}
// Images is a set of the source images.
// All the image must be the same size.
Images [4]*Image
// CompositeMode is a composite mode to draw.
// The default (zero) value is regular alpha blending.
CompositeMode CompositeMode
}
@ -359,7 +369,15 @@ func init() {
}
}
// TODO: Add comments and tests
// DrawTrianglesWithShader draws a triangle with the specified vertices and their indices with the specified shader.
//
// If len(indices) is not multiple of 3, DrawTrianglesWithShader panics.
//
// If len(indices) is more than MaxIndicesNum, DrawTrianglesWithShader panics.
//
// When a specified image is non-nil and is disposed, DrawTrianglesWithShader panics.
//
// Note that this API is experimental.
func (i *Image) DrawTrianglesWithShader(vertices []Vertex, indices []uint16, shader *Shader, options *DrawTrianglesWithShaderOptions) {
i.copyCheck()