From 192c455b16c3ebb77b8adc56c5c01bac67499dde Mon Sep 17 00:00:00 2001
From: faiface <faiface@ksp.sk>
Date: Sun, 22 Jan 2017 01:49:09 +0100
Subject: [PATCH] document pixelgl.Frame
---
pixelgl/frame.go | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/pixelgl/frame.go b/pixelgl/frame.go
index e8d663c..b521503 100644
--- a/pixelgl/frame.go
+++ b/pixelgl/frame.go
@@ -8,12 +8,14 @@ import (
"github.com/go-gl/gl/v3.3-core/gl"
)
+// Frame is a fixed resolution texture that you can draw on.
type Frame struct {
fb binder
tex *Texture
width, height int
}
+// NewFrame creates a new fully transparent Frame with given dimensions.
func NewFrame(width, height int, smooth bool) *Frame {
f := &Frame{
fb: binder{
@@ -46,22 +48,29 @@ func (f *Frame) delete() {
})
}
+// Width returns the width of the Frame in pixels.
func (f *Frame) Width() int {
return f.width
}
+// Height returns the height of the Frame in pixels.
func (f *Frame) Height() int {
return f.height
}
+// Begin binds the Frame. All draw operations will target this Frame until End is called.
func (f *Frame) Begin() {
f.fb.bind()
}
+// End unbinds the Frame. All draw operations will go to whatever was bound before this Frame.
func (f *Frame) End() {
f.fb.restore()
}
+// Texture returns the Texture that this Frame draws to. The Texture changes as you use the Frame.
+//
+// The Texture pointer returned from this method is always the same.
func (f *Frame) Texture() *Texture {
return f.tex
}
--
GitLab