lp_bld_sample.h revision f5b5fb32d3a9eb8667f91907bcf065fe8bd4988d 
1/**************************************************************************
2 *
3 * Copyright 2009 VMware, Inc.
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 VMWARE 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/**
29 * @file
30 * Texture sampling.
31 *
32 * @author Jose Fonseca <jfonseca@vmware.com>
33 */
34
35#ifndef LP_BLD_SAMPLE_H
36#define LP_BLD_SAMPLE_H
37
38
39#include "pipe/p_format.h"
40#include "util/u_debug.h"
41#include "gallivm/lp_bld.h"
42#include "gallivm/lp_bld_type.h"
43#include "gallivm/lp_bld_swizzle.h"
44
45
46struct pipe_resource;
47struct pipe_sampler_view;
48struct pipe_sampler_state;
49struct util_format_description;
50struct lp_type;
51struct lp_build_context;
52
53
54/**
55 * Sampler static state.
56 *
57 * These are the bits of state from pipe_resource and pipe_sampler_state that
58 * are embedded in the generated code.
59 */
60struct lp_sampler_static_state
61{
62   /* pipe_sampler_view's state */
63   enum pipe_format format;
64   unsigned swizzle_r:3;     /**< PIPE_SWIZZLE_* */
65   unsigned swizzle_g:3;
66   unsigned swizzle_b:3;
67   unsigned swizzle_a:3;
68
69   /* pipe_texture's state */
70   unsigned target:3;        /**< PIPE_TEXTURE_* */
71   unsigned pot_width:1;     /**< is the width a power of two? */
72   unsigned pot_height:1;
73   unsigned pot_depth:1;
74
75   /* pipe_sampler_state's state */
76   unsigned wrap_s:3;
77   unsigned wrap_t:3;
78   unsigned wrap_r:3;
79   unsigned min_img_filter:2;
80   unsigned min_mip_filter:2;
81   unsigned mag_img_filter:2;
82   unsigned compare_mode:1;
83   unsigned compare_func:3;
84   unsigned normalized_coords:1;
85   unsigned min_max_lod_equal:1;  /**< min_lod == max_lod ? */
86   unsigned lod_bias_non_zero:1;
87   unsigned apply_min_lod:1;  /**< min_lod > 0 ? */
88   unsigned apply_max_lod:1;  /**< max_lod < last_level ? */
89};
90
91
92/**
93 * Sampler dynamic state.
94 *
95 * These are the bits of state from pipe_resource and pipe_sampler_state that
96 * are computed in runtime.
97 *
98 * There are obtained through callbacks, as we don't want to tie the texture
99 * sampling code generation logic to any particular texture layout or pipe
100 * driver.
101 */
102struct lp_sampler_dynamic_state
103{
104
105   /** Obtain the base texture width (returns int32) */
106   LLVMValueRef
107   (*width)( const struct lp_sampler_dynamic_state *state,
108             LLVMBuilderRef builder,
109             unsigned unit);
110
111   /** Obtain the base texture height (returns int32) */
112   LLVMValueRef
113   (*height)( const struct lp_sampler_dynamic_state *state,
114              LLVMBuilderRef builder,
115              unsigned unit);
116
117   /** Obtain the base texture depth (returns int32) */
118   LLVMValueRef
119   (*depth)( const struct lp_sampler_dynamic_state *state,
120             LLVMBuilderRef builder,
121             unsigned unit);
122
123   /** Obtain the number of mipmap levels minus one (returns int32) */
124   LLVMValueRef
125   (*last_level)( const struct lp_sampler_dynamic_state *state,
126                  LLVMBuilderRef builder,
127                  unsigned unit);
128
129   /** Obtain stride in bytes between image rows/blocks (returns int32) */
130   LLVMValueRef
131   (*row_stride)( const struct lp_sampler_dynamic_state *state,
132                  LLVMBuilderRef builder,
133                  unsigned unit);
134
135   /** Obtain stride in bytes between image slices (returns int32) */
136   LLVMValueRef
137   (*img_stride)( const struct lp_sampler_dynamic_state *state,
138                  LLVMBuilderRef builder,
139                  unsigned unit);
140
141   /** Obtain pointer to array of pointers to mimpap levels */
142   LLVMValueRef
143   (*data_ptr)( const struct lp_sampler_dynamic_state *state,
144                LLVMBuilderRef builder,
145                unsigned unit);
146
147   /** Obtain texture min lod (returns float) */
148   LLVMValueRef
149   (*min_lod)(const struct lp_sampler_dynamic_state *state,
150              LLVMBuilderRef builder, unsigned unit);
151
152   /** Obtain texture max lod (returns float) */
153   LLVMValueRef
154   (*max_lod)(const struct lp_sampler_dynamic_state *state,
155              LLVMBuilderRef builder, unsigned unit);
156
157   /** Obtain texture lod bias (returns float) */
158   LLVMValueRef
159   (*lod_bias)(const struct lp_sampler_dynamic_state *state,
160               LLVMBuilderRef builder, unsigned unit);
161
162   /** Obtain texture border color (returns ptr to float[4]) */
163   LLVMValueRef
164   (*border_color)(const struct lp_sampler_dynamic_state *state,
165                   LLVMBuilderRef builder, unsigned unit);
166};
167
168
169/**
170 * Keep all information for sampling code generation in a single place.
171 */
172struct lp_build_sample_context
173{
174   LLVMBuilderRef builder;
175
176   const struct lp_sampler_static_state *static_state;
177
178   struct lp_sampler_dynamic_state *dynamic_state;
179
180   const struct util_format_description *format_desc;
181
182   /* See texture_dims() */
183   unsigned dims;
184
185   /** regular scalar float type */
186   struct lp_type float_type;
187   struct lp_build_context float_bld;
188
189   /** float vector type */
190   struct lp_build_context float_vec_bld;
191
192   /** regular scalar float type */
193   struct lp_type int_type;
194   struct lp_build_context int_bld;
195
196   /** Incoming coordinates type and build context */
197   struct lp_type coord_type;
198   struct lp_build_context coord_bld;
199
200   /** Unsigned integer coordinates */
201   struct lp_type uint_coord_type;
202   struct lp_build_context uint_coord_bld;
203
204   /** Signed integer coordinates */
205   struct lp_type int_coord_type;
206   struct lp_build_context int_coord_bld;
207
208   /** Unsigned integer texture size */
209   struct lp_type uint_size_type;
210   struct lp_build_context uint_size_bld;
211
212   /** Unsigned integer texture size */
213   struct lp_type float_size_type;
214   struct lp_build_context float_size_bld;
215
216   /** Output texels type and build context */
217   struct lp_type texel_type;
218   struct lp_build_context texel_bld;
219
220   /* Common dynamic state values */
221   LLVMValueRef width;
222   LLVMValueRef height;
223   LLVMValueRef depth;
224   LLVMValueRef row_stride_array;
225   LLVMValueRef img_stride_array;
226   LLVMValueRef data_array;
227
228   /** Unsigned vector with texture width, height, depth */
229   LLVMValueRef uint_size;
230
231   /* width, height, depth as uint vectors */
232   LLVMValueRef width_vec;
233   LLVMValueRef height_vec;
234   LLVMValueRef depth_vec;
235};
236
237
238
239/**
240 * We only support a few wrap modes in lp_build_sample_wrap_linear_int() at
241 * this time.  Return whether the given mode is supported by that function.
242 */
243static INLINE boolean
244lp_is_simple_wrap_mode(unsigned mode)
245{
246   switch (mode) {
247   case PIPE_TEX_WRAP_REPEAT:
248   case PIPE_TEX_WRAP_CLAMP_TO_EDGE:
249      return TRUE;
250   default:
251      return FALSE;
252   }
253}
254
255
256static INLINE void
257apply_sampler_swizzle(struct lp_build_sample_context *bld,
258                      LLVMValueRef *texel)
259{
260   unsigned char swizzles[4];
261
262   swizzles[0] = bld->static_state->swizzle_r;
263   swizzles[1] = bld->static_state->swizzle_g;
264   swizzles[2] = bld->static_state->swizzle_b;
265   swizzles[3] = bld->static_state->swizzle_a;
266
267   lp_build_swizzle_soa_inplace(&bld->texel_bld, texel, swizzles);
268}
269
270
271static INLINE unsigned
272texture_dims(enum pipe_texture_target tex)
273{
274   switch (tex) {
275   case PIPE_TEXTURE_1D:
276      return 1;
277   case PIPE_TEXTURE_2D:
278   case PIPE_TEXTURE_RECT:
279   case PIPE_TEXTURE_CUBE:
280      return 2;
281   case PIPE_TEXTURE_3D:
282      return 3;
283   default:
284      assert(0 && "bad texture target in texture_dims()");
285      return 2;
286   }
287}
288
289
290boolean
291lp_sampler_wrap_mode_uses_border_color(unsigned mode,
292                                       unsigned min_img_filter,
293                                       unsigned mag_img_filter);
294
295/**
296 * Derive the sampler static state.
297 */
298void
299lp_sampler_static_state(struct lp_sampler_static_state *state,
300                        const struct pipe_sampler_view *view,
301                        const struct pipe_sampler_state *sampler);
302
303
304void
305lp_build_lod_selector(struct lp_build_sample_context *bld,
306                      unsigned unit,
307                      const LLVMValueRef ddx[4],
308                      const LLVMValueRef ddy[4],
309                      LLVMValueRef lod_bias, /* optional */
310                      LLVMValueRef explicit_lod, /* optional */
311                      unsigned mip_filter,
312                      LLVMValueRef *out_lod_ipart,
313                      LLVMValueRef *out_lod_fpart);
314
315void
316lp_build_nearest_mip_level(struct lp_build_sample_context *bld,
317                           unsigned unit,
318                           LLVMValueRef lod,
319                           LLVMValueRef *level_out);
320
321void
322lp_build_linear_mip_levels(struct lp_build_sample_context *bld,
323                           unsigned unit,
324                           LLVMValueRef lod_ipart,
325                           LLVMValueRef *lod_fpart_inout,
326                           LLVMValueRef *level0_out,
327                           LLVMValueRef *level1_out);
328
329LLVMValueRef
330lp_build_get_mipmap_level(struct lp_build_sample_context *bld,
331                          LLVMValueRef level);
332
333LLVMValueRef
334lp_build_get_const_mipmap_level(struct lp_build_sample_context *bld,
335                                int level);
336
337
338void
339lp_build_mipmap_level_sizes(struct lp_build_sample_context *bld,
340                            LLVMValueRef ilevel,
341                            LLVMValueRef *out_width_vec,
342                            LLVMValueRef *out_height_vec,
343                            LLVMValueRef *out_depth_vec,
344                            LLVMValueRef *row_stride_vec,
345                            LLVMValueRef *img_stride_vec);
346
347
348void
349lp_build_cube_lookup(struct lp_build_sample_context *bld,
350                     LLVMValueRef s,
351                     LLVMValueRef t,
352                     LLVMValueRef r,
353                     LLVMValueRef *face,
354                     LLVMValueRef *face_s,
355                     LLVMValueRef *face_t);
356
357
358void
359lp_build_sample_partial_offset(struct lp_build_context *bld,
360                               unsigned block_length,
361                               LLVMValueRef coord,
362                               LLVMValueRef stride,
363                               LLVMValueRef *out_offset,
364                               LLVMValueRef *out_i);
365
366
367void
368lp_build_sample_offset(struct lp_build_context *bld,
369                       const struct util_format_description *format_desc,
370                       LLVMValueRef x,
371                       LLVMValueRef y,
372                       LLVMValueRef z,
373                       LLVMValueRef y_stride,
374                       LLVMValueRef z_stride,
375                       LLVMValueRef *out_offset,
376                       LLVMValueRef *out_i,
377                       LLVMValueRef *out_j);
378
379
380void
381lp_build_sample_soa(LLVMBuilderRef builder,
382                    const struct lp_sampler_static_state *static_state,
383                    struct lp_sampler_dynamic_state *dynamic_state,
384                    struct lp_type fp_type,
385                    unsigned unit,
386                    unsigned num_coords,
387                    const LLVMValueRef *coords,
388                    const LLVMValueRef *ddx,
389                    const LLVMValueRef *ddy,
390                    LLVMValueRef lod_bias,
391                    LLVMValueRef explicit_lod,
392                    LLVMValueRef texel_out[4]);
393
394void
395lp_build_sample_nop(struct lp_type type,
396                    LLVMValueRef texel_out[4]);
397
398
399#endif /* LP_BLD_SAMPLE_H */
400