util: update and fix u_upload_mgr.h comments
authorBrian Paul <brianp@vmware.com>
Fri, 17 Aug 2012 21:20:07 +0000 (15:20 -0600)
committerBrian Paul <brianp@vmware.com>
Sat, 18 Aug 2012 13:39:52 +0000 (07:39 -0600)
src/gallium/auxiliary/util/u_upload_mgr.h

index b50d3f32c93bdb0067dd8590298710ceb164dcec..82215a5560dee6e5a07792c6383cfa801d193926 100644 (file)
@@ -56,14 +56,14 @@ struct u_upload_mgr *u_upload_create( struct pipe_context *pipe,
  */
 void u_upload_destroy( struct u_upload_mgr *upload );
 
-/* Unmap and release old upload buffer.
+/**
+ * Unmap and release old upload buffer.
  * 
  * This is like u_upload_unmap() except the upload buffer is released for
  * recycling. This should be called on real hardware flushes on systems
  * that don't support the PIPE_TRANSFER_UNSYNCHRONIZED flag, as otherwise
  * the next u_upload_buffer will cause a sync on the buffer.
  */
-
 void u_upload_flush( struct u_upload_mgr *upload );
 
 /**
@@ -86,7 +86,6 @@ void u_upload_unmap( struct u_upload_mgr *upload );
  * \param size             Size of the allocation.
  * \param out_offset       Pointer to where the new buffer offset will be returned.
  * \param outbuf           Pointer to where the upload buffer will be returned.
- * \param flushed          Whether the upload buffer was flushed.
  * \param ptr              Pointer to the allocated memory that is returned.
  */
 enum pipe_error u_upload_alloc( struct u_upload_mgr *upload,
@@ -112,7 +111,7 @@ enum pipe_error u_upload_data( struct u_upload_mgr *upload,
 
 
 /**
- * Allocate and copy an input buffer to the upload buffer.
+ * Allocate space in an upload buffer and copy an input buffer to it.
  *
  * Same as u_upload_data, except that the input data comes from a buffer
  * instead of a user pointer.