From e406fcc9dd798f1496cda33cc51633b9036a2b6e Mon Sep 17 00:00:00 2001 From: David Crawshaw Date: Wed, 29 Oct 2014 09:32:18 -0400 Subject: [PATCH] go.mobile/sprite/portable: package docs LGTM=nigeltao R=nigeltao CC=golang-codereviews https://golang.org/cl/162370044 --- sprite/portable/portable.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/sprite/portable/portable.go b/sprite/portable/portable.go index 470ff4c..298f34e 100644 --- a/sprite/portable/portable.go +++ b/sprite/portable/portable.go @@ -2,7 +2,11 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// Package portable blah blah blah TODO. +// Package portable implements a sprite Engine using the image package. +// +// It is intended to serve as a reference implementation for testing +// other sprite Engines written against OpenGL, or other more exotic +// modern hardware interfaces. package portable import ( @@ -16,6 +20,7 @@ import ( "code.google.com/p/go.mobile/sprite/clock" ) +// Engine builds a sprite Engine that renders onto dst. func Engine(dst *image.RGBA) sprite.Engine { return &engine{ dst: dst,