src/gallium/auxiliary/util/u_staging.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2010 Luca Barbieri
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial
  15  * portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  *
  25  **************************************************************************/
  26
  27 /* Direct3D 10/11 has no concept of transfers. Applications instead
  28  * create resources with a STAGING or DYNAMIC usage, copy between them
  29  * and the real resource and use Map to map the STAGING/DYNAMIC resource.
  30  *
  31  * This util module allows to implement Gallium drivers as a Direct3D
  32  * driver would be implemented: transfers allocate a resource with
  33  * PIPE_USAGE_STAGING, and copy the data between it and the real resource
  34  * with resource_copy_region.
  35  */
  36
  37 #ifndef U_STAGING_H
  38 #define U_STAGING_H
  39
  40 #include "pipe/p_state.h"
  41
  42 struct util_staging_transfer {
  43    struct pipe_transfer base;
  44
  45    /* if direct, same as base.resource, otherwise the temporary staging resource */
  46    struct pipe_resource *staging_resource;
  47 };
  48
  49 /* user must be stride, slice_stride and offset */
  50 /* pt->usage == PIPE_USAGE_DYNAMIC || pt->usage == PIPE_USAGE_STAGING should be a good value to pass for direct */
  51 /* staging resource is currently created with PIPE_USAGE_STAGING */
  52 struct util_staging_transfer *
  53 util_staging_transfer_init(struct pipe_context *pipe,
  54            struct pipe_resource *pt,
  55            unsigned level,
  56            unsigned usage,
  57            const struct pipe_box *box,
  58            boolean direct, struct util_staging_transfer *tx);
  59
  60 void
  61 util_staging_transfer_destroy(struct pipe_context *pipe, struct pipe_transfer *ptx);
  62
  63 #endif