internal/graphicsdriver/opengl: replace Get with NewGraphics (#2146)

This is a prepartion to return an error when a graphics driver, especially
DirectX, fails to initialize.

Updates #2142

internal/graphicsdriver/opengl/graphics.go

@@ -23,13 +23,15 @@ import (
 	"github.com/hajimehoshi/ebiten/v2/internal/shaderir"
 )
 
-var theGraphics Graphics
+// NewGraphics creates an implementation of graphicsdriver.Graphcis for OpenGL.
-
+// The returned graphics value is nil iff the error is not nil.
-func Get() *Graphics {
+func NewGraphics() (graphicsdriver.Graphics, error) {
 	if microsoftgdk.IsXbox() {
-		return nil
+		return nil, fmt.Errorf("opengl: OpenGL is not supported on Xbox")
 	}
-	return &theGraphics
+	g := &Graphics{}
+	g.init()
+	return g, nil
 }
 
 type activatedTexture struct {

internal/graphicsdriver/opengl/graphics_mobile.go

@@ -23,8 +23,8 @@ import (
 	"github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/opengl/gles"
 )
 
-func init() {
+func (g *Graphics) init() {
-	theGraphics.context.ctx = gles.DefaultContext{}
+	g.context.ctx = gles.DefaultContext{}
 }
 
 func (g *Graphics) SetGomobileGLContext(context gl.Context) {

internal/graphicsdriver/opengl/graphics_notmobile.go

@@ -0,0 +1,22 @@
+// Copyright 2022 The Ebitengine Authors
+//
+// 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.
+
+//go:build !android && !ios
+// +build !android,!ios
+
+package opengl
+
+func (g *Graphics) init() {
+	// Do nothing.
+}

internal/ui/graphics.go

@@ -22,8 +22,8 @@ import (
 )
 
 type graphicsDriverGetter interface {
-	getAuto() graphicsdriver.Graphics
+	newAuto() (graphicsdriver.Graphics, error)
-	getOpenGL() graphicsdriver.Graphics
+	newOpenGL() (graphicsdriver.Graphics, error)
 	getDirectX() graphicsdriver.Graphics
 	getMetal() graphicsdriver.Graphics
 }
@@ -33,15 +33,23 @@ func chooseGraphicsDriver(getter graphicsDriverGetter) (graphicsdriver.Graphics,
 
 	switch env := os.Getenv(envName); env {
 	case "", "auto":
-		if g := getter.getAuto(); g != nil {
+		g, err := getter.newAuto()
-			return g, nil
+		if err != nil {
+			return nil, err
 		}
-		return nil, fmt.Errorf("ui: no graphics library is available")
+		if g == nil {
+			return nil, fmt.Errorf("ui: no graphics library is available")
+		}
+		return g, nil
 	case "opengl":
-		if g := getter.getOpenGL(); g != nil {
+		g, err := getter.newOpenGL()
-			return g, nil
+		if err != nil {
+			return nil, err
 		}
-		return nil, fmt.Errorf("ui: %s=%s is specified but OpenGL is not available", envName, env)
+		if g == nil {
+			return nil, fmt.Errorf("ui: %s=%s is specified but OpenGL is not available", envName, env)
+		}
+		return g, nil
 	case "directx":
 		if g := getter.getDirectX(); g != nil {
 			return g, nil

internal/ui/ui_android.go

@@ -23,15 +23,12 @@ type graphicsDriverGetterImpl struct {
 	gomobileBuild bool
 }
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_cbackend.go

@@ -27,15 +27,12 @@ import (
 
 type graphicsDriverGetterImpl struct{}
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_glfw_darwin.go

@@ -258,18 +258,15 @@ type graphicsDriverGetterImpl struct {
 	transparent bool
 }
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
 	if m := g.getMetal(); m != nil {
-		return m
+		return m, nil
 	}
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_glfw_unix.go

@@ -35,15 +35,12 @@ type graphicsDriverGetterImpl struct {
 	transparent bool
 }
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_glfw_windows.go

@@ -35,18 +35,15 @@ type graphicsDriverGetterImpl struct {
 	transparent bool
 }
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
 	if d := g.getDirectX(); d != nil {
-		return d
+		return d, nil
 	}
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (g *graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_ios.go

@@ -27,18 +27,15 @@ type graphicsDriverGetterImpl struct {
 	gomobileBuild bool
 }
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
 	if m := g.getMetal(); m != nil {
-		return m
+		return m, nil
 	}
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {

internal/ui/ui_js.go

@@ -27,15 +27,12 @@ import (
 
 type graphicsDriverGetterImpl struct{}
 
-func (g *graphicsDriverGetterImpl) getAuto() graphicsdriver.Graphics {
+func (g *graphicsDriverGetterImpl) newAuto() (graphicsdriver.Graphics, error) {
-	return g.getOpenGL()
+	return g.newOpenGL()
 }
 
-func (*graphicsDriverGetterImpl) getOpenGL() graphicsdriver.Graphics {
+func (*graphicsDriverGetterImpl) newOpenGL() (graphicsdriver.Graphics, error) {
-	if g := opengl.Get(); g != nil {
+	return opengl.NewGraphics()
-		return g
-	}
-	return nil
 }
 
 func (*graphicsDriverGetterImpl) getDirectX() graphicsdriver.Graphics {