doc: Add explanation about EBITEN_SCREENSHOT_KEY

This commit is contained in:
Hajime Hoshi 2018-04-11 01:08:44 +09:00
parent 888d650872
commit 30cb4bad90

6
doc.go
View File

@ -36,4 +36,10 @@
// // Call ebiten.Run to start your game loop. // // Call ebiten.Run to start your game loop.
// ebiten.Run(update, 320, 240, 2, "Your game's title") // ebiten.Run(update, 320, 240, 2, "Your game's title")
// } // }
//
// The EBITEN_SCREENSHOT_KEY environment variable specified the key
// to take a screenshot. For example, if you run your game with
// `EBITEN_SCREENSHOT_KEY=q`, you can take a game screen's screenshot
// by pressing Q key. The image file is saved at the current directory
// with the name screen*.png.
package ebiten package ebiten