src/gallium/auxiliary/util/u_blitter.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 Marek Olšák <maraeo@gmail.com>
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * 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, sub license, 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 portions
  15  * of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  20  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  21  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  *
  25  **************************************************************************/
  26
  27 #ifndef U_BLITTER_H
  28 #define U_BLITTER_H
  29
  30 #include "util/u_memory.h"
  31
  32 #include "pipe/p_state.h"
  33
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct pipe_context;
  40
  41 struct blitter_context
  42 {
  43    /* Private members, really. */
  44    void *saved_blend_state;   /**< blend state */
  45    void *saved_dsa_state;     /**< depth stencil alpha state */
  46    void *saved_velem_state;   /**< vertex elements state */
  47    void *saved_rs_state;      /**< rasterizer state */
  48    void *saved_fs, *saved_vs; /**< fragment shader, vertex shader */
  49
  50    struct pipe_framebuffer_state saved_fb_state;  /**< framebuffer state */
  51    struct pipe_stencil_ref saved_stencil_ref;     /**< stencil ref */
  52    struct pipe_viewport_state saved_viewport;
  53    struct pipe_clip_state saved_clip;
  54
  55    int saved_num_sampler_states;
  56    void *saved_sampler_states[PIPE_MAX_SAMPLERS];
  57
  58    int saved_num_sampler_views;
  59    struct pipe_sampler_view *saved_sampler_views[PIPE_MAX_SAMPLERS];
  60
  61    int saved_num_vertex_buffers;
  62    struct pipe_vertex_buffer saved_vertex_buffers[PIPE_MAX_ATTRIBS];
  63 };
  64
  65 /**
  66  * Create a blitter context.
  67  */
  68 struct blitter_context *util_blitter_create(struct pipe_context *pipe);
  69
  70 /**
  71  * Destroy a blitter context.
  72  */
  73 void util_blitter_destroy(struct blitter_context *blitter);
  74
  75 /*
  76  * These CSOs must be saved before any of the following functions is called:
  77  * - blend state
  78  * - depth stencil alpha state
  79  * - rasterizer state
  80  * - vertex shader
  81  * - fragment shader
  82  */
  83
  84 /**
  85  * Clear a specified set of currently bound buffers to specified values.
  86  */
  87 void util_blitter_clear(struct blitter_context *blitter,
  88                         unsigned width, unsigned height,
  89                         unsigned num_cbufs,
  90                         unsigned clear_buffers,
  91                         const float *rgba,
  92                         double depth, unsigned stencil);
  93
  94 /**
  95  * Copy a block of pixels from one surface to another.
  96  *
  97  * You can copy from any color format to any other color format provided
  98  * the former can be sampled and the latter can be rendered to. Otherwise,
  99  * a software fallback path is taken and both surfaces must be of the same
 100  * format.
 101  *
 102  * The same holds for depth-stencil formats with the exception that stencil
 103  * cannot be copied unless you set ignore_stencil to FALSE. In that case,
 104  * a software fallback path is taken and both surfaces must be of the same
 105  * format.
 106  *
 107  * Use pipe_screen->is_format_supported to know your options.
 108  *
 109  * These states must be saved in the blitter in addition to the state objects
 110  * already required to be saved:
 111  * - framebuffer state
 112  * - fragment sampler states
 113  * - fragment sampler textures
 114  */
 115 void util_blitter_copy(struct blitter_context *blitter,
 116                        struct pipe_surface *dst,
 117                        unsigned dstx, unsigned dsty,
 118                        struct pipe_surface *src,
 119                        unsigned srcx, unsigned srcy,
 120                        unsigned width, unsigned height,
 121                        boolean ignore_stencil);
 122
 123 /**
 124  * Fill a region of a surface with a constant value.
 125  *
 126  * If the surface cannot be rendered to or it's a depth-stencil format,
 127  * a software fallback path is taken.
 128  *
 129  * These states must be saved in the blitter in addition to the state objects
 130  * already required to be saved:
 131  * - framebuffer state
 132  */
 133 void util_blitter_fill(struct blitter_context *blitter,
 134                        struct pipe_surface *dst,
 135                        unsigned dstx, unsigned dsty,
 136                        unsigned width, unsigned height,
 137                        unsigned value);
 138
 139 /**
 140  * Copy all pixels from one surface to another.
 141  *
 142  * The rules are the same as in util_blitter_copy with the addition that
 143  * surfaces must have the same size.
 144  */
 145 static INLINE
 146 void util_blitter_copy_surface(struct blitter_context *blitter,
 147                                struct pipe_surface *dst,
 148                                struct pipe_surface *src,
 149                                boolean ignore_stencil)
 150 {
 151    assert(dst->width == src->width && dst->height == src->height);
 152
 153    util_blitter_copy(blitter, dst, 0, 0, src, 0, 0, src->width, src->height,
 154                      ignore_stencil);
 155 }
 156
 157
 158 /* The functions below should be used to save currently bound constant state
 159  * objects inside a driver. The objects are automatically restored at the end
 160  * of the util_blitter_{clear, fill, copy, copy_surface} functions and then
 161  * forgotten.
 162  *
 163  * CSOs not listed here are not affected by util_blitter. */
 164
 165 static INLINE
 166 void util_blitter_save_blend(struct blitter_context *blitter,
 167                              void *state)
 168 {
 169    blitter->saved_blend_state = state;
 170 }
 171
 172 static INLINE
 173 void util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter,
 174                                            void *state)
 175 {
 176    blitter->saved_dsa_state = state;
 177 }
 178
 179 static INLINE
 180 void util_blitter_save_vertex_elements(struct blitter_context *blitter,
 181                                        void *state)
 182 {
 183    blitter->saved_velem_state = state;
 184 }
 185
 186 static INLINE
 187 void util_blitter_save_stencil_ref(struct blitter_context *blitter,
 188                                    const struct pipe_stencil_ref *state)
 189 {
 190    blitter->saved_stencil_ref = *state;
 191 }
 192
 193 static INLINE
 194 void util_blitter_save_rasterizer(struct blitter_context *blitter,
 195                                   void *state)
 196 {
 197    blitter->saved_rs_state = state;
 198 }
 199
 200 static INLINE
 201 void util_blitter_save_fragment_shader(struct blitter_context *blitter,
 202                                        void *fs)
 203 {
 204    blitter->saved_fs = fs;
 205 }
 206
 207 static INLINE
 208 void util_blitter_save_vertex_shader(struct blitter_context *blitter,
 209                                      void *vs)
 210 {
 211    blitter->saved_vs = vs;
 212 }
 213
 214 static INLINE
 215 void util_blitter_save_framebuffer(struct blitter_context *blitter,
 216                                    struct pipe_framebuffer_state *state)
 217 {
 218    blitter->saved_fb_state = *state;
 219 }
 220
 221 static INLINE
 222 void util_blitter_save_viewport(struct blitter_context *blitter,
 223                                 struct pipe_viewport_state *state)
 224 {
 225    blitter->saved_viewport = *state;
 226 }
 227
 228 static INLINE
 229 void util_blitter_save_clip(struct blitter_context *blitter,
 230                             struct pipe_clip_state *state)
 231 {
 232    blitter->saved_clip = *state;
 233 }
 234
 235 static INLINE
 236 void util_blitter_save_fragment_sampler_states(
 237                   struct blitter_context *blitter,
 238                   int num_sampler_states,
 239                   void **sampler_states)
 240 {
 241    assert(num_sampler_states <= Elements(blitter->saved_sampler_states));
 242
 243    blitter->saved_num_sampler_states = num_sampler_states;
 244    memcpy(blitter->saved_sampler_states, sampler_states,
 245           num_sampler_states * sizeof(void *));
 246 }
 247
 248 static INLINE void
 249 util_blitter_save_fragment_sampler_views(struct blitter_context *blitter,
 250                                          int num_views,
 251                                          struct pipe_sampler_view **views)
 252 {
 253    assert(num_views <= Elements(blitter->saved_sampler_views));
 254
 255    blitter->saved_num_sampler_views = num_views;
 256    memcpy(blitter->saved_sampler_views,
 257           views,
 258           num_views * sizeof(struct pipe_sampler_view *));
 259 }
 260
 261 static INLINE void
 262 util_blitter_save_vertex_buffers(struct blitter_context *blitter,
 263                                          int num_vertex_buffers,
 264                                          struct pipe_vertex_buffer *vertex_buffers)
 265 {
 266    assert(num_vertex_buffers <= Elements(blitter->saved_vertex_buffers));
 267
 268    blitter->saved_num_vertex_buffers = num_vertex_buffers;
 269    memcpy(blitter->saved_vertex_buffers,
 270           vertex_buffers,
 271           num_vertex_buffers * sizeof(struct pipe_vertex_buffer));
 272 }
 273
 274 #ifdef __cplusplus
 275 }
 276 #endif
 277
 278 #endif