diff --git a/ebitenutil/file_js.go b/ebitenutil/file_js.go index 35116b8f6..3df1d3e75 100644 --- a/ebitenutil/file_js.go +++ b/ebitenutil/file_js.go @@ -28,6 +28,13 @@ func (f *file) Close() error { return nil } +// OpenFile opens a file and returns a stream for its data. +// +// The path parts should be separated with slash '/' on any environments. +// +// OpenFile doesn't work on mobiles. +// +// Deprecated: as of v2.4. Use os.Open on desktops and http.Get on browsers instead. func OpenFile(path string) (ReadSeekCloser, error) { res, err := http.Get(path) if err != nil { diff --git a/ebitenutil/file_notjs.go b/ebitenutil/file_notjs.go index 104998630..e16a51935 100644 --- a/ebitenutil/file_notjs.go +++ b/ebitenutil/file_notjs.go @@ -26,7 +26,9 @@ import ( // // The path parts should be separated with slash '/' on any environments. // -// Note that this doesn't work on mobiles. +// OpenFile doesn't work on mobiles. +// +// Deprecated: as of v2.4. Use os.Open on desktops and http.Get on browsers instead. func OpenFile(path string) (ReadSeekCloser, error) { return os.Open(filepath.FromSlash(path)) } diff --git a/ebitenutil/io.go b/ebitenutil/io.go index 9f5197123..bc5dba5da 100644 --- a/ebitenutil/io.go +++ b/ebitenutil/io.go @@ -19,6 +19,8 @@ import ( ) // ReadSeekCloser is io.ReadSeeker and io.Closer. +// +// Deprecated: as of v2.4. Use io.ReadSeekCloser instead. type ReadSeekCloser interface { io.ReadSeeker io.Closer