1.. _screen:
2
3Screen
4======
5
6A screen is an object representing the context-independent part of a device.
7
8Flags and enumerations
9----------------------
10
11XXX some of these don't belong in this section.
12
13
14.. _pipe_cap:
15
16PIPE_CAP_*
17^^^^^^^^^^
18
19Capability queries return information about the features and limits of the
20driver/GPU.  For floating-point values, use :ref:`get_paramf`, and for boolean
21or integer values, use :ref:`get_param`.
22
23The integer capabilities:
24
25* ``PIPE_CAP_GRAPHICS``: Whether graphics is supported. If not, contexts can
26  only be created with PIPE_CONTEXT_COMPUTE_ONLY.
27* ``PIPE_CAP_NPOT_TEXTURES``: Whether :term:`NPOT` textures may have repeat modes,
28  normalized coordinates, and mipmaps.
29* ``PIPE_CAP_MAX_DUAL_SOURCE_RENDER_TARGETS``: How many dual-source blend RTs are support.
30  :ref:`Blend` for more information.
31* ``PIPE_CAP_ANISOTROPIC_FILTER``: Whether textures can be filtered anisotropically.
32* ``PIPE_CAP_POINT_SPRITE``: Whether point sprites are available.
33* ``PIPE_CAP_MAX_RENDER_TARGETS``: The maximum number of render targets that may be
34  bound.
35* ``PIPE_CAP_OCCLUSION_QUERY``: Whether occlusion queries are available.
36* ``PIPE_CAP_QUERY_TIME_ELAPSED``: Whether PIPE_QUERY_TIME_ELAPSED queries are available.
37* ``PIPE_CAP_TEXTURE_SHADOW_MAP``: indicates whether the fragment shader hardware
38  can do the depth texture / Z comparison operation in TEX instructions
39  for shadow testing.
40* ``PIPE_CAP_TEXTURE_SWIZZLE``: Whether swizzling through sampler views is
41  supported.
42* ``PIPE_CAP_MAX_TEXTURE_2D_SIZE``: The maximum size of 2D (and 1D) textures.
43* ``PIPE_CAP_MAX_TEXTURE_3D_LEVELS``: The maximum number of mipmap levels available
44  for a 3D texture.
45* ``PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS``: The maximum number of mipmap levels available
46  for a cubemap.
47* ``PIPE_CAP_TEXTURE_MIRROR_CLAMP_TO_EDGE``: Whether mirrored texture coordinates are
48  supported with the clamp-to-edge wrap mode.
49* ``PIPE_CAP_TEXTURE_MIRROR_CLAMP``: Whether mirrored texture coordinates are supported
50  with clamp or clamp-to-border wrap modes.
51* ``PIPE_CAP_BLEND_EQUATION_SEPARATE``: Whether alpha blend equations may be different
52  from color blend equations, in :ref:`Blend` state.
53* ``PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS``: The maximum number of stream buffers.
54* ``PIPE_CAP_PRIMITIVE_RESTART``: Whether primitive restart is supported.
55* ``PIPE_CAP_PRIMITIVE_RESTART_FIXED_INDEX``: Subset of
56  PRIMITIVE_RESTART where the restart index is always the fixed maximum
57  value for the index type.
58* ``PIPE_CAP_INDEP_BLEND_ENABLE``: Whether per-rendertarget blend enabling and channel
59  masks are supported. If 0, then the first rendertarget's blend mask is
60  replicated across all MRTs.
61* ``PIPE_CAP_INDEP_BLEND_FUNC``: Whether per-rendertarget blend functions are
62  available. If 0, then the first rendertarget's blend functions affect all
63  MRTs.
64* ``PIPE_CAP_MAX_TEXTURE_ARRAY_LAYERS``: The maximum number of texture array
65  layers supported. If 0, the array textures are not supported at all and
66  the ARRAY texture targets are invalid.
67* ``PIPE_CAP_FS_COORD_ORIGIN_UPPER_LEFT``: Whether the upper-left origin
68  fragment convention is supported.
69* ``PIPE_CAP_FS_COORD_ORIGIN_LOWER_LEFT``: Whether the lower-left origin
70  fragment convention is supported.
71* ``PIPE_CAP_FS_COORD_PIXEL_CENTER_HALF_INTEGER``: Whether the half-integer
72  pixel-center fragment convention is supported.
73* ``PIPE_CAP_FS_COORD_PIXEL_CENTER_INTEGER``: Whether the integer
74  pixel-center fragment convention is supported.
75* ``PIPE_CAP_POINT_COORD_ORIGIN_UPPER_LEFT``: Whether point coordinates use the
76  upper-left origin convention. Otherwise the lower-left convention is used.
77* ``PIPE_CAP_DEPTH_CLIP_DISABLE``: Whether the driver is capable of disabling
78  depth clipping (through pipe_rasterizer_state).
79* ``PIPE_CAP_DEPTH_CLIP_DISABLE_SEPARATE``: Whether the driver is capable of
80  disabling depth clipping (through pipe_rasterizer_state) separately for
81  the near and far plane. If not, depth_clip_near and depth_clip_far will be
82  equal.
83  ``PIPE_CAP_DEPTH_CLAMP_ENABLE``: Whether the driver is capable of
84  enabling depth clamping (through pipe_rasterizer_state) separately from depth
85  clipping. If not, depth_clamp will be the inverse of depth_clip_far.
86* ``PIPE_CAP_SHADER_STENCIL_EXPORT``: Whether a stencil reference value can be
87  written from a fragment shader.
88* ``PIPE_CAP_VS_INSTANCEID``: Whether ``SYSTEM_VALUE_INSTANCE_ID`` is
89  supported in the vertex shader.
90* ``PIPE_CAP_VERTEX_ELEMENT_INSTANCE_DIVISOR``: Whether the driver supports
91  per-instance vertex attribs.
92* ``PIPE_CAP_FRAGMENT_COLOR_CLAMPED``: Whether fragment color clamping is
93  supported.  That is, is the pipe_rasterizer_state::clamp_fragment_color
94  flag supported by the driver?  If not, gallium frontends will insert
95  clamping code into the fragment shaders when needed.
96
97* ``PIPE_CAP_MIXED_COLORBUFFER_FORMATS``: Whether mixed colorbuffer formats are
98  supported, e.g. RGBA8 and RGBA32F as the first and second colorbuffer, resp.
99* ``PIPE_CAP_VERTEX_COLOR_UNCLAMPED``: Whether the driver is capable of
100  outputting unclamped vertex colors from a vertex shader. If unsupported,
101  the vertex colors are always clamped. This is the default for DX9 hardware.
102* ``PIPE_CAP_VERTEX_COLOR_CLAMPED``: Whether the driver is capable of
103  clamping vertex colors when they come out of a vertex shader, as specified
104  by the pipe_rasterizer_state::clamp_vertex_color flag.  If unsupported,
105  the vertex colors are never clamped. This is the default for DX10 hardware.
106  If both clamped and unclamped CAPs are supported, the clamping can be
107  controlled through pipe_rasterizer_state.  If the driver cannot do vertex
108  color clamping, gallium frontends may insert clamping code into the vertex
109  shader.
110* ``PIPE_CAP_GLSL_FEATURE_LEVEL``: Whether the driver supports features
111  equivalent to a specific GLSL version. E.g. for GLSL 1.3, report 130.
112* ``PIPE_CAP_GLSL_FEATURE_LEVEL_COMPATIBILITY``: Whether the driver supports
113  features equivalent to a specific GLSL version including all legacy OpenGL
114  features only present in the OpenGL compatibility profile.
115  The only legacy features that Gallium drivers must implement are
116  the legacy shader inputs and outputs (colors, texcoords, fog, clipvertex,
117  edgeflag).
118* ``PIPE_CAP_ESSL_FEATURE_LEVEL``: An optional cap to allow drivers to
119  report a higher GLSL version for GLES contexts.  This is useful when a
120  driver does not support all the required features for a higher GL version,
121  but does support the required features for a higher GLES version.  A driver
122  is allowed to return ``0`` in which case ``PIPE_CAP_GLSL_FEATURE_LEVEL`` is
123  used.
124  Note that simply returning the same value as the GLSL feature level cap is
125  incorrect.  For example, GLSL version 3.30 does not require ``ARB_gpu_shader5``,
126  but ESSL version 3.20 es does require ``EXT_gpu_shader5``
127* ``PIPE_CAP_QUADS_FOLLOW_PROVOKING_VERTEX_CONVENTION``: Whether quads adhere to
128  the flatshade_first setting in ``pipe_rasterizer_state``.
129* ``PIPE_CAP_USER_VERTEX_BUFFERS``: Whether the driver supports user vertex
130  buffers.  If not, gallium frontends must upload all data which is not in hw
131  resources.  If user-space buffers are supported, the driver must also still
132  accept HW resource buffers.
133* ``PIPE_CAP_VERTEX_BUFFER_OFFSET_4BYTE_ALIGNED_ONLY``: This CAP describes a hw
134  limitation.  If true, pipe_vertex_buffer::buffer_offset must always be aligned
135  to 4.  If false, there are no restrictions on the offset.
136* ``PIPE_CAP_VERTEX_BUFFER_STRIDE_4BYTE_ALIGNED_ONLY``: This CAP describes a hw
137  limitation.  If true, pipe_vertex_buffer::stride must always be aligned to 4.
138  If false, there are no restrictions on the stride.
139* ``PIPE_CAP_VERTEX_ELEMENT_SRC_OFFSET_4BYTE_ALIGNED_ONLY``: This CAP describes
140  a hw limitation.  If true, pipe_vertex_element::src_offset must always be
141  aligned to 4.  If false, there are no restrictions on src_offset.
142* ``PIPE_CAP_VERTEX_ATTRIB_ELEMENT_ALIGNED_ONLY``: This CAP describes
143  a hw limitation.  If true, the sum of
144  ``pipe_vertex_element::src_offset + pipe_vertex_buffer::buffer_offset + pipe_vertex_buffer::stride``
145  must always be aligned to the component size for the vertex attributes
146  which access that buffer.  If false, there are no restrictions on these values.
147  This CAP cannot be used with any other alignment-requiring CAPs.
148* ``PIPE_CAP_COMPUTE``: Whether the implementation supports the
149  compute entry points defined in pipe_context and pipe_screen.
150* ``PIPE_CAP_CONSTANT_BUFFER_OFFSET_ALIGNMENT``: Describes the required
151  alignment of pipe_constant_buffer::buffer_offset.
152* ``PIPE_CAP_START_INSTANCE``: Whether the driver supports
153  pipe_draw_info::start_instance.
154* ``PIPE_CAP_QUERY_TIMESTAMP``: Whether PIPE_QUERY_TIMESTAMP and
155  the pipe_screen::get_timestamp hook are implemented.
156* ``PIPE_CAP_TEXTURE_MULTISAMPLE``: Whether all MSAA resources supported
157  for rendering are also supported for texturing.
158* ``PIPE_CAP_MIN_MAP_BUFFER_ALIGNMENT``: The minimum alignment that should be
159  expected for a pointer returned by transfer_map if the resource is
160  PIPE_BUFFER. In other words, the pointer returned by transfer_map is
161  always aligned to this value.
162* ``PIPE_CAP_TEXTURE_BUFFER_OFFSET_ALIGNMENT``: Describes the required
163  alignment for pipe_sampler_view::u.buf.offset, in bytes.
164  If a driver does not support offset/size, it should return 0.
165* ``PIPE_CAP_BUFFER_SAMPLER_VIEW_RGBA_ONLY``: Whether the driver only
166  supports R, RG, RGB and RGBA formats for PIPE_BUFFER sampler views.
167  When this is the case it should be assumed that the swizzle parameters
168  in the sampler view have no effect.
169* ``PIPE_CAP_TGSI_TEXCOORD``: This CAP describes a hw limitation.
170  If true, the hardware cannot replace arbitrary shader inputs with sprite
171  coordinates and hence the inputs that are desired to be replaceable must
172  be declared with TGSI_SEMANTIC_TEXCOORD instead of TGSI_SEMANTIC_GENERIC.
173  The rasterizer's sprite_coord_enable state therefore also applies to the
174  TEXCOORD semantic.
175  Also, TGSI_SEMANTIC_PCOORD becomes available, which labels a fragment shader
176  input that will always be replaced with sprite coordinates.
177* ``PIPE_CAP_TEXTURE_BUFFER_SAMPLER``: Whether a sampler should still
178  be used for PIPE_BUFFER resources (normally a sampler is only used
179  if the texture target is PIPE_TEXTURE_*).
180* ``PIPE_CAP_TEXTURE_TRANSFER_MODES``: The ``pipe_texture_transfer_mode`` modes
181  that are supported for implementing a texture transfer which needs format conversions
182  and swizzling in gallium frontends. Generally, all hardware drivers with
183  dedicated memory should return PIPE_TEXTURE_TRANSFER_BLIT and all software rasterizers
184  should return PIPE_TEXTURE_TRANSFER_DEFAULT. PIPE_TEXTURE_TRANSFER_COMPUTE requires drivers
185  to support 8bit and 16bit shader storage buffer writes and to implement
186  pipe_screen::is_compute_copy_faster.
187* ``PIPE_CAP_QUERY_PIPELINE_STATISTICS``: Whether PIPE_QUERY_PIPELINE_STATISTICS
188  is supported.
189* ``PIPE_CAP_TEXTURE_BORDER_COLOR_QUIRK``: Bitmask indicating whether special
190  considerations have to be given to the interaction between the border color
191  in the sampler object and the sampler view used with it.
192  If PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_R600 is set, the border color
193  may be affected in undefined ways for any kind of permutational swizzle
194  (any swizzle XYZW where X/Y/Z/W are not ZERO, ONE, or R/G/B/A respectively)
195  in the sampler view.
196  If PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_NV50 is set, the border color
197  state should be swizzled manually according to the swizzle in the sampler
198  view it is intended to be used with, or herein undefined results may occur
199  for permutational swizzles.
200* ``PIPE_CAP_MAX_TEXEL_BUFFER_ELEMENTS_UINT``: The maximum accessible number of
201  elements within a sampler buffer view and image buffer view. This is unsigned
202  integer with the maximum of 4G - 1.
203* ``PIPE_CAP_MAX_VIEWPORTS``: The maximum number of viewports (and scissors
204  since they are linked) a driver can support. Returning 0 is equivalent
205  to returning 1 because every driver has to support at least a single
206  viewport/scissor combination.
207* ``PIPE_CAP_ENDIANNESS``:: The endianness of the device.  Either
208  PIPE_ENDIAN_BIG or PIPE_ENDIAN_LITTLE.
209* ``PIPE_CAP_MIXED_FRAMEBUFFER_SIZES``: Whether it is allowed to have
210  different sizes for fb color/zs attachments. This controls whether
211  ARB_framebuffer_object is provided.
212* ``PIPE_CAP_VS_LAYER_VIEWPORT``: Whether ``VARYING_SLOT_LAYER`` and
213  ``VARYING_SLOT_VIEWPORT`` are supported as vertex shader outputs. Note that
214  the viewport will only be used if multiple viewports are exposed.
215* ``PIPE_CAP_MAX_GEOMETRY_OUTPUT_VERTICES``: The maximum number of vertices
216  output by a single invocation of a geometry shader.
217* ``PIPE_CAP_MAX_GEOMETRY_TOTAL_OUTPUT_COMPONENTS``: The maximum number of
218  vertex components output by a single invocation of a geometry shader.
219  This is the product of the number of attribute components per vertex and
220  the number of output vertices.
221* ``PIPE_CAP_MAX_TEXTURE_GATHER_COMPONENTS``: Max number of components
222  in format that texture gather can operate on. 1 == RED, ALPHA etc,
223  4 == All formats.
224* ``PIPE_CAP_TEXTURE_GATHER_SM5``: Whether the texture gather
225  hardware implements the SM5 features, component selection,
226  shadow comparison, and run-time offsets.
227* ``PIPE_CAP_BUFFER_MAP_PERSISTENT_COHERENT``: Whether
228  PIPE_MAP_PERSISTENT and PIPE_MAP_COHERENT are supported
229  for buffers.
230* ``PIPE_CAP_TEXTURE_QUERY_LOD``: Whether the ``LODQ`` instruction is
231  supported.
232* ``PIPE_CAP_MIN_TEXTURE_GATHER_OFFSET``: The minimum offset that can be used
233  in conjunction with a texture gather opcode.
234* ``PIPE_CAP_MAX_TEXTURE_GATHER_OFFSET``: The maximum offset that can be used
235  in conjunction with a texture gather opcode.
236* ``PIPE_CAP_SAMPLE_SHADING``: Whether there is support for per-sample
237  shading. The context->set_min_samples function will be expected to be
238  implemented.
239* ``PIPE_CAP_TEXTURE_GATHER_OFFSETS``: Whether the ``TG4`` instruction can
240  accept 4 offsets.
241* ``PIPE_CAP_VS_WINDOW_SPACE_POSITION``: Whether window-space position is
242  supported, which disables clipping and viewport transformation.
243* ``PIPE_CAP_MAX_VERTEX_STREAMS``: The maximum number of vertex streams
244  supported by the geometry shader. If stream-out is supported, this should be
245  at least 1. If stream-out is not supported, this should be 0.
246* ``PIPE_CAP_DRAW_INDIRECT``: Whether the driver supports taking draw arguments
247  { count, instance_count, start, index_bias } from a PIPE_BUFFER resource.
248  See pipe_draw_info.
249* ``PIPE_CAP_MULTI_DRAW_INDIRECT``: Whether the driver supports
250  pipe_draw_info::indirect_stride and ::indirect_count
251* ``PIPE_CAP_MULTI_DRAW_INDIRECT_PARAMS``: Whether the driver supports
252  taking the number of indirect draws from a separate parameter
253  buffer, see pipe_draw_indirect_info::indirect_draw_count.
254* ``PIPE_CAP_MULTI_DRAW_INDIRECT_PARTIAL_STRIDE``: Whether the driver supports
255  indirect draws with an arbitrary stride.
256* ``PIPE_CAP_FS_FINE_DERIVATIVE``: Whether the fragment shader supports
257  the FINE versions of DDX/DDY.
258* ``PIPE_CAP_VENDOR_ID``: The vendor ID of the underlying hardware. If it's
259  not available one should return 0xFFFFFFFF.
260* ``PIPE_CAP_DEVICE_ID``: The device ID (PCI ID) of the underlying hardware.
261  0xFFFFFFFF if not available.
262* ``PIPE_CAP_ACCELERATED``: Whether the renderer is hardware accelerated. 0 means
263  not accelerated (ie. CPU rendering), 1 means accelerated (ie. GPU rendering),
264  -1 means unknown (ie. an API translation driver which doesn't known what kind of
265  hardware it's running above).
266* ``PIPE_CAP_VIDEO_MEMORY``: The amount of video memory in megabytes.
267* ``PIPE_CAP_UMA``: If the device has a unified memory architecture or on-card
268  memory and GART.
269* ``PIPE_CAP_CONDITIONAL_RENDER_INVERTED``: Whether the driver supports inverted
270  condition for conditional rendering.
271* ``PIPE_CAP_MAX_VERTEX_ATTRIB_STRIDE``: The maximum supported vertex stride.
272* ``PIPE_CAP_SAMPLER_VIEW_TARGET``: Whether the sampler view's target can be
273  different than the underlying resource's, as permitted by
274  ARB_texture_view. For example a 2d array texture may be reinterpreted as a
275  cube (array) texture and vice-versa.
276* ``PIPE_CAP_CLIP_HALFZ``: Whether the driver supports the
277  pipe_rasterizer_state::clip_halfz being set to true. This is required
278  for enabling ARB_clip_control.
279* ``PIPE_CAP_VERTEXID_NOBASE``: If true, the driver only supports
280  TGSI_SEMANTIC_VERTEXID_NOBASE (and not TGSI_SEMANTIC_VERTEXID). This means
281  gallium frontends for APIs whose vertexIDs are offset by basevertex (such as GL)
282  will need to lower TGSI_SEMANTIC_VERTEXID to TGSI_SEMANTIC_VERTEXID_NOBASE
283  and TGSI_SEMANTIC_BASEVERTEX, so drivers setting this must handle both these
284  semantics. Only relevant if geometry shaders are supported.
285  (BASEVERTEX could be exposed separately too via ``PIPE_CAP_DRAW_PARAMETERS``).
286* ``PIPE_CAP_POLYGON_OFFSET_CLAMP``: If true, the driver implements support
287  for ``pipe_rasterizer_state::offset_clamp``.
288* ``PIPE_CAP_MULTISAMPLE_Z_RESOLVE``: Whether the driver supports blitting
289  a multisampled depth buffer into a single-sampled texture (or depth buffer).
290  Only the first sampled should be copied.
291* ``PIPE_CAP_RESOURCE_FROM_USER_MEMORY``: Whether the driver can create
292  a pipe_resource where an already-existing piece of (malloc'd) user memory
293  is used as its backing storage. In other words, whether the driver can map
294  existing user memory into the device address space for direct device access.
295  The create function is pipe_screen::resource_from_user_memory. The address
296  and size must be page-aligned.
297* ``PIPE_CAP_RESOURCE_FROM_USER_MEMORY_COMPUTE_ONLY``: Same as
298  ``PIPE_CAP_RESOURCE_FROM_USER_MEMORY`` but indicates it is only supported from
299  the compute engines.
300* ``PIPE_CAP_DEVICE_RESET_STATUS_QUERY``:
301  Whether pipe_context::get_device_reset_status is implemented.
302* ``PIPE_CAP_MAX_SHADER_PATCH_VARYINGS``:
303  How many per-patch outputs and inputs are supported between tessellation
304  control and tessellation evaluation shaders, not counting in TESSINNER and
305  TESSOUTER. The minimum allowed value for OpenGL is 30.
306* ``PIPE_CAP_TEXTURE_FLOAT_LINEAR``: Whether the linear minification and
307  magnification filters are supported with single-precision floating-point
308  textures.
309* ``PIPE_CAP_TEXTURE_HALF_FLOAT_LINEAR``: Whether the linear minification and
310  magnification filters are supported with half-precision floating-point
311  textures.
312* ``PIPE_CAP_DEPTH_BOUNDS_TEST``: Whether bounds_test, bounds_min, and
313  bounds_max states of pipe_depth_stencil_alpha_state behave according
314  to the GL_EXT_depth_bounds_test specification.
315* ``PIPE_CAP_TEXTURE_QUERY_SAMPLES``: Whether the `TXQS` opcode is supported
316* ``PIPE_CAP_FORCE_PERSAMPLE_INTERP``: If the driver can force per-sample
317  interpolation for all fragment shader inputs if
318  pipe_rasterizer_state::force_persample_interp is set. This is only used
319  by GL3-level sample shading (ARB_sample_shading). GL4-level sample shading
320  (ARB_gpu_shader5) doesn't use this. While GL3 hardware has a state for it,
321  GL4 hardware will likely need to emulate it with a shader variant, or by
322  selecting the interpolation weights with a conditional assignment
323  in the shader.
324* ``PIPE_CAP_SHAREABLE_SHADERS``: Whether shader CSOs can be used by any
325  pipe_context.  Important for reducing jank at draw time by letting GL shaders
326  linked in one thread be used in another thread without recompiling.
327* ``PIPE_CAP_COPY_BETWEEN_COMPRESSED_AND_PLAIN_FORMATS``:
328  Whether copying between compressed and plain formats is supported where
329  a compressed block is copied to/from a plain pixel of the same size.
330* ``PIPE_CAP_CLEAR_TEXTURE``: Whether `clear_texture` will be
331  available in contexts.
332* ``PIPE_CAP_CLEAR_SCISSORED``: Whether `clear` can accept a scissored
333  bounding box.
334* ``PIPE_CAP_DRAW_PARAMETERS``: Whether ``TGSI_SEMANTIC_BASEVERTEX``,
335  ``TGSI_SEMANTIC_BASEINSTANCE``, and ``TGSI_SEMANTIC_DRAWID`` are
336  supported in vertex shaders.
337* ``PIPE_CAP_SHADER_PACK_HALF_FLOAT``: Whether packed 16-bit float
338  packing/unpacking opcodes are supported.
339* ``PIPE_CAP_FS_POSITION_IS_SYSVAL``: If gallium frontends should use a
340  system value for the POSITION fragment shader input.
341* ``PIPE_CAP_FS_POINT_IS_SYSVAL``: If gallium frontends should use a system
342  value for the POINT fragment shader input.
343* ``PIPE_CAP_FS_FACE_IS_INTEGER_SYSVAL``: If gallium frontends should use
344  a system value for the FACE fragment shader input.
345  Also, the FACE system value is integer, not float.
346* ``PIPE_CAP_SHADER_BUFFER_OFFSET_ALIGNMENT``: Describes the required
347  alignment for pipe_shader_buffer::buffer_offset, in bytes. Maximum
348  value allowed is 256 (for GL conformance). 0 is only allowed if
349  shader buffers are not supported.
350* ``PIPE_CAP_INVALIDATE_BUFFER``: Whether the use of ``invalidate_resource``
351  for buffers is supported.
352* ``PIPE_CAP_GENERATE_MIPMAP``: Indicates whether pipe_context::generate_mipmap
353  is supported.
354* ``PIPE_CAP_STRING_MARKER``: Whether pipe->emit_string_marker() is supported.
355* ``PIPE_CAP_SURFACE_REINTERPRET_BLOCKS``: Indicates whether
356  pipe_context::create_surface supports reinterpreting a texture as a surface
357  of a format with different block width/height (but same block size in bits).
358  For example, a compressed texture image can be interpreted as a
359  non-compressed surface whose texels are the same number of bits as the
360  compressed blocks, and vice versa. The width and height of the surface is
361  adjusted appropriately.
362* ``PIPE_CAP_QUERY_BUFFER_OBJECT``: Driver supports
363  context::get_query_result_resource callback.
364* ``PIPE_CAP_PCI_GROUP``: Return the PCI segment group number.
365* ``PIPE_CAP_PCI_BUS``: Return the PCI bus number.
366* ``PIPE_CAP_PCI_DEVICE``: Return the PCI device number.
367* ``PIPE_CAP_PCI_FUNCTION``: Return the PCI function number.
368* ``PIPE_CAP_FRAMEBUFFER_NO_ATTACHMENT``:
369  If non-zero, rendering to framebuffers with no surface attachments
370  is supported. The context->is_format_supported function will be expected
371  to be implemented with PIPE_FORMAT_NONE yeilding the MSAA modes the hardware
372  supports. N.B., The maximum number of layers supported for rasterizing a
373  primitive on a layer is obtained from ``PIPE_CAP_MAX_TEXTURE_ARRAY_LAYERS``
374  even though it can be larger than the number of layers supported by either
375  rendering or textures.
376* ``PIPE_CAP_ROBUST_BUFFER_ACCESS_BEHAVIOR``: Implementation uses bounds
377  checking on resource accesses by shader if the context is created with
378  PIPE_CONTEXT_ROBUST_BUFFER_ACCESS. See the ARB_robust_buffer_access_behavior
379  extension for information on the required behavior for out of bounds accesses
380  and accesses to unbound resources.
381* ``PIPE_CAP_CULL_DISTANCE``: Whether the driver supports the arb_cull_distance
382  extension and thus implements proper support for culling planes.
383* ``PIPE_CAP_CULL_DISTANCE_NOCOMBINE``: Whether the driver wants to skip
384  running the `nir_lower_clip_cull_distance_arrays` pass in order to get
385  VARYING_SLOT_CULL_DIST0 slot variables.
386* ``PIPE_CAP_PRIMITIVE_RESTART_FOR_PATCHES``: Whether primitive restart is
387  supported for patch primitives.
388* ``PIPE_CAP_SHADER_GROUP_VOTE``: Whether the ``VOTE_*`` ops can be used in
389  shaders.
390* ``PIPE_CAP_MAX_WINDOW_RECTANGLES``: The maxium number of window rectangles
391  supported in ``set_window_rectangles``.
392* ``PIPE_CAP_POLYGON_OFFSET_UNITS_UNSCALED``: If true, the driver implements support
393  for ``pipe_rasterizer_state::offset_units_unscaled``.
394* ``PIPE_CAP_VIEWPORT_SUBPIXEL_BITS``: Number of bits of subpixel precision for
395  floating point viewport bounds.
396* ``PIPE_CAP_RASTERIZER_SUBPIXEL_BITS``: Number of bits of subpixel precision used
397  by the rasterizer.
398* ``PIPE_CAP_MIXED_COLOR_DEPTH_BITS``: Whether there is non-fallback
399  support for color/depth format combinations that use a different
400  number of bits. For the purpose of this cap, Z24 is treated as
401  32-bit. If set to off, that means that a B5G6R5 + Z24 or RGBA8 + Z16
402  combination will require a driver fallback, and should not be
403  advertised in the GLX/EGL config list.
404* ``PIPE_CAP_SHADER_ARRAY_COMPONENTS``: If true, the driver interprets the
405  UsageMask of input and output declarations and allows declaring arrays
406  in overlapping ranges. The components must be a contiguous range, e.g. a
407  UsageMask of  xy or yzw is allowed, but xz or yw isn't. Declarations with
408  overlapping locations must have matching semantic names and indices, and
409  equal interpolation qualifiers.
410  Components may overlap, notably when the gaps in an array of dvec3 are
411  filled in.
412* ``PIPE_CAP_STREAM_OUTPUT_PAUSE_RESUME``: Whether GL_ARB_transform_feeddback2
413  is supported, including pausing/resuming queries and having
414  `count_from_stream_output` set on indirect draws to implement
415  glDrawTransformFeedback.  Required for OpenGL 4.0.
416* ``PIPE_CAP_STREAM_OUTPUT_INTERLEAVE_BUFFERS``: Whether interleaved stream
417  output mode is able to interleave across buffers. This is required for
418  ARB_transform_feedback3.
419* ``PIPE_CAP_SHADER_CAN_READ_OUTPUTS``: Whether every TGSI shader stage can read
420  from the output file.
421* ``PIPE_CAP_FBFETCH``: The number of render targets whose value in the
422  current framebuffer can be read in the shader.  0 means framebuffer fetch
423  is not supported.  1 means that only the first render target can be read,
424  and a larger value would mean that multiple render targets are supported.
425* ``PIPE_CAP_FBFETCH_COHERENT``: Whether framebuffer fetches from the fragment
426  shader can be guaranteed to be coherent with framebuffer writes.
427* ``PIPE_CAP_FBFETCH_ZS``: Whether fragment shader can fetch current values of
428  Z/S attachments. These fetches are always coherent with framebuffer writes.
429* ``PIPE_CAP_LEGACY_MATH_RULES``: Whether NIR shaders support the
430  ``shader_info.use_legacy_math_rules`` flag (see documentation there), and
431  TGSI shaders support the corresponding ``TGSI_PROPERTY_LEGACY_MATH_RULES``.
432* ``PIPE_CAP_DOUBLES``: Whether double precision floating-point operations
433  are supported.
434* ``PIPE_CAP_INT64``: Whether 64-bit integer operations are supported.
435* ``PIPE_CAP_INT64_DIVMOD``: Whether 64-bit integer division/modulo
436  operations are supported.
437* ``PIPE_CAP_TGSI_TEX_TXF_LZ``: Whether TEX_LZ and TXF_LZ opcodes are
438  supported.
439* ``PIPE_CAP_SHADER_CLOCK``: Whether the CLOCK opcode is supported.
440* ``PIPE_CAP_POLYGON_MODE_FILL_RECTANGLE``: Whether the
441  PIPE_POLYGON_MODE_FILL_RECTANGLE mode is supported for
442  ``pipe_rasterizer_state::fill_front`` and
443  ``pipe_rasterizer_state::fill_back``.
444* ``PIPE_CAP_SPARSE_BUFFER_PAGE_SIZE``: The page size of sparse buffers in
445  bytes, or 0 if sparse buffers are not supported. The page size must be at
446  most 64KB.
447* ``PIPE_CAP_SHADER_BALLOT``: Whether the BALLOT and READ_* opcodes as well as
448  the SUBGROUP_* semantics are supported.
449* ``PIPE_CAP_TES_LAYER_VIEWPORT``: Whether ``VARYING_SLOT_LAYER`` and
450  ``VARYING_SLOT_VIEWPORT`` are supported as tessellation evaluation
451  shader outputs.
452* ``PIPE_CAP_CAN_BIND_CONST_BUFFER_AS_VERTEX``: Whether a buffer with just
453  PIPE_BIND_CONSTANT_BUFFER can be legally passed to set_vertex_buffers.
454* ``PIPE_CAP_ALLOW_MAPPED_BUFFERS_DURING_EXECUTION``: As the name says.
455* ``PIPE_CAP_POST_DEPTH_COVERAGE``: whether
456  ``TGSI_PROPERTY_FS_POST_DEPTH_COVERAGE`` is supported.
457* ``PIPE_CAP_BINDLESS_TEXTURE``: Whether bindless texture operations are
458  supported.
459* ``PIPE_CAP_NIR_SAMPLERS_AS_DEREF``: Whether NIR tex instructions should
460  reference texture and sampler as NIR derefs instead of by indices.
461* ``PIPE_CAP_QUERY_SO_OVERFLOW``: Whether the
462  ``PIPE_QUERY_SO_OVERFLOW_PREDICATE`` and
463  ``PIPE_QUERY_SO_OVERFLOW_ANY_PREDICATE`` query types are supported. Note that
464  for a driver that does not support multiple output streams (i.e.,
465  ``PIPE_CAP_MAX_VERTEX_STREAMS`` is 1), both query types are identical.
466* ``PIPE_CAP_MEMOBJ``: Whether operations on memory objects are supported.
467* ``PIPE_CAP_LOAD_CONSTBUF``: True if the driver supports ``TGSI_OPCODE_LOAD`` use
468  with constant buffers.
469* ``PIPE_CAP_TILE_RASTER_ORDER``: Whether the driver supports
470  GL_MESA_tile_raster_order, using the tile_raster_order_* fields in
471  pipe_rasterizer_state.
472* ``PIPE_CAP_MAX_COMBINED_SHADER_OUTPUT_RESOURCES``: Limit on combined shader
473  output resources (images + buffers + fragment outputs). If 0 the state
474  tracker works it out.
475* ``PIPE_CAP_FRAMEBUFFER_MSAA_CONSTRAINTS``: This determines limitations
476  on the number of samples that framebuffer attachments can have.
477  Possible values:
478
479    0. color.nr_samples == zs.nr_samples == color.nr_storage_samples
480       (standard MSAA quality)
481    1. color.nr_samples >= zs.nr_samples == color.nr_storage_samples
482       (enhanced MSAA quality)
483    2. color.nr_samples >= zs.nr_samples >= color.nr_storage_samples
484       (full flexibility in tuning MSAA quality and performance)
485
486  All color attachments must have the same number of samples and the same
487  number of storage samples.
488* ``PIPE_CAP_SIGNED_VERTEX_BUFFER_OFFSET``:
489  Whether pipe_vertex_buffer::buffer_offset is treated as signed. The u_vbuf
490  module needs this for optimal performance in workstation applications.
491* ``PIPE_CAP_CONTEXT_PRIORITY_MASK``: For drivers that support per-context
492  priorities, this returns a bitmask of ``PIPE_CONTEXT_PRIORITY_x`` for the
493  supported priority levels.  A driver that does not support prioritized
494  contexts can return 0.
495* ``PIPE_CAP_FENCE_SIGNAL``: True if the driver supports signaling semaphores
496  using fence_server_signal().
497* ``PIPE_CAP_CONSTBUF0_FLAGS``: The bits of pipe_resource::flags that must be
498  set when binding that buffer as constant buffer 0. If the buffer doesn't have
499  those bits set, pipe_context::set_constant_buffer(.., 0, ..) is ignored
500  by the driver, and the driver can throw assertion failures.
501* ``PIPE_CAP_PACKED_UNIFORMS``: True if the driver supports packed uniforms
502  as opposed to padding to vec4s.  Requires ``PIPE_SHADER_CAP_INTEGERS`` if
503  ``lower_uniforms_to_ubo`` is set.
504* ``PIPE_CAP_CONSERVATIVE_RASTER_POST_SNAP_TRIANGLES``: Whether the
505  ``PIPE_CONSERVATIVE_RASTER_POST_SNAP`` mode is supported for triangles.
506  The post-snap mode means the conservative rasterization occurs after
507  the conversion from floating-point to fixed-point coordinates
508  on the subpixel grid.
509* ``PIPE_CAP_CONSERVATIVE_RASTER_POST_SNAP_POINTS_LINES``: Whether the
510  ``PIPE_CONSERVATIVE_RASTER_POST_SNAP`` mode is supported for points and lines.
511* ``PIPE_CAP_CONSERVATIVE_RASTER_PRE_SNAP_TRIANGLES``: Whether the
512  ``PIPE_CONSERVATIVE_RASTER_PRE_SNAP`` mode is supported for triangles.
513  The pre-snap mode means the conservative rasterization occurs before
514  the conversion from floating-point to fixed-point coordinates.
515* ``PIPE_CAP_CONSERVATIVE_RASTER_PRE_SNAP_POINTS_LINES``: Whether the
516  ``PIPE_CONSERVATIVE_RASTER_PRE_SNAP`` mode is supported for points and lines.
517* ``PIPE_CAP_CONSERVATIVE_RASTER_POST_DEPTH_COVERAGE``: Whether
518  ``PIPE_CAP_POST_DEPTH_COVERAGE`` works with conservative rasterization.
519* ``PIPE_CAP_CONSERVATIVE_RASTER_INNER_COVERAGE``: Whether
520  inner_coverage from GL_INTEL_conservative_rasterization is supported.
521* ``PIPE_CAP_MAX_CONSERVATIVE_RASTER_SUBPIXEL_PRECISION_BIAS``: The maximum
522  subpixel precision bias in bits during conservative rasterization.
523* ``PIPE_CAP_PROGRAMMABLE_SAMPLE_LOCATIONS``: True is the driver supports
524  programmable sample location through ```get_sample_pixel_grid``` and
525  ```set_sample_locations```.
526* ``PIPE_CAP_MAX_GS_INVOCATIONS``: Maximum supported value of
527  TGSI_PROPERTY_GS_INVOCATIONS.
528* ``PIPE_CAP_MAX_SHADER_BUFFER_SIZE_UINT``: Maximum supported size for binding
529  with set_shader_buffers. This is unsigned integer with the maximum of 4GB - 1.
530* ``PIPE_CAP_MAX_COMBINED_SHADER_BUFFERS``: Maximum total number of shader
531  buffers. A value of 0 means the sum of all per-shader stage maximums (see
532  ``PIPE_SHADER_CAP_MAX_SHADER_BUFFERS``).
533* ``PIPE_CAP_MAX_COMBINED_HW_ATOMIC_COUNTERS``: Maximum total number of atomic
534  counters. A value of 0 means the default value (MAX_ATOMIC_COUNTERS = 4096).
535* ``PIPE_CAP_MAX_COMBINED_HW_ATOMIC_COUNTER_BUFFERS``: Maximum total number of
536  atomic counter buffers. A value of 0 means the sum of all per-shader stage
537  maximums (see ``PIPE_SHADER_CAP_MAX_HW_ATOMIC_COUNTER_BUFFERS``).
538* ``PIPE_CAP_MAX_TEXTURE_UPLOAD_MEMORY_BUDGET``: Maximum recommend memory size
539  for all active texture uploads combined. This is a performance hint.
540  0 means no limit.
541* ``PIPE_CAP_MAX_VERTEX_ELEMENT_SRC_OFFSET``: The maximum supported value for
542  of pipe_vertex_element::src_offset.
543* ``PIPE_CAP_SURFACE_SAMPLE_COUNT``: Whether the driver
544  supports pipe_surface overrides of resource nr_samples. If set, will
545  enable EXT_multisampled_render_to_texture.
546* ``PIPE_CAP_IMAGE_ATOMIC_FLOAT_ADD``: Atomic floating point adds are
547  supported on images, buffers, and shared memory.
548* ``PIPE_CAP_RGB_OVERRIDE_DST_ALPHA_BLEND``: True if the driver needs blend state to use zero/one instead of destination alpha for RGB/XRGB formats.
549* ``PIPE_CAP_GLSL_TESS_LEVELS_AS_INPUTS``: True if the driver wants TESSINNER and TESSOUTER to be inputs (rather than system values) for tessellation evaluation shaders.
550* ``PIPE_CAP_DEST_SURFACE_SRGB_CONTROL``: Indicates whether the drivers
551  supports switching the format between sRGB and linear for a surface that is
552  used as destination in draw and blit calls.
553* ``PIPE_CAP_NIR_COMPACT_ARRAYS``: True if the compiler backend supports NIR's compact array feature, for all shader stages.
554* ``PIPE_CAP_MAX_VARYINGS``: The maximum number of fragment shader
555  varyings. This will generally correspond to
556  ``PIPE_SHADER_CAP_MAX_INPUTS`` for the fragment shader, but in some
557  cases may be a smaller number.
558* ``PIPE_CAP_COMPUTE_GRID_INFO_LAST_BLOCK``: Whether pipe_grid_info::last_block
559  is implemented by the driver. See struct pipe_grid_info for more details.
560* ``PIPE_CAP_COMPUTE_SHADER_DERIVATIVE``: True if the driver supports derivatives (and texture lookups with implicit derivatives) in compute shaders.
561* ``PIPE_CAP_IMAGE_LOAD_FORMATTED``: True if a format for image loads does not need to be specified in the shader IR
562* ``PIPE_CAP_IMAGE_STORE_FORMATTED``: True if a format for image stores does not need to be specified in the shader IR
563* ``PIPE_CAP_THROTTLE``: Whether or not gallium frontends should throttle pipe_context
564  execution. 0 = throttling is disabled.
565* ``PIPE_CAP_DMABUF``: Whether Linux DMABUF handles are supported by
566  resource_from_handle and resource_get_handle.
567* ``PIPE_CAP_PREFER_COMPUTE_FOR_MULTIMEDIA``: Whether VDPAU, VAAPI, and
568  OpenMAX should use a compute-based blit instead of pipe_context::blit and compute pipeline for compositing images.
569* ``PIPE_CAP_FRAGMENT_SHADER_INTERLOCK``: True if fragment shader interlock
570  functionality is supported.
571* ``PIPE_CAP_CS_DERIVED_SYSTEM_VALUES_SUPPORTED``: True if driver handles
572  gl_LocalInvocationIndex and gl_GlobalInvocationID.  Otherwise, gallium frontends will
573  lower those system values.
574* ``PIPE_CAP_ATOMIC_FLOAT_MINMAX``: Atomic float point minimum,
575  maximum, exchange and compare-and-swap support to buffer and shared variables.
576* ``PIPE_CAP_TGSI_DIV``: Whether opcode DIV is supported
577* ``PIPE_CAP_DITHERING``: Whether dithering is supported
578* ``PIPE_CAP_FRAGMENT_SHADER_TEXTURE_LOD``: Whether texture lookups with
579  explicit LOD is supported in the fragment shader.
580* ``PIPE_CAP_FRAGMENT_SHADER_DERIVATIVES``: True if the driver supports
581  derivatives in fragment shaders.
582* ``PIPE_CAP_TEXTURE_SHADOW_LOD``: True if the driver supports shadow sampler
583  types with texture functions having interaction with LOD of texture lookup.
584* ``PIPE_CAP_SHADER_SAMPLES_IDENTICAL``: True if the driver supports a shader query to tell whether all samples of a multisampled surface are definitely identical.
585* ``PIPE_CAP_IMAGE_ATOMIC_INC_WRAP``: Atomic increment/decrement + wrap around
586  are supported.
587* ``PIPE_CAP_PREFER_IMM_ARRAYS_AS_CONSTBUF``: True if gallium frontends should
588  turn arrays whose contents can be deduced at compile time into constant
589  buffer loads, or false if the driver can handle such arrays itself in a more
590  efficient manner.
591* ``PIPE_CAP_GL_SPIRV``: True if the driver supports ARB_gl_spirv extension.
592* ``PIPE_CAP_GL_SPIRV_VARIABLE_POINTERS``: True if the driver supports Variable Pointers in SPIR-V shaders.
593* ``PIPE_CAP_DEMOTE_TO_HELPER_INVOCATION``: True if driver supports demote keyword in GLSL programs.
594* ``PIPE_CAP_TGSI_TG4_COMPONENT_IN_SWIZZLE``: True if driver wants the TG4 component encoded in sampler swizzle rather than as a separate source.
595* ``PIPE_CAP_FLATSHADE``: Driver supports pipe_rasterizer_state::flatshade.  Must be 1
596    for non-NIR drivers or gallium nine.
597* ``PIPE_CAP_ALPHA_TEST``: Driver supports alpha-testing.  Must be 1
598    for non-NIR drivers or gallium nine.  If set, frontend may set
599    ``pipe_depth_stencil_alpha_state->alpha_enabled`` and ``alpha_func``.
600    Otherwise, alpha test will be lowered to a comparison and discard_if in the
601    fragment shader.
602* ``PIPE_CAP_POINT_SIZE_FIXED``: Driver supports point-sizes that are fixed,
603  as opposed to writing gl_PointSize for every point.
604* ``PIPE_CAP_TWO_SIDED_COLOR``: Driver supports two-sided coloring.  Must be 1
605    for non-NIR drivers.  If set, pipe_rasterizer_state may be set to indicate
606    that backfacing primitives should use the back-side color as the FS input
607    color.  If unset, mesa/st will lower it to gl_FrontFacing reads in the
608    fragment shader.
609* ``PIPE_CAP_CLIP_PLANES``: Driver supports user-defined clip-planes. 0 denotes none, 1 denotes MAX_CLIP_PLANES. > 1 overrides MAX.
610* ``PIPE_CAP_MAX_VERTEX_BUFFERS``: Number of supported vertex buffers.
611* ``PIPE_CAP_OPENCL_INTEGER_FUNCTIONS``: Driver supports extended OpenCL-style integer functions.  This includes averge, saturating additiong, saturating subtraction, absolute difference, count leading zeros, and count trailing zeros.
612* ``PIPE_CAP_INTEGER_MULTIPLY_32X16``: Driver supports integer multiplication between a 32-bit integer and a 16-bit integer.  If the second operand is 32-bits, the upper 16-bits are ignored, and the low 16-bits are possibly sign extended as necessary.
613* ``PIPE_CAP_NIR_IMAGES_AS_DEREF``: Whether NIR image load/store intrinsics should be nir_intrinsic_image_deref_* instead of nir_intrinsic_image_*.  Defaults to true.
614* ``PIPE_CAP_PACKED_STREAM_OUTPUT``: Driver supports packing optimization for stream output (e.g. GL transform feedback captured variables). Defaults to true.
615* ``PIPE_CAP_VIEWPORT_TRANSFORM_LOWERED``: Driver needs the nir_lower_viewport_transform pass to be enabled. This also means that the gl_Position value is modified and should be lowered for transform feedback, if needed. Defaults to false.
616* ``PIPE_CAP_PSIZ_CLAMPED``: Driver needs for the point size to be clamped. Additionally, the gl_PointSize has been modified and its value should be lowered for transform feedback, if needed. Defaults to false.
617* ``PIPE_CAP_GL_BEGIN_END_BUFFER_SIZE``: Buffer size used to upload vertices for glBegin/glEnd.
618* ``PIPE_CAP_VIEWPORT_SWIZZLE``: Whether pipe_viewport_state::swizzle can be used to specify pre-clipping swizzling of coordinates (see GL_NV_viewport_swizzle).
619* ``PIPE_CAP_SYSTEM_SVM``: True if all application memory can be shared with the GPU without explicit mapping.
620* ``PIPE_CAP_VIEWPORT_MASK``: Whether ``TGSI_SEMANTIC_VIEWPORT_MASK`` and ``TGSI_PROPERTY_LAYER_VIEWPORT_RELATIVE`` are supported (see GL_NV_viewport_array2).
621* ``PIPE_CAP_MAP_UNSYNCHRONIZED_THREAD_SAFE``: Whether mapping a buffer as unsynchronized from any thread is safe.
622* ``PIPE_CAP_GLSL_ZERO_INIT``: Choose a default zero initialization some glsl variables. If `1`, then all glsl shader variables and gl_FragColor are initialized to zero. If `2`, then shader out variables are not initialized but function out variables are.
623* ``PIPE_CAP_BLEND_EQUATION_ADVANCED``: Driver supports blend equation advanced without necessarily supporting FBFETCH.
624* ``PIPE_CAP_NIR_ATOMICS_AS_DEREF``: Whether NIR atomics instructions should reference atomics as NIR derefs instead of by indices.
625* ``PIPE_CAP_NO_CLIP_ON_COPY_TEX``: Driver doesn't want x/y/width/height clipped based on src size when doing a copy texture operation (eg: may want out-of-bounds reads that produce 0 instead of leaving the texture content undefined)
626* ``PIPE_CAP_MAX_TEXTURE_MB``: Maximum texture size in MB (default is 1024)
627* ``PIPE_CAP_DEVICE_PROTECTED_CONTENT``: Whether the device support protected / encrypted content.
628* ``PIPE_CAP_PREFER_REAL_BUFFER_IN_CONSTBUF0``: The state tracker is encouraged to upload constants into a real buffer and bind it into constant buffer 0 instead of binding a user pointer. This may enable a faster codepath in a gallium frontend for drivers that really prefer a real buffer.
629* ``PIPE_CAP_GL_CLAMP``: Driver natively supports GL_CLAMP.  Required for non-NIR drivers with the GL frontend.  NIR drivers with the cap unavailable will have GL_CLAMP lowered to txd/txl with a saturate on the coordinates.
630* ``PIPE_CAP_TEXRECT``: Driver supports rectangle textures.  Required for OpenGL on `!prefers_nir` drivers.  If this cap is not present, st/mesa will lower the NIR to use normal 2D texture sampling by using either `txs` or `nir_intrinsic_load_texture_scaling` to normalize the texture coordinates.
631* ``PIPE_CAP_SAMPLER_REDUCTION_MINMAX``: Driver supports EXT min/max sampler reduction.
632* ``PIPE_CAP_SAMPLER_REDUCTION_MINMAX_ARB``: Driver supports ARB min/max sampler reduction with format queries.
633* ``PIPE_CAP_EMULATE_NONFIXED_PRIMITIVE_RESTART``: Driver requests all draws using a non-fixed restart index to be rewritten to use a fixed restart index.
634* ``PIPE_CAP_SUPPORTED_PRIM_MODES``: A bitmask of the ``pipe_prim_type`` enum values that the driver can natively support.
635* ``PIPE_CAP_SUPPORTED_PRIM_MODES_WITH_RESTART``: A bitmask of the ``pipe_prim_type`` enum values that the driver can natively support for primitive restart. Only useful if ``PIPE_CAP_PRIMITIVE_RESTART`` is also exported.
636* ``PIPE_CAP_PREFER_BACK_BUFFER_REUSE``: Only applies to DRI_PRIME. If 1, the driver prefers that DRI3 tries to use the same back buffer each frame. If 0, this means DRI3 will at least use 2 back buffers and ping-pong between them to allow the tiled->linear copy to run in parallel.
637* ``PIPE_CAP_DRAW_VERTEX_STATE``: Driver supports `pipe_screen::create_vertex_state/vertex_state_destroy` and `pipe_context::draw_vertex_state`. Only used by display lists and designed to serve vbo_save.
638* ``PIPE_CAP_PREFER_POT_ALIGNED_VARYINGS``: Driver prefers varyings to be aligned to power of two in a slot. If this cap is enabled, vec4 varying will be placed in .xyzw components of the varying slot, vec3 in .xyz and vec2 in .xy or .zw
639* ``PIPE_CAP_MAX_SPARSE_TEXTURE_SIZE``: Maximum 1D/2D/rectangle texture image dimension for a sparse texture.
640* ``PIPE_CAP_MAX_SPARSE_3D_TEXTURE_SIZE``: Maximum 3D texture image dimension for a sparse texture.
641* ``PIPE_CAP_MAX_SPARSE_ARRAY_TEXTURE_LAYERS``: Maximum number of layers in a sparse array texture.
642* ``PIPE_CAP_SPARSE_TEXTURE_FULL_ARRAY_CUBE_MIPMAPS``: TRUE if there are no restrictions on the allocation of mipmaps in sparse textures and FALSE otherwise. See SPARSE_TEXTURE_FULL_ARRAY_CUBE_MIPMAPS_ARB description in ARB_sparse_texture extension spec.
643* ``PIPE_CAP_QUERY_SPARSE_TEXTURE_RESIDENCY``: TRUE if shader sparse texture sample instruction could also return the residency information.
644* ``PIPE_CAP_CLAMP_SPARSE_TEXTURE_LOD``: TRUE if shader sparse texture sample instruction support clamp the minimal lod to prevent read from un-committed pages.
645* ``PIPE_CAP_ALLOW_DRAW_OUT_OF_ORDER``: TRUE if the driver allows the "draw out of order" optimization to be enabled. See _mesa_update_allow_draw_out_of_order for more details.
646* ``PIPE_CAP_MAX_CONSTANT_BUFFER_SIZE_UINT``: Maximum bound constant buffer size in bytes. This is unsigned integer with the maximum of 4GB - 1. This applies to all constant buffers used by UBOs, unlike `PIPE_SHADER_CAP_MAX_CONST_BUFFER0_SIZE`, which is specifically for GLSL uniforms.
647* ``PIPE_CAP_HARDWARE_GL_SELECT``: Enable hardware accelerated GL_SELECT for this driver.
648
649.. _pipe_capf:
650
651PIPE_CAPF_*
652^^^^^^^^^^^^^^^^
653
654The floating-point capabilities are:
655
656* ``PIPE_CAPF_MIN_LINE_WIDTH``: The minimum width of a regular line.
657* ``PIPE_CAPF_MIN_LINE_WIDTH_AA``: The minimum width of a smoothed line.
658* ``PIPE_CAPF_MAX_LINE_WIDTH``: The maximum width of a regular line.
659* ``PIPE_CAPF_MAX_LINE_WIDTH_AA``: The maximum width of a smoothed line.
660* ``PIPE_CAPF_LINE_WIDTH_GRANULARITY``: The line width is rounded to a multiple of this number.
661* ``PIPE_CAPF_MIN_POINT_SIZE``: The minimum width and height of a point.
662* ``PIPE_CAPF_MIN_POINT_SIZE_AA``: The minimum width and height of a smoothed point.
663* ``PIPE_CAPF_MAX_POINT_SIZE``: The maximum width and height of a point.
664* ``PIPE_CAPF_MAX_POINT_SIZE_AA``: The maximum width and height of a smoothed point.
665* ``PIPE_CAPF_POINT_SIZE_GRANULARITY``: The point size is rounded to a multiple of this number.
666* ``PIPE_CAPF_MAX_TEXTURE_ANISOTROPY``: The maximum level of anisotropy that can be
667  applied to anisotropically filtered textures.
668* ``PIPE_CAPF_MAX_TEXTURE_LOD_BIAS``: The maximum :term:`LOD` bias that may be applied
669  to filtered textures.
670* ``PIPE_CAPF_MIN_CONSERVATIVE_RASTER_DILATE``: The minimum conservative rasterization
671  dilation.
672* ``PIPE_CAPF_MAX_CONSERVATIVE_RASTER_DILATE``: The maximum conservative rasterization
673  dilation.
674* ``PIPE_CAPF_CONSERVATIVE_RASTER_DILATE_GRANULARITY``: The conservative rasterization
675  dilation granularity for values relative to the minimum dilation.
676
677
678.. _pipe_shader_cap:
679
680PIPE_SHADER_CAP_*
681^^^^^^^^^^^^^^^^^
682
683These are per-shader-stage capabitity queries. Different shader stages may
684support different features.
685
686* ``PIPE_SHADER_CAP_MAX_INSTRUCTIONS``: The maximum number of instructions.
687* ``PIPE_SHADER_CAP_MAX_ALU_INSTRUCTIONS``: The maximum number of arithmetic instructions.
688* ``PIPE_SHADER_CAP_MAX_TEX_INSTRUCTIONS``: The maximum number of texture instructions.
689* ``PIPE_SHADER_CAP_MAX_TEX_INDIRECTIONS``: The maximum number of texture indirections.
690* ``PIPE_SHADER_CAP_MAX_CONTROL_FLOW_DEPTH``: The maximum nested control flow depth.
691* ``PIPE_SHADER_CAP_MAX_INPUTS``: The maximum number of input registers.
692* ``PIPE_SHADER_CAP_MAX_OUTPUTS``: The maximum number of output registers.
693  This is valid for all shaders except the fragment shader.
694* ``PIPE_SHADER_CAP_MAX_CONST_BUFFER0_SIZE``: The maximum size of constant buffer 0 in bytes.
695* ``PIPE_SHADER_CAP_MAX_CONST_BUFFERS``: Maximum number of constant buffers that can be bound
696  to any shader stage using ``set_constant_buffer``. If 0 or 1, the pipe will
697  only permit binding one constant buffer per shader.
698
699If a value greater than 0 is returned, the driver can have multiple
700constant buffers bound to shader stages. The CONST register file is
701accessed with two-dimensional indices, like in the example below.
702
703DCL CONST[0][0..7]       # declare first 8 vectors of constbuf 0
704DCL CONST[3][0]          # declare first vector of constbuf 3
705MOV OUT[0], CONST[0][3]  # copy vector 3 of constbuf 0
706
707* ``PIPE_SHADER_CAP_MAX_TEMPS``: The maximum number of temporary registers.
708* ``PIPE_SHADER_CAP_CONT_SUPPORTED``: Whether continue is supported.
709* ``PIPE_SHADER_CAP_INDIRECT_INPUT_ADDR``: Whether indirect addressing
710  of the input file is supported.
711* ``PIPE_SHADER_CAP_INDIRECT_OUTPUT_ADDR``: Whether indirect addressing
712  of the output file is supported.
713* ``PIPE_SHADER_CAP_INDIRECT_TEMP_ADDR``: Whether indirect addressing
714  of the temporary file is supported.
715* ``PIPE_SHADER_CAP_INDIRECT_CONST_ADDR``: Whether indirect addressing
716  of the constant file is supported.
717* ``PIPE_SHADER_CAP_SUBROUTINES``: Whether subroutines are supported, i.e.
718  BGNSUB, ENDSUB, CAL, and RET, including RET in the main block.
719* ``PIPE_SHADER_CAP_INTEGERS``: Whether integer opcodes are supported.
720  If unsupported, only float opcodes are supported.
721* ``PIPE_SHADER_CAP_INT64_ATOMICS``: Whether int64 atomic opcodes are supported. The device needs to support add, sub, swap, cmpswap, and, or, xor, min, and max.
722* ``PIPE_SHADER_CAP_FP16``: Whether half precision floating-point opcodes are supported.
723   If unsupported, half precision ops need to be lowered to full precision.
724* ``PIPE_SHADER_CAP_FP16_DERIVATIVES``: Whether half precision floating-point
725  DDX and DDY opcodes are supported.
726* ``PIPE_SHADER_CAP_FP16_CONST_BUFFERS``: Whether half precision floating-point
727  constant buffer loads are supported. Drivers are recommended to report 0
728  if x86 F16C is not supported by the CPU (or an equivalent instruction set
729  on other CPU architectures), otherwise they could be impacted by emulated
730  FP16 conversions in glUniform.
731* ``PIPE_SHADER_CAP_INT16``: Whether 16-bit signed and unsigned integer types
732  are supported.
733* ``PIPE_SHADER_CAP_GLSL_16BIT_CONSTS``: Lower mediump constants to 16-bit.
734  Note that 16-bit constants are not lowered to uniforms in GLSL.
735* ``PIPE_SHADER_CAP_MAX_TEXTURE_SAMPLERS``: The maximum number of texture
736  samplers.
737* ``PIPE_SHADER_CAP_PREFERRED_IR``: Preferred representation of the
738  program.  It should be one of the ``pipe_shader_ir`` enum values.
739* ``PIPE_SHADER_CAP_MAX_SAMPLER_VIEWS``: The maximum number of texture
740  sampler views. Must not be lower than PIPE_SHADER_CAP_MAX_TEXTURE_SAMPLERS.
741* ``PIPE_SHADER_CAP_DROUND_SUPPORTED``: Whether double precision rounding
742  is supported. If it is, DTRUNC/DCEIL/DFLR/DROUND opcodes may be used.
743* ``PIPE_SHADER_CAP_DFRACEXP_DLDEXP_SUPPORTED``: Whether DFRACEXP and
744  DLDEXP are supported.
745* ``PIPE_SHADER_CAP_LDEXP_SUPPORTED``: Whether LDEXP is supported.
746* ``PIPE_SHADER_CAP_TGSI_ANY_INOUT_DECL_RANGE``: Whether the driver doesn't
747  ignore tgsi_declaration_range::Last for shader inputs and outputs.
748* ``PIPE_SHADER_CAP_MAX_SHADER_BUFFERS``: Maximum number of memory buffers
749  (also used to implement atomic counters). Having this be non-0 also
750  implies support for the ``LOAD``, ``STORE``, and ``ATOM*`` TGSI
751  opcodes.
752* ``PIPE_SHADER_CAP_SUPPORTED_IRS``: Supported representations of the
753  program.  It should be a mask of ``pipe_shader_ir`` bits.
754* ``PIPE_SHADER_CAP_MAX_SHADER_IMAGES``: Maximum number of image units.
755* ``PIPE_SHADER_CAP_MAX_HW_ATOMIC_COUNTERS``: If atomic counters are separate,
756  how many HW counters are available for this stage. (0 uses SSBO atomics).
757* ``PIPE_SHADER_CAP_MAX_HW_ATOMIC_COUNTER_BUFFERS``: If atomic counters are
758  separate, how many atomic counter buffers are available for this stage.
759
760.. _pipe_compute_cap:
761
762PIPE_COMPUTE_CAP_*
763^^^^^^^^^^^^^^^^^^
764
765Compute-specific capabilities. They can be queried using
766pipe_screen::get_compute_param.
767
768* ``PIPE_COMPUTE_CAP_IR_TARGET``: A description of the target of the form
769  ``processor-arch-manufacturer-os`` that will be passed on to the compiler.
770  This CAP is only relevant for drivers that specify PIPE_SHADER_IR_NATIVE for
771  their preferred IR.
772  Value type: null-terminated string. Shader IR type dependent.
773* ``PIPE_COMPUTE_CAP_GRID_DIMENSION``: Number of supported dimensions
774  for grid and block coordinates.  Value type: ``uint64_t``. Shader IR type dependent.
775* ``PIPE_COMPUTE_CAP_MAX_GRID_SIZE``: Maximum grid size in block
776  units.  Value type: ``uint64_t []``.  Shader IR type dependent.
777* ``PIPE_COMPUTE_CAP_MAX_BLOCK_SIZE``: Maximum block size in thread
778  units.  Value type: ``uint64_t []``. Shader IR type dependent.
779* ``PIPE_COMPUTE_CAP_MAX_THREADS_PER_BLOCK``: Maximum number of threads that
780  a single block can contain.  Value type: ``uint64_t``. Shader IR type dependent.
781  This may be less than the product of the components of MAX_BLOCK_SIZE and is
782  usually limited by the number of threads that can be resident simultaneously
783  on a compute unit.
784* ``PIPE_COMPUTE_CAP_MAX_GLOBAL_SIZE``: Maximum size of the GLOBAL
785  resource.  Value type: ``uint64_t``. Shader IR type dependent.
786* ``PIPE_COMPUTE_CAP_MAX_LOCAL_SIZE``: Maximum size of the LOCAL
787  resource.  Value type: ``uint64_t``. Shader IR type dependent.
788* ``PIPE_COMPUTE_CAP_MAX_PRIVATE_SIZE``: Maximum size of the PRIVATE
789  resource.  Value type: ``uint64_t``. Shader IR type dependent.
790* ``PIPE_COMPUTE_CAP_MAX_INPUT_SIZE``: Maximum size of the INPUT
791  resource.  Value type: ``uint64_t``. Shader IR type dependent.
792* ``PIPE_COMPUTE_CAP_MAX_MEM_ALLOC_SIZE``: Maximum size of a memory object
793  allocation in bytes.  Value type: ``uint64_t``.
794* ``PIPE_COMPUTE_CAP_MAX_CLOCK_FREQUENCY``: Maximum frequency of the GPU
795  clock in MHz. Value type: ``uint32_t``
796* ``PIPE_COMPUTE_CAP_MAX_COMPUTE_UNITS``: Maximum number of compute units
797  Value type: ``uint32_t``
798* ``PIPE_COMPUTE_CAP_IMAGES_SUPPORTED``: Whether images are supported
799  non-zero means yes, zero means no. Value type: ``uint32_t``
800* ``PIPE_COMPUTE_CAP_SUBGROUP_SIZE``: The size of a basic execution unit in
801  threads. Also known as wavefront size, warp size or SIMD width.
802* ``PIPE_COMPUTE_CAP_ADDRESS_BITS``: The default compute device address space
803  size specified as an unsigned integer value in bits.
804* ``PIPE_COMPUTE_CAP_MAX_VARIABLE_THREADS_PER_BLOCK``: Maximum variable number
805  of threads that a single block can contain. This is similar to
806  PIPE_COMPUTE_CAP_MAX_THREADS_PER_BLOCK, except that the variable size is not
807  known a compile-time but at dispatch-time.
808
809.. _pipe_bind:
810
811PIPE_BIND_*
812^^^^^^^^^^^
813
814These flags indicate how a resource will be used and are specified at resource
815creation time. Resources may be used in different roles
816during their lifecycle. Bind flags are cumulative and may be combined to create
817a resource which can be used for multiple things.
818Depending on the pipe driver's memory management and these bind flags,
819resources might be created and handled quite differently.
820
821* ``PIPE_BIND_RENDER_TARGET``: A color buffer or pixel buffer which will be
822  rendered to.  Any surface/resource attached to pipe_framebuffer_state::cbufs
823  must have this flag set.
824* ``PIPE_BIND_DEPTH_STENCIL``: A depth (Z) buffer and/or stencil buffer. Any
825  depth/stencil surface/resource attached to pipe_framebuffer_state::zsbuf must
826  have this flag set.
827* ``PIPE_BIND_BLENDABLE``: Used in conjunction with PIPE_BIND_RENDER_TARGET to
828  query whether a device supports blending for a given format.
829  If this flag is set, surface creation may fail if blending is not supported
830  for the specified format. If it is not set, a driver may choose to ignore
831  blending on surfaces with formats that would require emulation.
832* ``PIPE_BIND_DISPLAY_TARGET``: A surface that can be presented to screen. Arguments to
833  pipe_screen::flush_front_buffer must have this flag set.
834* ``PIPE_BIND_SAMPLER_VIEW``: A texture that may be sampled from in a fragment
835  or vertex shader.
836* ``PIPE_BIND_VERTEX_BUFFER``: A vertex buffer.
837* ``PIPE_BIND_INDEX_BUFFER``: An vertex index/element buffer.
838* ``PIPE_BIND_CONSTANT_BUFFER``: A buffer of shader constants.
839* ``PIPE_BIND_STREAM_OUTPUT``: A stream output buffer.
840* ``PIPE_BIND_CUSTOM``:
841* ``PIPE_BIND_SCANOUT``: A front color buffer or scanout buffer.
842* ``PIPE_BIND_SHARED``: A sharable buffer that can be given to another
843  process.
844* ``PIPE_BIND_GLOBAL``: A buffer that can be mapped into the global
845  address space of a compute program.
846* ``PIPE_BIND_SHADER_BUFFER``: A buffer without a format that can be bound
847  to a shader and can be used with load, store, and atomic instructions.
848* ``PIPE_BIND_SHADER_IMAGE``: A buffer or texture with a format that can be
849  bound to a shader and can be used with load, store, and atomic instructions.
850* ``PIPE_BIND_COMPUTE_RESOURCE``: A buffer or texture that can be
851  bound to the compute program as a shader resource.
852* ``PIPE_BIND_COMMAND_ARGS_BUFFER``: A buffer that may be sourced by the
853  GPU command processor. It can contain, for example, the arguments to
854  indirect draw calls.
855
856.. _pipe_usage:
857
858PIPE_USAGE_*
859^^^^^^^^^^^^
860
861The PIPE_USAGE enums are hints about the expected usage pattern of a resource.
862Note that drivers must always support read and write CPU access at any time
863no matter which hint they got.
864
865* ``PIPE_USAGE_DEFAULT``: Optimized for fast GPU access.
866* ``PIPE_USAGE_IMMUTABLE``: Optimized for fast GPU access and the resource is
867  not expected to be mapped or changed (even by the GPU) after the first upload.
868* ``PIPE_USAGE_DYNAMIC``: Expect frequent write-only CPU access. What is
869  uploaded is expected to be used at least several times by the GPU.
870* ``PIPE_USAGE_STREAM``: Expect frequent write-only CPU access. What is
871  uploaded is expected to be used only once by the GPU.
872* ``PIPE_USAGE_STAGING``: Optimized for fast CPU access.
873
874
875Methods
876-------
877
878XXX to-do
879
880get_name
881^^^^^^^^
882
883Returns an identifying name for the screen.
884
885The returned string should remain valid and immutable for the lifetime of
886pipe_screen.
887
888get_vendor
889^^^^^^^^^^
890
891Returns the screen vendor.
892
893The returned string should remain valid and immutable for the lifetime of
894pipe_screen.
895
896get_device_vendor
897^^^^^^^^^^^^^^^^^
898
899Returns the actual vendor of the device driving the screen
900(as opposed to the driver vendor).
901
902The returned string should remain valid and immutable for the lifetime of
903pipe_screen.
904
905.. _get_param:
906
907get_param
908^^^^^^^^^
909
910Get an integer/boolean screen parameter.
911
912**param** is one of the :ref:`PIPE_CAP` names.
913
914.. _get_paramf:
915
916get_paramf
917^^^^^^^^^^
918
919Get a floating-point screen parameter.
920
921**param** is one of the :ref:`PIPE_CAPF` names.
922
923context_create
924^^^^^^^^^^^^^^
925
926Create a pipe_context.
927
928**priv** is private data of the caller, which may be put to various
929unspecified uses, typically to do with implementing swapbuffers
930and/or front-buffer rendering.
931
932is_format_supported
933^^^^^^^^^^^^^^^^^^^
934
935Determine if a resource in the given format can be used in a specific manner.
936
937**format** the resource format
938
939**target** one of the PIPE_TEXTURE_x flags
940
941**sample_count** the number of samples. 0 and 1 mean no multisampling,
942the maximum allowed legal value is 32.
943
944**storage_sample_count** the number of storage samples. This must be <=
945sample_count. See the documentation of ``pipe_resource::nr_storage_samples``.
946
947**bindings** is a bitmask of :ref:`PIPE_BIND` flags.
948
949Returns TRUE if all usages can be satisfied.
950
951
952can_create_resource
953^^^^^^^^^^^^^^^^^^^
954
955Check if a resource can actually be created (but don't actually allocate any
956memory).  This is used to implement OpenGL's proxy textures.  Typically, a
957driver will simply check if the total size of the given resource is less than
958some limit.
959
960For PIPE_TEXTURE_CUBE, the pipe_resource::array_size field should be 6.
961
962
963.. _resource_create:
964
965resource_create
966^^^^^^^^^^^^^^^
967
968Create a new resource from a template.
969The following fields of the pipe_resource must be specified in the template:
970
971**target** one of the pipe_texture_target enums.
972Note that PIPE_BUFFER and PIPE_TEXTURE_X are not really fundamentally different.
973Modern APIs allow using buffers as shader resources.
974
975**format** one of the pipe_format enums.
976
977**width0** the width of the base mip level of the texture or size of the buffer.
978
979**height0** the height of the base mip level of the texture
980(1 for 1D or 1D array textures).
981
982**depth0** the depth of the base mip level of the texture
983(1 for everything else).
984
985**array_size** the array size for 1D and 2D array textures.
986For cube maps this must be 6, for other textures 1.
987
988**last_level** the last mip map level present.
989
990**nr_samples**: Number of samples determining quality, driving the rasterizer,
991shading, and framebuffer. It is the number of samples seen by the whole
992graphics pipeline. 0 and 1 specify a resource which isn't multisampled.
993
994**nr_storage_samples**: Only color buffers can set this lower than nr_samples.
995Multiple samples within a pixel can have the same color. ``nr_storage_samples``
996determines how many slots for different colors there are per pixel.
997If there are not enough slots to store all sample colors, some samples will
998have an undefined color (called "undefined samples").
999
1000The resolve blit behavior is driver-specific, but can be one of these two:
1001
10021. Only defined samples will be averaged. Undefined samples will be ignored.
10032. Undefined samples will be approximated by looking at surrounding defined
1004   samples (even in different pixels).
1005
1006Blits and MSAA texturing: If the sample being fetched is undefined, one of
1007the defined samples is returned instead.
1008
1009Sample shading (``set_min_samples``) will operate at a sample frequency that
1010is at most ``nr_storage_samples``. Greater ``min_samples`` values will be
1011replaced by ``nr_storage_samples``.
1012
1013**usage** one of the :ref:`PIPE_USAGE` flags.
1014
1015**bind** bitmask of the :ref:`PIPE_BIND` flags.
1016
1017**flags** bitmask of PIPE_RESOURCE_FLAG flags.
1018
1019**next**: Pointer to the next plane for resources that consist of multiple
1020memory planes.
1021
1022As a corollary, this mean resources for an image with multiple planes have
1023to be created starting from the highest plane.
1024
1025resource_changed
1026^^^^^^^^^^^^^^^^
1027
1028Mark a resource as changed so derived internal resources will be recreated
1029on next use.
1030
1031When importing external images that can't be directly used as texture sampler
1032source, internal copies may have to be created that the hardware can sample
1033from. When those resources are reimported, the image data may have changed, and
1034the previously derived internal resources must be invalidated to avoid sampling
1035from old copies.
1036
1037
1038
1039resource_destroy
1040^^^^^^^^^^^^^^^^
1041
1042Destroy a resource. A resource is destroyed if it has no more references.
1043
1044
1045
1046get_timestamp
1047^^^^^^^^^^^^^
1048
1049Query a timestamp in nanoseconds. The returned value should match
1050PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
1051wait for rendering to complete (which cannot be achieved with queries).
1052
1053
1054
1055get_driver_query_info
1056^^^^^^^^^^^^^^^^^^^^^
1057
1058Return a driver-specific query. If the **info** parameter is NULL,
1059the number of available queries is returned.  Otherwise, the driver
1060query at the specified **index** is returned in **info**.
1061The function returns non-zero on success.
1062The driver-specific query is described with the pipe_driver_query_info
1063structure.
1064
1065get_driver_query_group_info
1066^^^^^^^^^^^^^^^^^^^^^^^^^^^
1067
1068Return a driver-specific query group. If the **info** parameter is NULL,
1069the number of available groups is returned.  Otherwise, the driver
1070query group at the specified **index** is returned in **info**.
1071The function returns non-zero on success.
1072The driver-specific query group is described with the
1073pipe_driver_query_group_info structure.
1074
1075
1076
1077get_disk_shader_cache
1078^^^^^^^^^^^^^^^^^^^^^
1079
1080Returns a pointer to a driver-specific on-disk shader cache. If the driver
1081failed to create the cache or does not support an on-disk shader cache NULL is
1082returned. The callback itself may also be NULL if the driver doesn't support
1083an on-disk shader cache.
1084
1085
1086is_dmabuf_modifier_supported
1087^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1088
1089Query whether the driver supports a **modifier** in combination with a
1090**format**, and whether it is only supported with "external" texture targets.
1091If the combination is supported in any fashion, true is returned.  If the
1092**external_only** parameter is not NULL, the bool it points to is set to
1093false if non-external texture targets are supported with the specified modifier+
1094format, or true if only external texture targets are supported.
1095
1096
1097get_dmabuf_modifier_planes
1098^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1099
1100Query the number of planes required by the image layout specified by the
1101**modifier** and **format** parameters.  The value returned includes both planes
1102dictated by **format** and any additional planes required for driver-specific
1103auxiliary data necessary for the layout defined by **modifier**.
1104If the proc is NULL, no auxiliary planes are required for any layout supported by
1105**screen** and the number of planes can be derived directly from **format**.
1106
1107
1108Thread safety
1109-------------
1110
1111Screen methods are required to be thread safe. While gallium rendering
1112contexts are not required to be thread safe, it is required to be safe to use
1113different contexts created with the same screen in different threads without
1114locks. It is also required to be safe using screen methods in a thread, while
1115using one of its contexts in another (without locks).
1116