summaryrefslogtreecommitdiffstats
path: root/shiny/driver/driver.go
diff options
context:
space:
mode:
Diffstat (limited to 'shiny/driver/driver.go')
-rw-r--r--shiny/driver/driver.go25
1 files changed, 25 insertions, 0 deletions
diff --git a/shiny/driver/driver.go b/shiny/driver/driver.go
new file mode 100644
index 0000000..cf2b68c
--- /dev/null
+++ b/shiny/driver/driver.go
@@ -0,0 +1,25 @@
+// Copyright 2015 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package driver provides the default driver for accessing a screen.
+package driver // import "golang.org/x/exp/shiny/driver"
+
+// TODO: figure out what to say about the responsibility for users of this
+// package to check any implicit dependencies' LICENSEs. For example, the
+// driver might use third party software outside of golang.org/x, like an X11
+// or OpenGL library.
+
+import (
+ "golang.org/x/exp/shiny/screen"
+)
+
+// Main is called by the program's main function to run the graphical
+// application.
+//
+// It calls f on the Screen, possibly in a separate goroutine, as some OS-
+// specific libraries require being on 'the main thread'. It returns when f
+// returns.
+func Main(f func(screen.Screen)) {
+ main(f)
+}