xserver/exa/exa.h

9  * the above copyright notice appear in all copies and that both that
10  * copyright notice and this permission notice appear in supporting
11  * documentation, and that the name of copyright holders not be used in
19  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
23  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
71     ExaOffscreenArea *prev;     /* Double-linked list for defragmentation */
77  * fllled in by drivers.
99      * In XFree86 DDX drivers, this is probably:
100      *   (pScrn->displayWidth * cpp * pScrn->virtualY)
105      * memorySize is the length (in bytes) of framebuffer memory beginning
109      * (memoryBase + offScreenBase), with a length of (memorySize -
112      * In XFree86 DDX drivers, this is probably (pScrn->videoRam * 1024)
131      * For 3D hardware, Composite acceleration often requires that source and
132      * mask pixmaps (textures) have a power-of-two pitch, which can be demanded
143      * The flags in clude EXA_OFFSCREEN_PIXMAPS, EXA_OFFSCREEN_ALIGN_POT, and
152      * in the X direction from the origin of a pixmap.
159      * in the Y direction from the origin of a pixmap.
181      * graphics functions listed in X.h, and typically maps to a similar
182      * single-byte "ROP" setting in all hardware.  The planemask controls
185      * foreground color referred to in ROP descriptions.
187      * Note that many drivers will need to store some of the data in the driver
191      * reason.  Failure results in a fallback to software rendering.
197      * Solid() performs a solid fill set up in the last PrepareSolid() call.
206      * area from (x1,y1) to (x2,y2) in pPixmap.  Note that the coordinates are
207      * in the coordinate space of the destination pixmap, so the driver will
250      * is to deal with self-overlapping copies when pSrcPixmap == pDstPixmap.
255      * graphics functions listed in X.h, and typically maps to a similar
256      * single-byte "ROP" setting in all hardware.  The planemask controls which
260      * Note that many drivers will need to store some of the data in the driver
264      * reason.  Failure results in a fallback to software rendering.
271      * Copy() performs a copy set up in the last PrepareCopy call.
282      * rectangle from (srcX, srcY) to (srcX + width, srcY + width) in the source
283      * pixmap to the same-sized rectangle at (dstX, dstY) in the destination
284      * pixmap.  Those rectangles may overlap in memory, if
286      * pSrcPixmap as an argument -- if it's needed in this function, it should
287      * be stored in the driver private during PrepareCopy().  As with Solid(),
288      * the coordinates are in the coordinate space of each pixmap, so the driver
313     /** @name Composite
317      * CheckComposite() checks to see if a composite operation could be
336      * will have in accelerating Composite operations.
346      * PrepareComposite() sets up the driver for doing a Composite operation
347      * described in the Render extension protocol spec.
357      * This call should set up the driver for doing a series of Composite
358      * operations, as described in the Render protocol spec, with the given
365      * - The Picture structures will always have a valid pDrawable.
366      * - The Picture structures will never have alphaMap set.
367      * - The mask Picture (and therefore pMask) may be NULL, in which case the
368      *   operation is simply src OP dst instead of src IN mask OP dst, and
370      * - pMarkPicture may have componentAlpha set, which greatly changes
371      *   the behavior of the Composite operation.  componentAlpha has no effect
373      * - The source and mask Pictures may have a transformation set
374      *   (Picture->transform != NULL), which means that the source coordinates
375      *   should be transformed by that transformation, resulting in scaling,
379      * - The source and mask pictures may have a filter set.  PictFilterNearest
380      *   and PictFilterBilinear are defined in the Render protocol, but others
384      * - The source and mask Pictures may have repeating set, which must be
389      * non-power-of-two pitches, you should set #EXA_OFFSCREEN_ALIGN_POT.
391      * Note that many drivers will need to store some of the data in the driver
396      * of cairo applications.  Failure results in a fallback to software
406      * Composite() performs a Composite operation set up in the last
419      * Performs the Composite operation set up by the last PrepareComposite()
421      * in the destination Pixmap.  Note that if a transformation was set on
429     void (*Composite) (PixmapPtr pDst,  member
436      * DoneComposite() finishes a set of Composite operations.
441      * Composite() calls following a successful PrepareComposite().  This allows
459      * @param src_pitch pitch (in bytes) of the lines of source data.
461      * UploadToScreen() copies data in system memory beginning at src (with
468      * to call exaMarkSync().  This is in contrast to most other acceleration
469      * calls in EXA.
471      * UploadToScreen() can aid in pixmap migration, but is most important for
476      * indicates that EXA should fall back to doing the upload in software.
478      * UploadToScreen() is not required, but is recommended if Composite
500      * @param dst_pitch pitch (in bytes) of the lines of destination data.
502      * DownloadFromScreen() copies data from offscreen memory in pSrc from
505      * using scatter-gather DMA, supported by a DRM call, or by blitting to AGP
508      * exaMarkSync() if DownloadFromScreen() was asynchronous.  This is in
509      * contrast to most other acceleration calls in EXA.
511      * DownloadFromScreen() can aid in the largest bottleneck in pixmap
517      * indicates that EXA should fall back to doing the download in software.
527      * returning an driver-defined integer marker which could be requested for
528      * synchronization to later in WaitMarker().  This might be used in the
530      * data with the CPU, but is not important in the current incarnation of
550      * synchronized, resulting in excessive WaitMarker() calls.
572      * a small, statically-allocated space to maintain state for PrepareAccess()
573      * and FinishAccess() in.  Note that PrepareAccess() is only called once per
581      * wishes to fail in PrepareAccess().  PrepareAccess() must not fail when
610      * @return TRUE if the given drawable is in framebuffer memory.
612      * exaPixmapHasGpuCopy() is used to determine if a pixmap is in offscreen
640 	 * separate alpha maps with Composite operations.
652      * that has a pitch (in pixels) beyond maxPitchPixels.
654      * Setting this field is optional -- if your hardware doesn't have
655      * a pitch limitation in pixels, don't set this. If neither this value
667      * that has a pitch (in bytes) beyond maxPitchBytes.
669      * Setting this field is optional -- if your hardware doesn't have
670      * a pitch limitation in bytes, don't set this.
682      * Returning a pixmap with non-NULL devPrivate.ptr implies a pixmap which is
714  * to have a power-of-two pitch.
720  * support copies that are (left-to-right, top-to-bottom) or
721  * (right-to-left, bottom-to-top).
733  * EXA_PREPARE_AUX* indices in the Prepare/FinishAccess hooks. If there are no
757 /* in exa.c */
782 /* in exa_offscreen.c */
801 /* in exa.c */
808 /* in exa_unaccel.c */
813  * Returns TRUE if the given planemask covers all the significant bits in the
817 	(((_pm) & FbFullMask((_pDrawable)->depth)) == \
818 	 FbFullMask((_pDrawable)->depth))