ebiten

package

v0.0.0-...-7f92c57 Latest Latest Go to latest Published: Oct 21, 2021 License: GPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package ebiten contains ebiten's implementation of the audio interface

This section is empty.

This section is empty.

This section is empty.

type AudioProvider struct {
	*d2util.Logger
	// contains filtered or unexported fields
}

AudioProvider represents a provider capable of playing audio

func CreateAudio(l d2util.LogLevel, am *d2asset.AssetManager) *AudioProvider

CreateAudio creates an instance of ebiten's audio provider

func (eap *AudioProvider) LoadSound(sfx string, loop, bgm bool) (d2interface.SoundEffect, error)

LoadSound loads a sound affect so that it canb e played

func (eap *AudioProvider) PlayBGM(song string)

PlayBGM loads an audio stream and plays it in the background

func (eap *AudioProvider) SetVolumes(bgmVolume, sfxVolume float64)

SetVolumes sets the volumes of the audio provider

type SoundEffect struct {
	// contains filtered or unexported fields
}

SoundEffect represents an ebiten implementation of a sound effect

func (v *SoundEffect) IsPlaying() bool

IsPlaying returns a bool for whether or not the sound is currently playing

func (v *SoundEffect) Play()

Play plays the sound effect

func (v *SoundEffect) SetPan(pan float64)

SetPan sets the audio pan, left is -1.0, center is 0.0, right is 1.0

func (v *SoundEffect) SetVolume(volume float64)

SetVolume ets the volume

func (v *SoundEffect) Stop()

Stop stops the sound effect