summaryrefslogtreecommitdiff
path: root/xgb.go
diff options
context:
space:
mode:
authorAndrew Gallant (Ocelot) <[email protected]>2012-05-12 21:36:31 -0400
committerAndrew Gallant (Ocelot) <[email protected]>2012-05-12 21:36:31 -0400
commit67f391aa9e6095a450ddb08abf0a7a6d29a6737a (patch)
tree214d9a6dbef67f9bc72f5d9e2f2258651cfb22ad /xgb.go
parentaa791314d1e318e921a78d804b5b9ab504820495 (diff)
docs
Diffstat (limited to 'xgb.go')
-rw-r--r--xgb.go7
1 files changed, 5 insertions, 2 deletions
diff --git a/xgb.go b/xgb.go
index 50cfdba..b2cf56c 100644
--- a/xgb.go
+++ b/xgb.go
@@ -166,8 +166,11 @@ type eventOrError interface{}
// NewID generates a new unused ID for use with requests like CreateWindow.
// If no new ids can be generated, the id returned is 0 and error is non-nil.
-// Note that the value returned will need to be converted to the proper
-// type. i.e., xproto.Window(id).
+// This shouldn't be used directly, and is exported for use in the extension
+// sub-packages.
+// If you need identifiers, use the appropriate constructor.
+// e.g., For a window id, use xproto.NewWindowId. For
+// a new pixmap id, use xproto.NewPixmapId. And so on.
func (c *Conn) NewId() (uint32, error) {
xid := <-c.xidChan
if xid.err != nil {