OpenHarmony/third_party_mesa3d
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/gallium: use definition-lists for member-lists

Browse Source 
For some reason, we started with headings for some of these, and then
switched to definition lists midway though.

Let's stick with the definition lists, as that looks a bit more tidy.

Reviewed-by: Eric Engestrom <eric@igalia.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/19460>
This commit is contained in:
Erik Faye-Lund
2022-10-19 14:13:56 +02:00
committed by Marge Bot
parent e2ac43ddad
commit c85a05a685
2 changed files with 89 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/gallium/cso/blend.rst
View File

@@ -62,25 +62,17 @@ Members
These members affect all render targets. These members affect all render targets.
dither dither
%%%%%% Whether dithering is enabled.
Whether dithering is enabled. .. note::
Dithering is completely implementation-dependent. It may be ignored by
.. note:: drivers for any reason, and some render targets may always or never be
Dithering is completely implementation-dependent. It may be ignored by dithered depending on their format or usage flags.
drivers for any reason, and some render targets may always or never be
dithered depending on their format or usage flags.
logicop_enable logicop_enable
%%%%%%%%%%%%%% Whether the blender should perform a logicop instead of blending.
Whether the blender should perform a logicop instead of blending.
logicop_func logicop_func
%%%%%%%%%%%% The logicop to use. One of ``PIPE_LOGICOP``.
The logicop to use. One of ``PIPE_LOGICOP``.
independent_blend_enable independent_blend_enable
If enabled, blend state is different for each render target, and If enabled, blend state is different for each render target, and
for each render target set in the respective member of the rt array. for each render target set in the respective member of the rt array.

178
docs/gallium/cso/rasterizer.rst
View File

@@ -8,91 +8,82 @@ Attributes include polygon culling state, line width, line stipple,
multisample state, scissoring and flat/smooth shading. multisample state, scissoring and flat/smooth shading.
Linkage Linkage
-------
clamp_vertex_color clamp_vertex_color
^^^^^^^^^^^^^^^^^^ If set, TGSI_SEMANTIC_COLOR registers are clamped to the [0, 1] range after
the execution of the vertex shader, before being passed to the geometry
shader or fragment shader.
If set, TGSI_SEMANTIC_COLOR registers are clamped to the [0, 1] range after OpenGL: glClampColor(GL_CLAMP_VERTEX_COLOR) in GL 3.0 or GL_ARB_color_buffer_float
the execution of the vertex shader, before being passed to the geometry
shader or fragment shader.
OpenGL: glClampColor(GL_CLAMP_VERTEX_COLOR) in GL 3.0 or GL_ARB_color_buffer_float D3D11: seems always disabled
D3D11: seems always disabled Note the PIPE_CAP_VERTEX_COLOR_CLAMPED query indicates whether or not the
driver supports this control. If it's not supported, gallium frontends may
Note the PIPE_CAP_VERTEX_COLOR_CLAMPED query indicates whether or not the have to insert extra clamping code.
driver supports this control. If it's not supported, gallium frontends may
have to insert extra clamping code.
clamp_fragment_color clamp_fragment_color
^^^^^^^^^^^^^^^^^^^^ Controls whether TGSI_SEMANTIC_COLOR outputs of the fragment shader
are clamped to [0, 1].
Controls whether TGSI_SEMANTIC_COLOR outputs of the fragment shader OpenGL: glClampColor(GL_CLAMP_FRAGMENT_COLOR) in GL 3.0 or ARB_color_buffer_float
are clamped to [0, 1].
OpenGL: glClampColor(GL_CLAMP_FRAGMENT_COLOR) in GL 3.0 or ARB_color_buffer_float D3D11: seems always disabled
D3D11: seems always disabled Note the PIPE_CAP_FRAGMENT_COLOR_CLAMPED query indicates whether or not the
driver supports this control. If it's not supported, gallium frontends may
Note the PIPE_CAP_FRAGMENT_COLOR_CLAMPED query indicates whether or not the have to insert extra clamping code.
driver supports this control. If it's not supported, gallium frontends may
have to insert extra clamping code.
Shading Shading
------- -------
flatshade flatshade
^^^^^^^^^ If set, the provoking vertex of each polygon is used to determine the color
of the entire polygon. If not set, fragment colors will be interpolated
between the vertex colors.
If set, the provoking vertex of each polygon is used to determine the color The actual interpolated shading algorithm is obviously
of the entire polygon. If not set, fragment colors will be interpolated implementation-dependent, but will usually be Gouraud for most hardware.
between the vertex colors.
The actual interpolated shading algorithm is obviously .. note::
implementation-dependent, but will usually be Gouraud for most hardware.
.. note:: This is separate from the fragment shader input attributes
CONSTANT, LINEAR and PERSPECTIVE. The flatshade state is needed at
clipping time to determine how to set the color of new vertices.
This is separate from the fragment shader input attributes :ref:`Draw` can implement flat shading by copying the provoking vertex
CONSTANT, LINEAR and PERSPECTIVE. The flatshade state is needed at color to all the other vertices in the primitive.
clipping time to determine how to set the color of new vertices.
:ref:`Draw` can implement flat shading by copying the provoking vertex
color to all the other vertices in the primitive.
flatshade_first flatshade_first
^^^^^^^^^^^^^^^ Whether the first vertex should be the provoking vertex, for most primitives.
If not set, the last vertex is the provoking vertex.
Whether the first vertex should be the provoking vertex, for most primitives. There are a few important exceptions to the specification of this rule.
If not set, the last vertex is the provoking vertex.
There are a few important exceptions to the specification of this rule. * ``PIPE_PRIMITIVE_POLYGON``: The provoking vertex is always the first
vertex. If the caller wishes to change the provoking vertex, they merely
* ``PIPE_PRIMITIVE_POLYGON``: The provoking vertex is always the first need to rotate the vertices themselves.
vertex. If the caller wishes to change the provoking vertex, they merely * ``PIPE_PRIMITIVE_QUAD``, ``PIPE_PRIMITIVE_QUAD_STRIP``: The option only has
need to rotate the vertices themselves. an effect if ``PIPE_CAP_QUADS_FOLLOW_PROVOKING_VERTEX_CONVENTION`` is true.
* ``PIPE_PRIMITIVE_QUAD``, ``PIPE_PRIMITIVE_QUAD_STRIP``: The option only has If it is not, the provoking vertex is always the last vertex.
an effect if ``PIPE_CAP_QUADS_FOLLOW_PROVOKING_VERTEX_CONVENTION`` is true. * ``PIPE_PRIMITIVE_TRIANGLE_FAN``: When set, the provoking vertex is the
If it is not, the provoking vertex is always the last vertex. second vertex, not the first. This permits each segment of the fan to have
* ``PIPE_PRIMITIVE_TRIANGLE_FAN``: When set, the provoking vertex is the a different color.
second vertex, not the first. This permits each segment of the fan to have
a different color.
Polygons Polygons
-------- --------
light_twoside light_twoside
^^^^^^^^^^^^^ If set, there are per-vertex back-facing colors. The hardware
(perhaps assisted by :ref:`Draw`) should be set up to use this state
along with the front/back information to set the final vertex colors
prior to rasterization.
If set, there are per-vertex back-facing colors. The hardware The frontface vertex shader color output is marked with TGSI semantic
(perhaps assisted by :ref:`Draw`) should be set up to use this state COLOR[0], and backface COLOR[1].
along with the front/back information to set the final vertex colors
prior to rasterization.
The frontface vertex shader color output is marked with TGSI semantic
COLOR[0], and backface COLOR[1].
front_ccw front_ccw
Indicates whether the window order of front-facing polygons is Indicates whether the window order of front-facing polygons is
@@ -164,65 +155,60 @@ Points
------ ------
sprite_coord_enable sprite_coord_enable
^^^^^^^^^^^^^^^^^^^ The effect of this state depends on PIPE_CAP_TGSI_TEXCOORD !
The effect of this state depends on PIPE_CAP_TGSI_TEXCOORD !
Controls automatic texture coordinate generation for rendering sprite points. Controls automatic texture coordinate generation for rendering sprite points.
If PIPE_CAP_TGSI_TEXCOORD is false: If PIPE_CAP_TGSI_TEXCOORD is false:
When bit k in the sprite_coord_enable bitfield is set, then generic When bit k in the sprite_coord_enable bitfield is set, then generic
input k to the fragment shader will get an automatically computed input k to the fragment shader will get an automatically computed
texture coordinate. texture coordinate.
If PIPE_CAP_TGSI_TEXCOORD is true: If PIPE_CAP_TGSI_TEXCOORD is true:
The bitfield refers to inputs with TEXCOORD semantic instead of generic inputs. The bitfield refers to inputs with TEXCOORD semantic instead of generic inputs.
The texture coordinate will be of the form (s, t, 0, 1) where s varies The texture coordinate will be of the form (s, t, 0, 1) where s varies
from 0 to 1 from left to right while t varies from 0 to 1 according to from 0 to 1 from left to right while t varies from 0 to 1 according to
the state of 'sprite_coord_mode' (see below). the state of 'sprite_coord_mode' (see below).
If any bit is set, then point_smooth MUST be disabled (there are no If any bit is set, then point_smooth MUST be disabled (there are no
round sprites) and point_quad_rasterization MUST be true (sprites are round sprites) and point_quad_rasterization MUST be true (sprites are
always rasterized as quads). Any mismatch between these states should always rasterized as quads). Any mismatch between these states should
be considered a bug in the gallium frontend. be considered a bug in the gallium frontend.
This feature is implemented in the :ref:`Draw` module but may also be This feature is implemented in the :ref:`Draw` module but may also be
implemented natively by GPUs or implemented with a geometry shader. implemented natively by GPUs or implemented with a geometry shader.
sprite_coord_mode sprite_coord_mode
^^^^^^^^^^^^^^^^^ Specifies how the value for each shader output should be computed when drawing
point sprites. For PIPE_SPRITE_COORD_LOWER_LEFT, the lower-left vertex will
Specifies how the value for each shader output should be computed when drawing have coordinates (0,0,0,1). For PIPE_SPRITE_COORD_UPPER_LEFT, the upper-left
point sprites. For PIPE_SPRITE_COORD_LOWER_LEFT, the lower-left vertex will vertex will have coordinates (0,0,0,1).
have coordinates (0,0,0,1). For PIPE_SPRITE_COORD_UPPER_LEFT, the upper-left This state is used by :ref:`Draw` to generate texcoords.
vertex will have coordinates (0,0,0,1).
This state is used by :ref:`Draw` to generate texcoords.
point_quad_rasterization point_quad_rasterization
^^^^^^^^^^^^^^^^^^^^^^^^ Determines if points should be rasterized according to quad or point
rasterization rules.
Determines if points should be rasterized according to quad or point (Legacy-only) OpenGL actually has quite different rasterization rules
rasterization rules. for points and point sprites - hence this indicates if points should be
rasterized as points or according to point sprite (which decomposes them
into quads, basically) rules. Newer GL versions no longer support the old
point rules at all.
(Legacy-only) OpenGL actually has quite different rasterization rules Additionally Direct3D will always use quad rasterization rules for
for points and point sprites - hence this indicates if points should be points, regardless of whether point sprites are enabled or not.
rasterized as points or according to point sprite (which decomposes them
into quads, basically) rules. Newer GL versions no longer support the old
point rules at all.
Additionally Direct3D will always use quad rasterization rules for If this state is enabled, point smoothing and antialiasing are
points, regardless of whether point sprites are enabled or not. disabled. If it is disabled, point sprite coordinates are not
generated.
If this state is enabled, point smoothing and antialiasing are .. note::
disabled. If it is disabled, point sprite coordinates are not
generated.
.. note:: Some renderers always internally translate points into quads; this state
still affects those renderers by overriding other rasterization state.
Some renderers always internally translate points into quads; this state
still affects those renderers by overriding other rasterization state.
point_tri_clip point_tri_clip
Determines if clipping of points should happen after they are converted Determines if clipping of points should happen after they are converted