diff --git a/docs/envvars.rst b/docs/envvars.rst index 02fe920ec80..90f856566ea 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -1077,20 +1077,20 @@ Gallium environment variables .. envvar:: GALLIUM_TRACE - If set, this variable will cause the :ref:`trace` output to be written to the + If set, this variable will cause the trace output to be written to the specified file. Paths may be relative or absolute; relative paths are relative to the working directory. For example, setting it to "trace.xml" will cause the trace to be written to a file of the same name in the working directory. .. envvar:: GALLIUM_TRACE_TC - If enabled while :ref:`trace` is active, this variable specifies that the threaded context + If enabled while trace is active, this variable specifies that the threaded context should be traced for drivers which implement it. By default, the driver thread is traced, which will include any reordering of the command stream from threaded context. .. envvar:: GALLIUM_TRACE_TRIGGER - If set while :ref:`trace` is active, this variable specifies a filename to monitor. + If set while trace is active, this variable specifies a filename to monitor. Once the file exists (e.g., from the user running 'touch /path/to/file'), a single frame will be recorded into the trace output. Paths may be relative or absolute; relative paths are relative to the working directory. diff --git a/docs/gallium/cso/rasterizer.rst b/docs/gallium/cso/rasterizer.rst index 62e5a843bb1..11d886436aa 100644 --- a/docs/gallium/cso/rasterizer.rst +++ b/docs/gallium/cso/rasterizer.rst @@ -56,7 +56,7 @@ flatshade CONSTANT, LINEAR and PERSPECTIVE. The flatshade state is needed at clipping time to determine how to set the color of new vertices. - :ref:`Draw` can implement flat shading by copying the provoking vertex + Draw can implement flat shading by copying the provoking vertex color to all the other vertices in the primitive. flatshade_first @@ -80,7 +80,7 @@ Polygons 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 + (perhaps assisted by Draw) should be set up to use this state along with the front/back information to set the final vertex colors prior to rasterization. @@ -178,7 +178,7 @@ sprite_coord_enable always rasterized as quads). Any mismatch between these states should 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 Draw module but may also be implemented natively by GPUs or implemented with a geometry shader. @@ -187,7 +187,7 @@ sprite_coord_mode point sprites. For PIPE_SPRITE_COORD_LOWER_LEFT, the lower-left vertex will have coordinates (0,0,0,1). For PIPE_SPRITE_COORD_UPPER_LEFT, the upper-left vertex will have coordinates (0,0,0,1). - This state is used by :ref:`Draw` to generate texcoords. + This state is used by Draw to generate texcoords. point_quad_rasterization diff --git a/docs/gallium/distro.rst b/docs/gallium/distro.rst deleted file mode 100644 index 440b910d592..00000000000 --- a/docs/gallium/distro.rst +++ /dev/null @@ -1,182 +0,0 @@ -Distribution -============ - -Along with the interface definitions, the following drivers, Gallium frontends, -and auxiliary modules are shipped in the standard Gallium distribution. - -Drivers -------- - -Intel i915 -^^^^^^^^^^ - -Driver for Intel i915 and i945 chipsets. - -LLVM Softpipe -^^^^^^^^^^^^^ - -A version of :ref:`softpipe` that uses the Low-Level Virtual Machine to -dynamically generate optimized rasterizing pipelines. - -NVIDIA NV30 -^^^^^^^^^^^ - -Driver for the NVIDIA NV30 and NV40 families of GPUs. - -NVIDIA NV50 -^^^^^^^^^^^ - -Driver for the NVIDIA NV50 family of GPUs. - -NVIDIA NVC0 -^^^^^^^^^^^ - -Driver for the NVIDIA NVC0 / Fermi family of GPUs. - -VMware SVGA -^^^^^^^^^^^ - -Driver for VMware virtualized guest operating system graphics processing. - -ATI R300 -^^^^^^^^ - -Driver for the ATI/AMD R300, R400, and R500 families of GPUs. - -ATI/AMD R600 -^^^^^^^^^^^^ - -Driver for the ATI/AMD R600, R700, Evergreen and Northern Islands families of GPUs. - -AMD RadeonSI -^^^^^^^^^^^^ - -Driver for the AMD Southern Islands family of GPUs. - -Freedreno -^^^^^^^^^ - -Driver for Qualcomm Adreno 2xx, 3xx, and 4xx series of GPUs. - -.. _softpipe: - -Softpipe -^^^^^^^^ - -Reference software rasterizer. Slow but accurate. - -.. _trace: - -Trace -^^^^^ - -Wrapper driver. Trace dumps an XML record of the calls made to the -:ref:`Context` and :ref:`Screen` objects that it wraps. - -Gallium frontends ------------------ - -.. _dri: - -Direct Rendering Infrastructure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Tracker that implements the client-side DRI protocol, for providing direct -acceleration services to X11 servers with the DRI extension. Supports DRI1 -and DRI2. Only GL is supported. - -GLX -^^^ - -MesaGL -^^^^^^ - -The Gallium frontend implementing a GL state machine. Not usable as -a standalone frontend; Mesa should be built with another Gallium frontend, -such as :ref:`DRI` or EGL. - -Nine -^^^^ - -The Gallium frontend implements the Direct3D 9 API. - -VDPAU -^^^^^ - -Tracker for Video Decode and Presentation API for Unix. - -WGL -^^^ - -Xorg DDX -^^^^^^^^ - -Tracker for Xorg X11 servers. Provides device-dependent -modesetting and acceleration as a DDX driver. - -Auxiliary ---------- - -OS -^^ - -The OS module contains the abstractions for basic operating system services: - -* memory allocation -* simple message logging -* obtaining run-time configuration option -* threading primitives - -This is the bare minimum required to port Gallium to a new platform. - -The OS module already provides the implementations of these abstractions for -the most common platforms. When targeting an embedded platform no -implementation will be provided -- these must be provided separately. - -CSO Cache -^^^^^^^^^ - -The CSO cache is used to accelerate preparation of state by saving -driver-specific state structures for later use. - -.. _draw: - -Draw -^^^^ - -Draw is a software :term:`TCL` pipeline for hardware that lacks vertex shaders -or other essential parts of pre-rasterization vertex preparation. - -Gallivm -^^^^^^^ - -Indices -^^^^^^^ - -Indices provides tools for translating or generating element indices for -use with element-based rendering. - -Pipe Buffer Managers -^^^^^^^^^^^^^^^^^^^^ - -Each of these managers provides various services to drivers that are not -fully utilizing a memory manager. - -Remote Debugger -^^^^^^^^^^^^^^^ - -Runtime Assembly Emission -^^^^^^^^^^^^^^^^^^^^^^^^^ - -TGSI -^^^^ - -The TGSI auxiliary module provides basic utilities for manipulating TGSI -streams. - -Translate -^^^^^^^^^ - -Util -^^^^ - diff --git a/docs/gallium/index.rst b/docs/gallium/index.rst index 20cf1594679..207bd3aae8f 100644 --- a/docs/gallium/index.rst +++ b/docs/gallium/index.rst @@ -15,7 +15,6 @@ Contents: context cso buffermapping - distro postprocess glossary