aboutsummaryrefslogtreecommitdiff
path: root/gapii
diff options
context:
space:
mode:
authorBen Clayton <bclayton@google.com>2015-06-25 15:46:49 +0100
committerBen Clayton <bclayton@google.com>2015-06-25 15:46:49 +0100
commitcafc472cfa435a531cb13a7c64af081ccf3f4697 (patch)
treea8c6a30b19a4b161d4b180cc6416bcbca2bf594b /gapii
parent27bb8166f14ee8082a91ece0cb943cecdd7ff5c8 (diff)
downloadgpu-cafc472cfa435a531cb13a7c64af081ccf3f4697.tar.gz
Add new README.md files.
Change-Id: I25cc3b08b2615fb2664c27871f40a9d817b11850
Diffstat (limited to 'gapii')
-rw-r--r--gapii/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/gapii/README.md b/gapii/README.md
new file mode 100644
index 000000000..0fc7bafe7
--- /dev/null
+++ b/gapii/README.md
@@ -0,0 +1,25 @@
+# gapii
+--
+ import "android.googlesource.com/platform/tools/gpu/gapii"
+
+Package gapii provides functions for launching and communicating with the gapii
+tracer.
+
+## Usage
+
+#### func AdbStart
+
+```go
+func AdbStart(l log.Logger, a *adb.Action, spyport adb.Port) error
+```
+AdbStart launches an activity on an android device with the gapii tracer
+enabled. Gapii will attempt to connect back on the specified host port to write
+the trace.
+
+#### func Capture
+
+```go
+func Capture(logger log.Logger, port int, w io.Writer, stop chan struct{}) (int64, error)
+```
+Capture opens up the specified port and then waits for a capture to be
+delivered. It copies the capture into the supplied writer.