Document return types.
authorJosé Fonseca <jrfonseca@tungstengraphics.com>
Tue, 20 Nov 2007 14:27:52 +0000 (14:27 +0000)
committerJosé Fonseca <jrfonseca@tungstengraphics.com>
Sun, 9 Dec 2007 14:03:33 +0000 (14:03 +0000)
src/mesa/pipe/p_winsys.h

index f46807995d8541902f09134e3b4b7ccb87f90b7b..2aac403c20b001b0328b7e45b62324d600a77106 100644 (file)
@@ -138,20 +138,30 @@ struct pipe_winsys
     * usage is a bitmask of PIPE_BUFFER_USAGE_PIXEL/VERTEX/INDEX/CONSTANT. This
     * usage argument is only an optimization hint, not a guarantee, therefore 
     * proper behavior must be observed in all circumstances.
+    * 
+    * Returns zero on success.
     */
    int (*buffer_data)(struct pipe_winsys *sws, 
                       struct pipe_buffer_handle *buf,
                       unsigned size, const void *data,
                       unsigned usage);
 
-   /** Modify some or all of the data contained in a buffer's data store */
+   /** 
+    * Modify some or all of the data contained in a buffer's data store.
+    * 
+    * Returns zero on success.
+    */
    int (*buffer_subdata)(struct pipe_winsys *sws, 
                          struct pipe_buffer_handle *buf,
                          unsigned long offset, 
                          unsigned long size, 
                          const void *data);
 
-   /** Query some or all of the data contained in a buffer's data store */
+   /** 
+    * Query some or all of the data contained in a buffer's data store.
+    * 
+    * Returns zero on success.
+    */
    int (*buffer_get_subdata)(struct pipe_winsys *sws, 
                              struct pipe_buffer_handle *buf,
                              unsigned long offset,