src/gallium/frontends/xa/README

   1 /**********************************************************
   2  * Copyright 2009-2011 VMware, Inc. All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use, copy,
   8  * modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  *
  24  *********************************************************
  25  * Authors:
  26  * Zack Rusin <zackr-at-vmware-dot-com>
  27  * Thomas Hellstrom <thellstrom-at-vmware-dot-com>
  28  */
  29
  30 The XA gallium frontend is intended as a versioned interface to gallium for
  31 xorg driver writers. Initially it's mostly based on Zack Rusin's
  32 composite / video work for the Xorg gallium frontend.
  33
  34 The motivation behind this gallium frontend is that the Xorg gallium frontend has
  35 a number of interfaces to work with:
  36
  37 1) The Xorg sdk (versioned)
  38 2) Gallium3D (not versioned)
  39 3) KMS modesetting (versioned)
  40 4) Driver-private (hopefully versioned)
  41
  42 Since Gallium3D is not versioned, the Xorg gallium frontend needs to be compiled
  43 with Gallium, but it's really beneficial to be able to compile xorg drivers
  44 standalone.
  45
  46 Therefore the xa gallium frontend is intended to supply the following
  47 functionality:
  48
  49 1) Versioning.
  50 2) Surface functionality (creation and copying for a basic dri2 implementation)
  51 3) YUV blits for textured Xv.
  52 4) Solid fills without ROP functionality.
  53 5) Copies with format conversion and - reinterpretation but without ROP
  54 6) Xrender- type compositing for general acceleration.
  55
  56
  57 The first user will be the vmwgfx xorg driver. When there are more users,
  58 we need to be able to load the appropriate gallium pipe driver, and we
  59 should investigate sharing the loadig mechanism with the EGL gallium frontend.
  60
  61 IMPORTANT:
  62 Version compatibilities:
  63 While this library remains OUTSIDE any mesa release branch,
  64 and the major version number is still 0. Any minor bump should be viewed as
  65 an incompatibility event, and any user of this library should test for that
  66 and refuse to use the library if minor versions differ.
  67 As soon as the library enters a mesa release branch, if not earlier, major
  68 will be bumped to 1, and normal incompatibility rules (major bump)
  69 will be followed.
  70 It is allowed to add function interfaces while only bumping minor. Any
  71 user that uses these function interfaces must therefore use lazy symbol
  72 lookups and test minor for compatibility before using such a function.