summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJamey Sharp <jamey@minilop.net>2010-09-17 02:11:44 +0200
committerJamey Sharp <jamey@minilop.net>2010-09-18 11:17:18 +0200
commit402942cdbc518395a2943fd226b9f3071f24d39f (patch)
tree3243b0d059eb9664f45cb3b59c44207f08a00239 /doc
parente4d4d6ddd52801cf0b0b253d9ba3bdabfa9a9d8d (diff)
Introduce per-object per-screen privates.
This replaces dixCreatePrivateKey and the only uses, which were in midispcur. Commit by Jamey Sharp and Josh Triplett. Signed-off-by: Jamey Sharp <jamey@minilop.net> Signed-off-by: Josh Triplett <josh@joshtriplett.org> Reviewed-by: Keith Packard <keithp@keithp.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/xml/Xserver-spec.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/xml/Xserver-spec.xml b/doc/xml/Xserver-spec.xml
index 563705fb9..4811a30a4 100644
--- a/doc/xml/Xserver-spec.xml
+++ b/doc/xml/Xserver-spec.xml
@@ -4854,16 +4854,16 @@ If the function is called more than once on the same key, all calls must use
the same value for <type>size</type> or the server will abort.</para>
<para>
-To request private space and have the server manage the key, use
+To request per-screen private space in an object, use
<blockquote><programlisting>
- DevPrivateKey dixCreatePrivateKey(DevPrivateType type, unsigned size);
+ Bool dixRegisterScreenPrivateKey(DevScreenPrivateKey key, ScreenPtr pScreen, DevPrivateType type, unsigned size);
</programlisting></blockquote>
The <parameter>type</parameter> and <parameter>size</parameter> arguments are
the same as those to <function>dixRegisterPrivateKey</function> but this
-function allocates a <type>DevPrivateKeyRec</type> and returns a pointer to it
-instead of requiring the caller to pass a pointer to an existing structure.
-The server will free it automatically when the privates system is restarted
-at server reset time.</para>
+function ensures the given <parameter>key</parameter> exists on objects of
+the specified type with distinct storage for the given
+<parameter>pScreen</parameter>. The key is usable on ScreenPrivate variants
+that are otherwise equivalent to the following Private functions.</para>
<para>
To attach a piece of private data to an object, use: