src/gallium/drivers/svga/svga_resource_texture.h

   1 /**********************************************************
   2  * Copyright 2008-2009 VMware, Inc.  All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use, copy,
   8  * modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  *
  24  **********************************************************/
  25
  26 #ifndef SVGA_TEXTURE_H
  27 #define SVGA_TEXTURE_H
  28
  29
  30 #include "pipe/p_compiler.h"
  31 #include "pipe/p_state.h"
  32 #include "util/u_inlines.h"
  33 #include "util/u_memory.h"
  34 #include "util/u_transfer.h"
  35 #include "svga_screen_cache.h"
  36
  37 struct pipe_context;
  38 struct pipe_screen;
  39 struct svga_context;
  40 struct svga_winsys_surface;
  41 enum SVGA3dSurfaceFormat;
  42
  43
  44 #define SVGA_MAX_TEXTURE_LEVELS 16
  45
  46
  47 extern struct u_resource_vtbl svga_texture_vtbl;
  48
  49
  50 struct svga_texture
  51 {
  52    struct u_resource b;
  53
  54    ushort *defined;
  55
  56    struct svga_sampler_view *cached_view;
  57
  58    unsigned view_age[SVGA_MAX_TEXTURE_LEVELS];
  59    unsigned age;
  60
  61    boolean views_modified;
  62
  63    /**
  64     * Creation key for the host surface handle.
  65     *
  66     * This structure describes all the host surface characteristics so that it
  67     * can be looked up in cache, since creating a host surface is often a slow
  68     * operation.
  69     */
  70    struct svga_host_surface_cache_key key;
  71
  72    /**
  73     * Handle for the host side surface.
  74     *
  75     * This handle is owned by this texture. Views should hold on to a reference
  76     * to this texture and never destroy this handle directly.
  77     */
  78    struct svga_winsys_surface *handle;
  79
  80    /**
  81     * Whether the host side surface is validated, either through the
  82     * InvalidateGBSurface command or after the surface is updated
  83     * or rendered to.
  84     */
  85    boolean validated;
  86
  87    /**
  88     * Whether the host side surface is imported and not created by this
  89     * driver.
  90     */
  91    boolean imported;
  92
  93    /**
  94     * Whether texture upload buffer can be used on this texture
  95     */
  96    boolean can_use_upload;
  97
  98    unsigned size;  /**< Approximate size in bytes */
  99
 100    /** array indexed by cube face or 3D/array slice, one bit per mipmap level */
 101    ushort *rendered_to;
 102
 103    /** array indexed by cube face or 3D/array slice, one bit per mipmap level.
 104     *  Set if the level is marked as dirty.
 105     */
 106    ushort *dirty;
 107
 108    /**
 109     * A cached backing host side surface to be used if this texture is being
 110     * used for rendering and sampling at the same time.
 111     * Currently we only cache one handle. If needed, we can extend this to
 112     * support multiple handles.
 113     */
 114    struct svga_host_surface_cache_key backed_key;
 115    struct svga_winsys_surface *backed_handle;
 116    unsigned backed_age;
 117 };
 118
 119
 120
 121 /* Note this is only used for texture (not buffer) transfers:
 122  */
 123 struct svga_transfer
 124 {
 125    struct pipe_transfer base;
 126
 127    unsigned slice;  /**< array slice or cube face */
 128
 129    struct svga_winsys_buffer *hwbuf;
 130
 131    /* Height of the hardware buffer in pixel blocks */
 132    unsigned hw_nblocksy;
 133
 134    /* Temporary malloc buffer when we can't allocate a hardware buffer
 135     * big enough */
 136    void *swbuf;
 137
 138    /* True if guest backed surface is supported and we can directly map
 139     * to the surface for this transfer.
 140     */
 141    boolean use_direct_map;
 142
 143    struct {
 144       struct pipe_resource *buf;  /* points to the upload buffer if this
 145                                    * transfer is done via the upload buffer
 146                                    * instead of directly mapping to the
 147                                    * resource's surface.
 148                                    */
 149       void *map;
 150       unsigned offset;
 151       SVGA3dBox box;
 152       unsigned nlayers;
 153    } upload;
 154 };
 155
 156
 157 static inline struct svga_texture *
 158 svga_texture(struct pipe_resource *resource)
 159 {
 160    struct svga_texture *tex = (struct svga_texture *)resource;
 161    assert(tex == NULL || tex->b.vtbl == &svga_texture_vtbl);
 162    return tex;
 163 }
 164
 165
 166 static inline struct svga_transfer *
 167 svga_transfer(struct pipe_transfer *transfer)
 168 {
 169    assert(transfer);
 170    return (struct svga_transfer *)transfer;
 171 }
 172
 173
 174 /**
 175  * Increment the age of a view into a texture
 176  * This is used to track updates to textures when we draw into
 177  * them via a surface.
 178  */
 179 static inline void
 180 svga_age_texture_view(struct svga_texture *tex, unsigned level)
 181 {
 182    assert(level < ARRAY_SIZE(tex->view_age));
 183    tex->view_age[level] = ++(tex->age);
 184 }
 185
 186
 187 /** For debugging, check that face and level are legal */
 188 static inline void
 189 check_face_level(const struct svga_texture *tex,
 190                  unsigned face, unsigned level)
 191 {
 192    if (tex->b.b.target == PIPE_TEXTURE_CUBE) {
 193       assert(face < 6);
 194    }
 195    else if (tex->b.b.target == PIPE_TEXTURE_3D) {
 196       assert(face < tex->b.b.depth0);
 197    }
 198    else {
 199       assert(face < tex->b.b.array_size);
 200    }
 201
 202    assert(level < 8 * sizeof(tex->rendered_to[0]));
 203 }
 204
 205
 206 /**
 207  * Mark the given texture face/level as being defined.
 208  */
 209 static inline void
 210 svga_define_texture_level(struct svga_texture *tex,
 211                           unsigned face,unsigned level)
 212 {
 213    check_face_level(tex, face, level);
 214    tex->defined[face] |= 1 << level;
 215    tex->validated = TRUE;
 216 }
 217
 218
 219 static inline bool
 220 svga_is_texture_level_defined(const struct svga_texture *tex,
 221                               unsigned face, unsigned level)
 222 {
 223    check_face_level(tex, face, level);
 224    return (tex->defined[face] & (1 << level)) != 0;
 225 }
 226
 227
 228 static inline void
 229 svga_set_texture_rendered_to(struct svga_texture *tex,
 230                              unsigned face, unsigned level)
 231 {
 232    check_face_level(tex, face, level);
 233    tex->rendered_to[face] |= 1 << level;
 234    tex->validated = TRUE;
 235 }
 236
 237
 238 static inline void
 239 svga_clear_texture_rendered_to(struct svga_texture *tex,
 240                                unsigned face, unsigned level)
 241 {
 242    check_face_level(tex, face, level);
 243    tex->rendered_to[face] &= ~(1 << level);
 244 }
 245
 246
 247 static inline boolean
 248 svga_was_texture_rendered_to(const struct svga_texture *tex,
 249                              unsigned face, unsigned level)
 250 {
 251    check_face_level(tex, face, level);
 252    return !!(tex->rendered_to[face] & (1 << level));
 253 }
 254
 255 static inline void
 256 svga_set_texture_dirty(struct svga_texture *tex,
 257                        unsigned face, unsigned level)
 258 {
 259    check_face_level(tex, face, level);
 260    tex->dirty[face] |= 1 << level;
 261 }
 262
 263 static inline void
 264 svga_clear_texture_dirty(struct svga_texture *tex)
 265 {
 266    unsigned i;
 267    for (i = 0; i < tex->b.b.depth0 * tex->b.b.array_size; i++) {
 268       tex->dirty[i] = 0;
 269    }
 270 }
 271
 272 static inline boolean
 273 svga_is_texture_dirty(const struct svga_texture *tex,
 274                       unsigned face, unsigned level)
 275 {
 276    check_face_level(tex, face, level);
 277    return !!(tex->dirty[face] & (1 << level));
 278 }
 279
 280 struct pipe_resource *
 281 svga_texture_create(struct pipe_screen *screen,
 282                     const struct pipe_resource *template);
 283
 284 struct pipe_resource *
 285 svga_texture_from_handle(struct pipe_screen * screen,
 286                         const struct pipe_resource *template,
 287                         struct winsys_handle *whandle);
 288
 289 boolean
 290 svga_texture_generate_mipmap(struct pipe_context *pipe,
 291                              struct pipe_resource *pt,
 292                              enum pipe_format format,
 293                              unsigned base_level,
 294                              unsigned last_level,
 295                              unsigned first_layer,
 296                              unsigned last_layer);
 297
 298 boolean
 299 svga_texture_transfer_map_upload_create(struct svga_context *svga);
 300
 301 void
 302 svga_texture_transfer_map_upload_destroy(struct svga_context *svga);
 303
 304 boolean
 305 svga_texture_transfer_map_can_upload(const struct svga_screen *svgascreen,
 306                                      const struct pipe_resource *pt);
 307
 308 void *
 309 svga_texture_transfer_map_upload(struct svga_context *svga,
 310                                  struct svga_transfer *st);
 311
 312 void
 313 svga_texture_transfer_unmap_upload(struct svga_context *svga,
 314                                    struct svga_transfer *st);
 315
 316 boolean
 317 svga_texture_device_format_has_alpha(struct pipe_resource *texture);
 318
 319 #endif /* SVGA_TEXTURE_H */