mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-09-20 05:12:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

audio: update comments

Browse Source 
Updates #2160
This commit is contained in:
Hajime Hoshi 2024-07-21 21:40:33 +09:00
parent f0ef1ecad0
commit a032a5d71c
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
audio/audio.go
View File

@ -335,6 +335,10 @@ type Player struct {
// //
// A Player doesn't close src even if src implements io.Closer. // A Player doesn't close src even if src implements io.Closer.
// Closing the source is src owner's responsibility. // Closing the source is src owner's responsibility.
//
// For new code, NewPlayerF32 is preferrable to NewPlayer, since Ebitengine will treat only 32bit float audio internally in the future.
//
// A Player for 16bit integer must be used with 16bit integer version of audio APIs, like NewInfiniteLoop, not NewInfiniteLoopF32.
func (c *Context) NewPlayer(src io.Reader) (*Player, error) { func (c *Context) NewPlayer(src io.Reader) (*Player, error) {
_, seekable := src.(io.Seeker) _, seekable := src.(io.Seeker)
f32Src := convert.NewFloat32BytesReaderFromInt16BytesReader(src) f32Src := convert.NewFloat32BytesReaderFromInt16BytesReader(src)
@ -361,11 +365,15 @@ func (c *Context) NewPlayer(src io.Reader) (*Player, error) {
// //
// Note that the given src can't be shared with other Player objects. // Note that the given src can't be shared with other Player objects.
// //
// NewPlayer tries to call Seek of src to get the current position. // NewPlayerF32 tries to call Seek of src to get the current position.
// NewPlayer returns error when the Seek returns error. // NewPlayerF32 returns error when the Seek returns error.
// //
// A Player doesn't close src even if src implements io.Closer. // A Player doesn't close src even if src implements io.Closer.
// Closing the source is src owner's responsibility. // Closing the source is src owner's responsibility.
//
// For new code, NewPlayerF32 is preferrable to NewPlayer, since Ebitengine will treat only 32bit float audio internally in the future.
//
// A Player for 32bit float must be used with 32bit float version of audio APIs, like NewInfiniteLoopF32, not NewInfiniteLoop.
func (c *Context) NewPlayerF32(src io.Reader) (*Player, error) { func (c *Context) NewPlayerF32(src io.Reader) (*Player, error) {
_, seekable := src.(io.Seeker) _, seekable := src.(io.Seeker)
pi, err := c.playerFactory.newPlayer(c, src, seekable, src, bitDepthInBytesFloat32) pi, err := c.playerFactory.newPlayer(c, src, seekable, src, bitDepthInBytesFloat32)