Signed-off-by: Frediano Ziglio <fziglio@xxxxxxxxxx>
---
docs/spice_protocol.txt | 25 ++++++++++++++++++++++++-
1 file changed, 24 insertions(+), 1 deletion(-)
diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
index 5e13c93..0ef2800 100644
--- a/docs/spice_protocol.txt
+++ b/docs/spice_protocol.txt
@@ -365,7 +365,30 @@ the attribute was attached to a `len`-sized array).
to_ptr
~~~~~~
-TODO
+This specifies that the corresponding C structure field contains a pointer to
+the data. On marshalling the pointer is used, on demarshalling the data is
+allocated in the memory block that holds the returned structure.
+The type of this field must be a structure.
+
+Example:
+
+ struct test {
+ uint16 num;
+ };
+
+ struct msg {
+ test ptr @to_ptr;
+ };
+
+Output C structure:
+
+ struct test {
+ uint16_t num;
+ };
+
+ struct msg {
+ struct test *ptr;
+ };
nocopy
~~~~~~
--
2.17.2
_______________________________________________
Spice-devel mailing list
Spice-devel@xxxxxxxxxxxxxxxxxxxxx
https://lists.freedesktop.org/mailman/listinfo/spice-devel