1 /**************************************************************************
3 * Copyright 2009 VMware, Inc.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
32 * @author Jose Fonseca <jfonseca@vmware.com>
35 #ifndef LP_BLD_SAMPLE_H
36 #define LP_BLD_SAMPLE_H
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"
47 struct pipe_sampler_view
;
48 struct pipe_sampler_state
;
49 struct util_format_description
;
51 struct lp_build_context
;
55 * Helper struct holding all derivatives needed for sampling
64 enum lp_sampler_lod_property
{
65 LP_SAMPLER_LOD_SCALAR
,
66 LP_SAMPLER_LOD_PER_ELEMENT
,
67 LP_SAMPLER_LOD_PER_QUAD
72 * Texture static state.
74 * These are the bits of state from pipe_resource/pipe_sampler_view that
75 * are embedded in the generated code.
77 struct lp_static_texture_state
79 /* pipe_sampler_view's state */
80 enum pipe_format format
;
81 unsigned swizzle_r
:3; /**< PIPE_SWIZZLE_* */
86 /* pipe_texture's state */
87 unsigned target
:4; /**< PIPE_TEXTURE_* */
88 unsigned pot_width
:1; /**< is the width a power of two? */
89 unsigned pot_height
:1;
91 unsigned level_zero_only
:1;
96 * Sampler static state.
98 * These are the bits of state from pipe_sampler_state that
99 * are embedded in the generated code.
101 struct lp_static_sampler_state
103 /* pipe_sampler_state's state */
107 unsigned min_img_filter
:2;
108 unsigned min_mip_filter
:2;
109 unsigned mag_img_filter
:2;
110 unsigned compare_mode
:1;
111 unsigned compare_func
:3;
112 unsigned normalized_coords
:1;
113 unsigned min_max_lod_equal
:1; /**< min_lod == max_lod ? */
114 unsigned lod_bias_non_zero
:1;
115 unsigned apply_min_lod
:1; /**< min_lod > 0 ? */
116 unsigned apply_max_lod
:1; /**< max_lod < last_level ? */
117 unsigned seamless_cube_map
:1;
120 unsigned force_nearest_s
:1;
121 unsigned force_nearest_t
:1;
126 * Sampler dynamic state.
128 * These are the bits of state from pipe_resource/pipe_sampler_view
129 * as well as from sampler state that are computed at runtime.
131 * There are obtained through callbacks, as we don't want to tie the texture
132 * sampling code generation logic to any particular texture layout or pipe
135 struct lp_sampler_dynamic_state
137 /* First callbacks for sampler view state */
139 /** Obtain the base texture width (or number of elements) (returns int32) */
141 (*width
)( const struct lp_sampler_dynamic_state
*state
,
142 struct gallivm_state
*gallivm
,
143 unsigned texture_unit
);
145 /** Obtain the base texture height (returns int32) */
147 (*height
)( const struct lp_sampler_dynamic_state
*state
,
148 struct gallivm_state
*gallivm
,
149 unsigned texture_unit
);
151 /** Obtain the base texture depth (or array size) (returns int32) */
153 (*depth
)( const struct lp_sampler_dynamic_state
*state
,
154 struct gallivm_state
*gallivm
,
155 unsigned texture_unit
);
157 /** Obtain the first mipmap level (base level) (returns int32) */
159 (*first_level
)( const struct lp_sampler_dynamic_state
*state
,
160 struct gallivm_state
*gallivm
,
161 unsigned texture_unit
);
163 /** Obtain the number of mipmap levels minus one (returns int32) */
165 (*last_level
)( const struct lp_sampler_dynamic_state
*state
,
166 struct gallivm_state
*gallivm
,
167 unsigned texture_unit
);
169 /** Obtain stride in bytes between image rows/blocks (returns int32) */
171 (*row_stride
)( const struct lp_sampler_dynamic_state
*state
,
172 struct gallivm_state
*gallivm
,
173 unsigned texture_unit
);
175 /** Obtain stride in bytes between image slices (returns int32) */
177 (*img_stride
)( const struct lp_sampler_dynamic_state
*state
,
178 struct gallivm_state
*gallivm
,
179 unsigned texture_unit
);
181 /** Obtain pointer to base of texture */
183 (*base_ptr
)( const struct lp_sampler_dynamic_state
*state
,
184 struct gallivm_state
*gallivm
,
185 unsigned texture_unit
);
187 /** Obtain pointer to array of mipmap offsets */
189 (*mip_offsets
)( const struct lp_sampler_dynamic_state
*state
,
190 struct gallivm_state
*gallivm
,
191 unsigned texture_unit
);
193 /* These are callbacks for sampler state */
195 /** Obtain texture min lod (returns float) */
197 (*min_lod
)(const struct lp_sampler_dynamic_state
*state
,
198 struct gallivm_state
*gallivm
, unsigned sampler_unit
);
200 /** Obtain texture max lod (returns float) */
202 (*max_lod
)(const struct lp_sampler_dynamic_state
*state
,
203 struct gallivm_state
*gallivm
, unsigned sampler_unit
);
205 /** Obtain texture lod bias (returns float) */
207 (*lod_bias
)(const struct lp_sampler_dynamic_state
*state
,
208 struct gallivm_state
*gallivm
, unsigned sampler_unit
);
210 /** Obtain texture border color (returns ptr to float[4]) */
212 (*border_color
)(const struct lp_sampler_dynamic_state
*state
,
213 struct gallivm_state
*gallivm
, unsigned sampler_unit
);
218 * Keep all information for sampling code generation in a single place.
220 struct lp_build_sample_context
222 struct gallivm_state
*gallivm
;
224 const struct lp_static_texture_state
*static_texture_state
;
225 const struct lp_static_sampler_state
*static_sampler_state
;
227 struct lp_sampler_dynamic_state
*dynamic_state
;
229 const struct util_format_description
*format_desc
;
231 /* See texture_dims() */
234 /** SIMD vector width */
235 unsigned vector_width
;
237 /** number of mipmaps (valid are 1, length/4, length) */
240 /** number of lod values (valid are 1, length/4, length) */
243 /** regular scalar float type */
244 struct lp_type float_type
;
245 struct lp_build_context float_bld
;
247 /** float vector type */
248 struct lp_build_context float_vec_bld
;
250 /** regular scalar int type */
251 struct lp_type int_type
;
252 struct lp_build_context int_bld
;
254 /** Incoming coordinates type and build context */
255 struct lp_type coord_type
;
256 struct lp_build_context coord_bld
;
258 /** Signed integer coordinates */
259 struct lp_type int_coord_type
;
260 struct lp_build_context int_coord_bld
;
262 /** Unsigned integer texture size */
263 struct lp_type int_size_in_type
;
264 struct lp_build_context int_size_in_bld
;
266 /** Float incoming texture size */
267 struct lp_type float_size_in_type
;
268 struct lp_build_context float_size_in_bld
;
270 /** Unsigned integer texture size (might be per quad) */
271 struct lp_type int_size_type
;
272 struct lp_build_context int_size_bld
;
274 /** Float texture size (might be per quad) */
275 struct lp_type float_size_type
;
276 struct lp_build_context float_size_bld
;
278 /** Output texels type and build context */
279 struct lp_type texel_type
;
280 struct lp_build_context texel_bld
;
282 /** Float level type */
283 struct lp_type levelf_type
;
284 struct lp_build_context levelf_bld
;
286 /** Int level type */
287 struct lp_type leveli_type
;
288 struct lp_build_context leveli_bld
;
290 /** Float lod type */
291 struct lp_type lodf_type
;
292 struct lp_build_context lodf_bld
;
295 struct lp_type lodi_type
;
296 struct lp_build_context lodi_bld
;
298 /* Common dynamic state values */
299 LLVMValueRef row_stride_array
;
300 LLVMValueRef img_stride_array
;
301 LLVMValueRef base_ptr
;
302 LLVMValueRef mip_offsets
;
304 /** Integer vector with texture width, height, depth */
305 LLVMValueRef int_size
;
307 LLVMValueRef border_color_clamped
;
313 * We only support a few wrap modes in lp_build_sample_wrap_linear_int() at
314 * this time. Return whether the given mode is supported by that function.
316 static INLINE boolean
317 lp_is_simple_wrap_mode(unsigned mode
)
320 case PIPE_TEX_WRAP_REPEAT
:
321 case PIPE_TEX_WRAP_CLAMP_TO_EDGE
:
330 apply_sampler_swizzle(struct lp_build_sample_context
*bld
,
333 unsigned char swizzles
[4];
335 swizzles
[0] = bld
->static_texture_state
->swizzle_r
;
336 swizzles
[1] = bld
->static_texture_state
->swizzle_g
;
337 swizzles
[2] = bld
->static_texture_state
->swizzle_b
;
338 swizzles
[3] = bld
->static_texture_state
->swizzle_a
;
340 lp_build_swizzle_soa_inplace(&bld
->texel_bld
, texel
, swizzles
);
344 * not really dimension as such, this indicates the amount of
345 * "normal" texture coords subject to minification, wrapping etc.
347 static INLINE
unsigned
348 texture_dims(enum pipe_texture_target tex
)
351 case PIPE_TEXTURE_1D
:
352 case PIPE_TEXTURE_1D_ARRAY
:
355 case PIPE_TEXTURE_2D
:
356 case PIPE_TEXTURE_2D_ARRAY
:
357 case PIPE_TEXTURE_RECT
:
358 case PIPE_TEXTURE_CUBE
:
359 case PIPE_TEXTURE_CUBE_ARRAY
:
361 case PIPE_TEXTURE_3D
:
364 assert(0 && "bad texture target in texture_dims()");
369 static INLINE boolean
370 has_layer_coord(enum pipe_texture_target tex
)
373 case PIPE_TEXTURE_1D_ARRAY
:
374 case PIPE_TEXTURE_2D_ARRAY
:
375 /* cube is not layered but 3rd coord (after cube mapping) behaves the same */
376 case PIPE_TEXTURE_CUBE
:
377 case PIPE_TEXTURE_CUBE_ARRAY
:
386 lp_sampler_wrap_mode_uses_border_color(unsigned mode
,
387 unsigned min_img_filter
,
388 unsigned mag_img_filter
);
391 * Derive the sampler static state.
394 lp_sampler_static_sampler_state(struct lp_static_sampler_state
*state
,
395 const struct pipe_sampler_state
*sampler
);
399 lp_sampler_static_texture_state(struct lp_static_texture_state
*state
,
400 const struct pipe_sampler_view
*view
);
404 lp_build_lod_selector(struct lp_build_sample_context
*bld
,
405 unsigned texture_index
,
406 unsigned sampler_index
,
410 LLVMValueRef cube_rho
,
411 const struct lp_derivatives
*derivs
,
412 LLVMValueRef lod_bias
, /* optional */
413 LLVMValueRef explicit_lod
, /* optional */
415 LLVMValueRef
*out_lod_ipart
,
416 LLVMValueRef
*out_lod_fpart
,
417 LLVMValueRef
*out_lod_positive
);
420 lp_build_nearest_mip_level(struct lp_build_sample_context
*bld
,
421 unsigned texture_unit
,
423 LLVMValueRef
*level_out
,
424 LLVMValueRef
*out_of_bounds
);
427 lp_build_linear_mip_levels(struct lp_build_sample_context
*bld
,
428 unsigned texture_unit
,
429 LLVMValueRef lod_ipart
,
430 LLVMValueRef
*lod_fpart_inout
,
431 LLVMValueRef
*level0_out
,
432 LLVMValueRef
*level1_out
);
435 lp_build_get_mipmap_level(struct lp_build_sample_context
*bld
,
440 lp_build_get_mip_offsets(struct lp_build_sample_context
*bld
,
445 lp_build_mipmap_level_sizes(struct lp_build_sample_context
*bld
,
447 LLVMValueRef
*out_size_vec
,
448 LLVMValueRef
*row_stride_vec
,
449 LLVMValueRef
*img_stride_vec
);
453 lp_build_extract_image_sizes(struct lp_build_sample_context
*bld
,
454 struct lp_build_context
*size_bld
,
455 struct lp_type coord_type
,
457 LLVMValueRef
*out_width
,
458 LLVMValueRef
*out_height
,
459 LLVMValueRef
*out_depth
);
463 lp_build_unnormalized_coords(struct lp_build_sample_context
*bld
,
464 LLVMValueRef flt_size
,
471 lp_build_cube_lookup(struct lp_build_sample_context
*bld
,
472 LLVMValueRef
*coords
,
473 const struct lp_derivatives
*derivs_in
, /* optional */
475 struct lp_derivatives
*derivs_out
, /* optional */
476 boolean need_derivs
);
480 lp_build_cube_new_coords(struct lp_build_context
*ivec_bld
,
486 LLVMValueRef max_coord
,
487 LLVMValueRef new_faces
[4],
488 LLVMValueRef new_xcoords
[4][2],
489 LLVMValueRef new_ycoords
[4][2]);
493 lp_build_sample_partial_offset(struct lp_build_context
*bld
,
494 unsigned block_length
,
497 LLVMValueRef
*out_offset
,
498 LLVMValueRef
*out_i
);
502 lp_build_sample_offset(struct lp_build_context
*bld
,
503 const struct util_format_description
*format_desc
,
507 LLVMValueRef y_stride
,
508 LLVMValueRef z_stride
,
509 LLVMValueRef
*out_offset
,
511 LLVMValueRef
*out_j
);
515 lp_build_sample_soa(struct gallivm_state
*gallivm
,
516 const struct lp_static_texture_state
*static_texture_state
,
517 const struct lp_static_sampler_state
*static_sampler_state
,
518 struct lp_sampler_dynamic_state
*dynamic_texture_state
,
519 struct lp_type fp_type
,
521 unsigned texture_index
,
522 unsigned sampler_index
,
523 const LLVMValueRef
*coords
,
524 const LLVMValueRef
*offsets
,
525 const struct lp_derivatives
*derivs
,
526 LLVMValueRef lod_bias
,
527 LLVMValueRef explicit_lod
,
528 enum lp_sampler_lod_property lod_property
,
529 LLVMValueRef texel_out
[4]);
533 lp_build_coord_repeat_npot_linear(struct lp_build_sample_context
*bld
,
534 LLVMValueRef coord_f
,
535 LLVMValueRef length_i
,
536 LLVMValueRef length_f
,
537 LLVMValueRef
*coord0_i
,
538 LLVMValueRef
*weight_f
);
542 lp_build_size_query_soa(struct gallivm_state
*gallivm
,
543 const struct lp_static_texture_state
*static_state
,
544 struct lp_sampler_dynamic_state
*dynamic_state
,
545 struct lp_type int_type
,
546 unsigned texture_unit
,
548 boolean is_sviewinfo
,
549 enum lp_sampler_lod_property lod_property
,
550 LLVMValueRef explicit_lod
,
551 LLVMValueRef
*sizes_out
);
554 lp_build_sample_nop(struct gallivm_state
*gallivm
,
556 const LLVMValueRef
*coords
,
557 LLVMValueRef texel_out
[4]);
561 lp_build_minify(struct lp_build_context
*bld
,
562 LLVMValueRef base_size
,
567 #endif /* LP_BLD_SAMPLE_H */