mirror of
https://github.com/hajimehoshi/ebiten.git
synced 2024-12-26 03:38:55 +01:00
105 lines
4.5 KiB
Go
105 lines
4.5 KiB
Go
// 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.
|
|
|
|
// Package ebiten provides graphics and input API to develop a 2D game.
|
|
//
|
|
// You can start the game by calling the function RunGame.
|
|
//
|
|
// // Game implements ebiten.Game interface.
|
|
// type Game struct{}
|
|
//
|
|
// // Update proceeds the game state.
|
|
// // Update is called every tick (1/60 [s] by default).
|
|
// func (g *Game) Update() error {
|
|
// // Write your game's logical update.
|
|
// return nil
|
|
// }
|
|
//
|
|
// // Draw draws the game screen.
|
|
// // Draw is called every frame (typically 1/60[s] for 60Hz display).
|
|
// func (g *Game) Draw(screen *ebiten.Image) {
|
|
// // Write your game's rendering.
|
|
// }
|
|
//
|
|
// // Layout takes the outside size (e.g., the window size) and returns the (logical) screen size.
|
|
// // If you don't have to adjust the screen size with the outside size, just return a fixed size.
|
|
// func (g *Game) Layout(outsideWidth, outsideHeight int) (screenWidth, screenHeight int) {
|
|
// return 320, 240
|
|
// }
|
|
//
|
|
// func main() {
|
|
// game := &Game{}
|
|
// // Specify the window size as you like. Here, a doubled size is specified.
|
|
// ebiten.SetWindowSize(640, 480)
|
|
// ebiten.SetWindowTitle("Your game's title")
|
|
// // Call ebiten.RunGame to start your game loop.
|
|
// if err := ebiten.RunGame(game); err != nil {
|
|
// log.Fatal(err)
|
|
// }
|
|
// }
|
|
//
|
|
// In the API document, 'the main thread' means the goroutine in init(), main() and their callees without 'go'
|
|
// statement. It is assured that 'the main thread' runs on the OS main thread. There are some Ebitengine functions (e.g.,
|
|
// DeviceScaleFactor) that must be called on the main thread under some conditions (typically, before ebiten.RunGame
|
|
// is called).
|
|
//
|
|
// # Environment variables
|
|
//
|
|
// `EBITENGINE_SCREENSHOT_KEY` environment variable specifies the key
|
|
// to take a screenshot. For example, if you run your game with
|
|
// `EBITENGINE_SCREENSHOT_KEY=q`, you can take a game screen's screenshot
|
|
// by pressing Q key. This works only on desktops and browsers.
|
|
//
|
|
// `EBITENGINE_INTERNAL_IMAGES_KEY` environment variable specifies the key
|
|
// to dump all the internal images. This is valid only when the build tag
|
|
// 'ebitenginedebug' is specified. This works only on desktops and browsers.
|
|
//
|
|
// `EBITENGINE_GRAPHICS_LIBRARY` environment variable specifies the graphics library.
|
|
// If the specified graphics library is not available, RunGame returns an error.
|
|
// This environment variable can also be set programmatically through os.Setenv before RunGame is called.
|
|
// This can take one of the following value:
|
|
//
|
|
// "auto": Ebitengine chooses the graphics library automatically. This is the default value.
|
|
// "opengl": OpenGL, OpenGL ES, or WebGL.
|
|
// "directx": DirectX. This works only on Windows.
|
|
// "metal": Metal. This works only on macOS or iOS.
|
|
//
|
|
// `EBITENGINE_DIRECTX` environment variable specifies various parameters for DirectX.
|
|
// You can specify multiple values separated by a comma. The default value is empty (i.e. no parameters).
|
|
//
|
|
// "warp": Use WARP (i.e. software rendering).
|
|
// "debug": Use a debug layer.
|
|
//
|
|
// `EBITENGINE_OPENGL` environment variable specifies various parameters for OpenGL.
|
|
// You can specify multiple values separated by a comma. The default value is empty (i.e. no parameters).
|
|
//
|
|
// "webgl1": Use WebGL 1. This is valid only on browsers.
|
|
//
|
|
// # Build tags
|
|
//
|
|
// `ebitenginedebug` outputs a log of graphics commands. This is useful to know what happens in Ebitengine. In general, the
|
|
// number of graphics commands affects the performance of your game.
|
|
//
|
|
// `ebitenginesinglethread` disables Ebitengine's thread safety to unlock maximum performance. If you use this you will have
|
|
// to manage threads yourself. Functions like IsKeyPressed will no longer be concurrent-safe with this build tag.
|
|
// They must be called from the main thread or the same goroutine as the given game's callback functions like Update
|
|
// to RunGame.
|
|
//
|
|
// `microsoftgdk` is for Microsoft GDK (e.g. Xbox).
|
|
//
|
|
// `nintendosdk` is for NintendoSDK (e.g. Nintendo Switch).
|
|
//
|
|
// `opengles` uses OpenGL ES (2) instead of OpenGL.
|
|
package ebiten
|