1 /**************************************************************************
3 * Copyright 2009 VMware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 /* Helper utility for uploading user buffers & other data, and
29 * coalescing small buffers into larger ones.
32 #ifndef U_UPLOAD_MGR_H
33 #define U_UPLOAD_MGR_H
35 #include "pipe/p_compiler.h"
42 * Create the upload manager.
44 * \param pipe Pipe driver.
45 * \param default_size Minimum size of the upload buffer, in bytes.
46 * \param alignment Alignment of each suballocation in the upload buffer.
47 * \param bind Bitmask of PIPE_BIND_* flags.
49 struct u_upload_mgr
*u_upload_create( struct pipe_context
*pipe
,
50 unsigned default_size
,
55 * Destroy the upload manager.
57 void u_upload_destroy( struct u_upload_mgr
*upload
);
62 * \param upload Upload manager
64 * This must usually be called prior to firing the command stream
65 * which references the upload buffer, as many memory managers either
66 * don't like firing a mapped buffer or cause subsequent maps of a
67 * fired buffer to wait.
69 void u_upload_unmap( struct u_upload_mgr
*upload
);
72 * Sub-allocate new memory from the upload buffer.
74 * \param upload Upload manager
75 * \param min_out_offset Minimum offset that should be returned in out_offset.
76 * \param size Size of the allocation.
77 * \param alignment Alignment of the suballocation within the buffer
78 * \param out_offset Pointer to where the new buffer offset will be returned.
79 * \param outbuf Pointer to where the upload buffer will be returned.
80 * \param ptr Pointer to the allocated memory that is returned.
82 void u_upload_alloc(struct u_upload_mgr
*upload
,
83 unsigned min_out_offset
,
87 struct pipe_resource
**outbuf
,
92 * Allocate and write data to the upload buffer.
94 * Same as u_upload_alloc, but in addition to that, it copies "data"
95 * to the pointer returned from u_upload_alloc.
97 void u_upload_data(struct u_upload_mgr
*upload
,
98 unsigned min_out_offset
,
101 unsigned *out_offset
,
102 struct pipe_resource
**outbuf
);
106 * Allocate space in an upload buffer and copy an input buffer to it.
108 * Same as u_upload_data, except that the input data comes from a buffer
109 * instead of a user pointer.
111 void u_upload_buffer(struct u_upload_mgr
*upload
,
112 unsigned min_out_offset
,
115 struct pipe_resource
*inbuf
,
116 unsigned *out_offset
,
117 struct pipe_resource
**outbuf
);