src/gallium/auxiliary/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  * Create an uploader with identical parameters as another one, but using
  66  * the given pipe_context instead.
  67  */
  68 struct u_upload_mgr *
  69 u_upload_clone(struct pipe_context *pipe, struct u_upload_mgr *upload);
  70
  71 /**
  72  * Destroy the upload manager.
  73  */
  74 void u_upload_destroy( struct u_upload_mgr *upload );
  75
  76 /**
  77  * Unmap upload buffer
  78  *
  79  * \param upload           Upload manager
  80  *
  81  * This must usually be called prior to firing the command stream
  82  * which references the upload buffer, as many memory managers either
  83  * don't like firing a mapped buffer or cause subsequent maps of a
  84  * fired buffer to wait.
  85  */
  86 void u_upload_unmap( struct u_upload_mgr *upload );
  87
  88 /**
  89  * Sub-allocate new memory from the upload buffer.
  90  *
  91  * \param upload           Upload manager
  92  * \param min_out_offset   Minimum offset that should be returned in out_offset.
  93  * \param size             Size of the allocation.
  94  * \param alignment        Alignment of the suballocation within the buffer
  95  * \param out_offset       Pointer to where the new buffer offset will be returned.
  96  * \param outbuf           Pointer to where the upload buffer will be returned.
  97  * \param ptr              Pointer to the allocated memory that is returned.
  98  */
  99 void u_upload_alloc(struct u_upload_mgr *upload,
 100                     unsigned min_out_offset,
 101                     unsigned size,
 102                     unsigned alignment,
 103                     unsigned *out_offset,
 104                     struct pipe_resource **outbuf,
 105                     void **ptr);
 106
 107
 108 /**
 109  * Allocate and write data to the upload buffer.
 110  *
 111  * Same as u_upload_alloc, but in addition to that, it copies "data"
 112  * to the pointer returned from u_upload_alloc.
 113  */
 114 void u_upload_data(struct u_upload_mgr *upload,
 115                    unsigned min_out_offset,
 116                    unsigned size,
 117                    unsigned alignment,
 118                    const void *data,
 119                    unsigned *out_offset,
 120                    struct pipe_resource **outbuf);
 121
 122 #ifdef __cplusplus
 123 } // extern "C" {
 124 #endif
 125
 126 #endif