util/u_upload_mgr.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  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.
  25  *
  26  **************************************************************************/
  27
  28 /* Helper utility for uploading user buffers & other data, and
  29  * coalescing small buffers into larger ones.
  30  */
  31
  32 #ifndef U_UPLOAD_MGR_H
  33 #define U_UPLOAD_MGR_H
  34
  35 #include "pipe/p_compiler.h"
  36 #include "pipe/p_defines.h"
  37
  38 struct pipe_context;
  39 struct pipe_resource;
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /**
  46  * Create the upload manager.
  47  *
  48  * \param pipe          Pipe driver.
  49  * \param default_size  Minimum size of the upload buffer, in bytes.
  50  * \param bind          Bitmask of PIPE_BIND_* flags.
  51  * \param usage         PIPE_USAGE_*
  52  */
  53 struct u_upload_mgr *
  54 u_upload_create(struct pipe_context *pipe, unsigned default_size,
  55                 unsigned bind, enum pipe_resource_usage usage);
  56
  57 /**
  58  * Create the default uploader for pipe_context. Only pipe_context::screen
  59  * needs to be set for this to succeed.
  60  */
  61 struct u_upload_mgr *
  62 u_upload_create_default(struct pipe_context *pipe);
  63
  64 /**
  65  * Destroy the upload manager.
  66  */
  67 void u_upload_destroy( struct u_upload_mgr *upload );
  68
  69 /**
  70  * Unmap upload buffer
  71  *
  72  * \param upload           Upload manager
  73  *
  74  * This must usually be called prior to firing the command stream
  75  * which references the upload buffer, as many memory managers either
  76  * don't like firing a mapped buffer or cause subsequent maps of a
  77  * fired buffer to wait.
  78  */
  79 void u_upload_unmap( struct u_upload_mgr *upload );
  80
  81 /**
  82  * Sub-allocate new memory from the upload buffer.
  83  *
  84  * \param upload           Upload manager
  85  * \param min_out_offset   Minimum offset that should be returned in out_offset.
  86  * \param size             Size of the allocation.
  87  * \param alignment        Alignment of the suballocation within the buffer
  88  * \param out_offset       Pointer to where the new buffer offset will be returned.
  89  * \param outbuf           Pointer to where the upload buffer will be returned.
  90  * \param ptr              Pointer to the allocated memory that is returned.
  91  */
  92 void u_upload_alloc(struct u_upload_mgr *upload,
  93                     unsigned min_out_offset,
  94                     unsigned size,
  95                     unsigned alignment,
  96                     unsigned *out_offset,
  97                     struct pipe_resource **outbuf,
  98                     void **ptr);
  99
 100
 101 /**
 102  * Allocate and write data to the upload buffer.
 103  *
 104  * Same as u_upload_alloc, but in addition to that, it copies "data"
 105  * to the pointer returned from u_upload_alloc.
 106  */
 107 void u_upload_data(struct u_upload_mgr *upload,
 108                    unsigned min_out_offset,
 109                    unsigned size,
 110                    unsigned alignment,
 111                    const void *data,
 112                    unsigned *out_offset,
 113                    struct pipe_resource **outbuf);
 114
 115 #ifdef __cplusplus
 116 } // extern "C" {
 117 #endif
 118
 119 #endif