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_framebuffer.h"
  31 #include "util/u_inlines.h"
  32 #include "util/u_memory.h"
  33
  34 #include "pipe/p_state.h"
  35
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct pipe_context;
  42
  43 enum blitter_attrib_type {
  44    UTIL_BLITTER_ATTRIB_NONE,
  45    UTIL_BLITTER_ATTRIB_COLOR,
  46    UTIL_BLITTER_ATTRIB_TEXCOORD
  47 };
  48
  49 struct blitter_context
  50 {
  51    /**
  52     * Draw a rectangle.
  53     *
  54     * \param x1      An X coordinate of the top-left corner.
  55     * \param y1      A Y coordinate of the top-left corner.
  56     * \param x2      An X coordinate of the bottom-right corner.
  57     * \param y2      A Y coordinate of the bottom-right corner.
  58     * \param depth   A depth which the rectangle is rendered at.
  59     *
  60     * \param type   Semantics of the attributes "attrib".
  61     *               If type is UTIL_BLITTER_ATTRIB_NONE, ignore them.
  62     *               If type is UTIL_BLITTER_ATTRIB_COLOR, the attributes
  63     *               make up a constant RGBA color, and should go
  64     *               to the GENERIC0 varying slot of a fragment shader.
  65     *               If type is UTIL_BLITTER_ATTRIB_TEXCOORD, {a1, a2} and
  66     *               {a3, a4} specify top-left and bottom-right texture
  67     *               coordinates of the rectangle, respectively, and should go
  68     *               to the GENERIC0 varying slot of a fragment shader.
  69     *
  70     * \param attrib See type.
  71     *
  72     * \note A driver may optionally override this callback to implement
  73     *       a specialized hardware path for drawing a rectangle, e.g. using
  74     *       a rectangular point sprite.
  75     */
  76    void (*draw_rectangle)(struct blitter_context *blitter,
  77                           unsigned x1, unsigned y1, unsigned x2, unsigned y2,
  78                           float depth,
  79                           enum blitter_attrib_type type,
  80                           const float attrib[4]);
  81
  82    /* Whether the blitter is running. */
  83    boolean running;
  84
  85    /* Private members, really. */
  86    struct pipe_context *pipe; /**< pipe context */
  87
  88    void *saved_blend_state;   /**< blend state */
  89    void *saved_dsa_state;     /**< depth stencil alpha state */
  90    void *saved_velem_state;   /**< vertex elements state */
  91    void *saved_rs_state;      /**< rasterizer state */
  92    void *saved_fs, *saved_vs; /**< fragment shader, vertex shader */
  93
  94    struct pipe_framebuffer_state saved_fb_state;  /**< framebuffer state */
  95    struct pipe_stencil_ref saved_stencil_ref;     /**< stencil ref */
  96    struct pipe_viewport_state saved_viewport;
  97    struct pipe_clip_state saved_clip;
  98
  99    int saved_num_sampler_states;
 100    void *saved_sampler_states[PIPE_MAX_SAMPLERS];
 101
 102    int saved_num_sampler_views;
 103    struct pipe_sampler_view *saved_sampler_views[PIPE_MAX_SAMPLERS];
 104
 105    int saved_num_vertex_buffers;
 106    struct pipe_vertex_buffer saved_vertex_buffers[PIPE_MAX_ATTRIBS];
 107 };
 108
 109 /**
 110  * Create a blitter context.
 111  */
 112 struct blitter_context *util_blitter_create(struct pipe_context *pipe);
 113
 114 /**
 115  * Destroy a blitter context.
 116  */
 117 void util_blitter_destroy(struct blitter_context *blitter);
 118
 119 /**
 120  * Return the pipe context associated with a blitter context.
 121  */
 122 static INLINE
 123 struct pipe_context *util_blitter_get_pipe(struct blitter_context *blitter)
 124 {
 125    return blitter->pipe;
 126 }
 127
 128 /*
 129  * These CSOs must be saved before any of the following functions is called:
 130  * - blend state
 131  * - depth stencil alpha state
 132  * - rasterizer state
 133  * - vertex shader
 134  * - fragment shader
 135  */
 136
 137 /**
 138  * Clear a specified set of currently bound buffers to specified values.
 139  */
 140 void util_blitter_clear(struct blitter_context *blitter,
 141                         unsigned width, unsigned height,
 142                         unsigned num_cbufs,
 143                         unsigned clear_buffers,
 144                         const float *rgba,
 145                         double depth, unsigned stencil);
 146
 147 void util_blitter_clear_depth_custom(struct blitter_context *blitter,
 148                                      unsigned width, unsigned height,
 149                                      double depth, void *custom_dsa);
 150
 151 /**
 152  * Copy a block of pixels from one surface to another.
 153  *
 154  * You can copy from any color format to any other color format provided
 155  * the former can be sampled and the latter can be rendered to. Otherwise,
 156  * a software fallback path is taken and both surfaces must be of the same
 157  * format.
 158  *
 159  * The same holds for depth-stencil formats with the exception that stencil
 160  * cannot be copied unless you set ignore_stencil to FALSE. In that case,
 161  * a software fallback path is taken and both surfaces must be of the same
 162  * format.
 163  *
 164  * Use pipe_screen->is_format_supported to know your options.
 165  *
 166  * These states must be saved in the blitter in addition to the state objects
 167  * already required to be saved:
 168  * - framebuffer state
 169  * - fragment sampler states
 170  * - fragment sampler textures
 171  */
 172 void util_blitter_copy_region(struct blitter_context *blitter,
 173                               struct pipe_resource *dst,
 174                               unsigned dstlevel,
 175                               unsigned dstx, unsigned dsty, unsigned dstz,
 176                               struct pipe_resource *src,
 177                               unsigned srclevel,
 178                               const struct pipe_box *srcbox,
 179                               boolean ignore_stencil);
 180
 181 /**
 182  * Clear a region of a (color) surface to a constant value.
 183  *
 184  * These states must be saved in the blitter in addition to the state objects
 185  * already required to be saved:
 186  * - framebuffer state
 187  */
 188 void util_blitter_clear_render_target(struct blitter_context *blitter,
 189                                       struct pipe_surface *dst,
 190                                       const float *rgba,
 191                                       unsigned dstx, unsigned dsty,
 192                                       unsigned width, unsigned height);
 193
 194 /**
 195  * Clear a region of a depth-stencil surface, both stencil and depth
 196  * or only one of them if this is a combined depth-stencil surface.
 197  *
 198  * These states must be saved in the blitter in addition to the state objects
 199  * already required to be saved:
 200  * - framebuffer state
 201  */
 202 void util_blitter_clear_depth_stencil(struct blitter_context *blitter,
 203                                       struct pipe_surface *dst,
 204                                       unsigned clear_flags,
 205                                       double depth,
 206                                       unsigned stencil,
 207                                       unsigned dstx, unsigned dsty,
 208                                       unsigned width, unsigned height);
 209
 210 void util_blitter_custom_depth_stencil(struct blitter_context *blitter,
 211                                        struct pipe_surface *zsurf,
 212                                        struct pipe_surface *cbsurf,
 213                                        void *dsa_stage, float depth);
 214
 215 /* The functions below should be used to save currently bound constant state
 216  * objects inside a driver. The objects are automatically restored at the end
 217  * of the util_blitter_{clear, copy_region, fill_region} functions and then
 218  * forgotten.
 219  *
 220  * CSOs not listed here are not affected by util_blitter. */
 221
 222 static INLINE
 223 void util_blitter_save_blend(struct blitter_context *blitter,
 224                              void *state)
 225 {
 226    blitter->saved_blend_state = state;
 227 }
 228
 229 static INLINE
 230 void util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter,
 231                                            void *state)
 232 {
 233    blitter->saved_dsa_state = state;
 234 }
 235
 236 static INLINE
 237 void util_blitter_save_vertex_elements(struct blitter_context *blitter,
 238                                        void *state)
 239 {
 240    blitter->saved_velem_state = state;
 241 }
 242
 243 static INLINE
 244 void util_blitter_save_stencil_ref(struct blitter_context *blitter,
 245                                    const struct pipe_stencil_ref *state)
 246 {
 247    blitter->saved_stencil_ref = *state;
 248 }
 249
 250 static INLINE
 251 void util_blitter_save_rasterizer(struct blitter_context *blitter,
 252                                   void *state)
 253 {
 254    blitter->saved_rs_state = state;
 255 }
 256
 257 static INLINE
 258 void util_blitter_save_fragment_shader(struct blitter_context *blitter,
 259                                        void *fs)
 260 {
 261    blitter->saved_fs = fs;
 262 }
 263
 264 static INLINE
 265 void util_blitter_save_vertex_shader(struct blitter_context *blitter,
 266                                      void *vs)
 267 {
 268    blitter->saved_vs = vs;
 269 }
 270
 271 static INLINE
 272 void util_blitter_save_framebuffer(struct blitter_context *blitter,
 273                                    const struct pipe_framebuffer_state *state)
 274 {
 275    blitter->saved_fb_state.nr_cbufs = 0; /* It's ~0 now, meaning it's unsaved. */
 276    util_copy_framebuffer_state(&blitter->saved_fb_state, state);
 277 }
 278
 279 static INLINE
 280 void util_blitter_save_viewport(struct blitter_context *blitter,
 281                                 struct pipe_viewport_state *state)
 282 {
 283    blitter->saved_viewport = *state;
 284 }
 285
 286 static INLINE
 287 void util_blitter_save_clip(struct blitter_context *blitter,
 288                             struct pipe_clip_state *state)
 289 {
 290    blitter->saved_clip = *state;
 291 }
 292
 293 static INLINE
 294 void util_blitter_save_fragment_sampler_states(
 295                   struct blitter_context *blitter,
 296                   int num_sampler_states,
 297                   void **sampler_states)
 298 {
 299    assert(num_sampler_states <= Elements(blitter->saved_sampler_states));
 300
 301    blitter->saved_num_sampler_states = num_sampler_states;
 302    memcpy(blitter->saved_sampler_states, sampler_states,
 303           num_sampler_states * sizeof(void *));
 304 }
 305
 306 static INLINE void
 307 util_blitter_save_fragment_sampler_views(struct blitter_context *blitter,
 308                                          int num_views,
 309                                          struct pipe_sampler_view **views)
 310 {
 311    unsigned i;
 312    assert(num_views <= Elements(blitter->saved_sampler_views));
 313
 314    blitter->saved_num_sampler_views = num_views;
 315    for (i = 0; i < num_views; i++)
 316       pipe_sampler_view_reference(&blitter->saved_sampler_views[i],
 317                                   views[i]);
 318 }
 319
 320 static INLINE void
 321 util_blitter_save_vertex_buffers(struct blitter_context *blitter,
 322                                          int num_vertex_buffers,
 323                                          struct pipe_vertex_buffer *vertex_buffers)
 324 {
 325    assert(num_vertex_buffers <= Elements(blitter->saved_vertex_buffers));
 326
 327    blitter->saved_num_vertex_buffers = 0;
 328    util_copy_vertex_buffers(blitter->saved_vertex_buffers,
 329                             (unsigned*)&blitter->saved_num_vertex_buffers,
 330                             vertex_buffers,
 331                             num_vertex_buffers);
 332 }
 333
 334 #ifdef __cplusplus
 335 }
 336 #endif
 337
 338 #endif