src/gallium/drivers/softpipe/sp_tile_cache.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 #ifndef SP_TILE_CACHE_H
  29 #define SP_TILE_CACHE_H
  30
  31
  32 #include "pipe/p_compiler.h"
  33 #include "sp_texture.h"
  34
  35
  36 struct softpipe_tile_cache;
  37
  38
  39 /**
  40  * Cache tile size (width and height). This needs to be a power of two.
  41  */
  42 #define TILE_SIZE_LOG2 6
  43 #define TILE_SIZE (1 << TILE_SIZE_LOG2)
  44
  45
  46 #define TILE_ADDR_BITS (SP_MAX_TEXTURE_2D_LEVELS - 1 - TILE_SIZE_LOG2)
  47
  48
  49 /**
  50  * Surface tile address as a union for fast compares.
  51  */
  52 union tile_address {
  53    struct {
  54       unsigned x:TILE_ADDR_BITS;     /* 16K / TILE_SIZE */
  55       unsigned y:TILE_ADDR_BITS;     /* 16K / TILE_SIZE */
  56       unsigned invalid:1;
  57       unsigned pad:15;
  58    } bits;
  59    unsigned value;
  60 };
  61
  62
  63 struct softpipe_cached_tile
  64 {
  65    union {
  66       float color[TILE_SIZE][TILE_SIZE][4];
  67       uint color32[TILE_SIZE][TILE_SIZE];
  68       uint depth32[TILE_SIZE][TILE_SIZE];
  69       ushort depth16[TILE_SIZE][TILE_SIZE];
  70       ubyte stencil8[TILE_SIZE][TILE_SIZE];
  71       uint colorui128[TILE_SIZE][TILE_SIZE][4];
  72       int colori128[TILE_SIZE][TILE_SIZE][4];
  73       ubyte any[1];
  74    } data;
  75 };
  76
  77 #define NUM_ENTRIES 50
  78
  79
  80 struct softpipe_tile_cache
  81 {
  82    struct pipe_context *pipe;
  83    struct pipe_surface *surface;  /**< the surface we're caching */
  84    struct pipe_transfer *transfer;
  85    void *transfer_map;
  86
  87    union tile_address tile_addrs[NUM_ENTRIES];
  88    struct softpipe_cached_tile *entries[NUM_ENTRIES];
  89    uint clear_flags[(MAX_WIDTH / TILE_SIZE) * (MAX_HEIGHT / TILE_SIZE) / 32];
  90    union pipe_color_union clear_color; /**< for color bufs */
  91    uint clear_val;        /**< for z+stencil */
  92    boolean depth_stencil; /**< Is the surface a depth/stencil format? */
  93
  94    struct softpipe_cached_tile *tile;  /**< scratch tile for clears */
  95
  96    union tile_address last_tile_addr;
  97    struct softpipe_cached_tile *last_tile;  /**< most recently retrieved tile */
  98 };
  99
 100
 101 extern struct softpipe_tile_cache *
 102 sp_create_tile_cache( struct pipe_context *pipe );
 103
 104 extern void
 105 sp_destroy_tile_cache(struct softpipe_tile_cache *tc);
 106
 107 extern void
 108 sp_tile_cache_set_surface(struct softpipe_tile_cache *tc,
 109                           struct pipe_surface *sps);
 110
 111 extern struct pipe_surface *
 112 sp_tile_cache_get_surface(struct softpipe_tile_cache *tc);
 113
 114 extern void
 115 sp_tile_cache_map_transfers(struct softpipe_tile_cache *tc);
 116
 117 extern void
 118 sp_tile_cache_unmap_transfers(struct softpipe_tile_cache *tc);
 119
 120 extern void
 121 sp_flush_tile_cache(struct softpipe_tile_cache *tc);
 122
 123 extern void
 124 sp_tile_cache_clear(struct softpipe_tile_cache *tc,
 125                     const union pipe_color_union *color,
 126                     uint clearValue);
 127
 128 extern struct softpipe_cached_tile *
 129 sp_find_cached_tile(struct softpipe_tile_cache *tc,
 130                     union tile_address addr );
 131
 132
 133 static INLINE union tile_address
 134 tile_address( unsigned x,
 135               unsigned y )
 136 {
 137    union tile_address addr;
 138
 139    addr.value = 0;
 140    addr.bits.x = x / TILE_SIZE;
 141    addr.bits.y = y / TILE_SIZE;
 142
 143    return addr;
 144 }
 145
 146 /* Quickly retrieve tile if it matches last lookup.
 147  */
 148 static INLINE struct softpipe_cached_tile *
 149 sp_get_cached_tile(struct softpipe_tile_cache *tc,
 150                    int x, int y )
 151 {
 152    union tile_address addr = tile_address( x, y );
 153
 154    if (tc->last_tile_addr.value == addr.value)
 155       return tc->last_tile;
 156
 157    return sp_find_cached_tile( tc, addr );
 158 }
 159
 160
 161
 162
 163 #endif /* SP_TILE_CACHE_H */
 164