b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * $XFree86: xc/programs/Xserver/miext/layer/layer.h,v 1.4 2001/08/01 00:44:58 tsi Exp $
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Copyright © 2001 Keith Packard, member of The XFree86 Project, Inc.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Permission to use, copy, modify, distribute, and sell this software and its
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * documentation for any purpose is hereby granted without fee, provided that
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * the above copyright notice appear in all copies and that both that
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * copyright notice and this permission notice appear in supporting
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * documentation, and that the name of Keith Packard not be used in
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * advertising or publicity pertaining to distribution of the software without
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * specific, written prior permission. Keith Packard makes no
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * representations about the suitability of this software for any purpose. It
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * is provided "as is" without express or implied warranty.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * PERFORMANCE OF THIS SOFTWARE.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#ifdef HAVE_DIX_CONFIG_H
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <dix-config.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#endif
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#ifndef _LAYER_H_
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define _LAYER_H_
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <shadow.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define LAYER_FB 0
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define LAYER_SHADOW 1
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _LayerKind *LayerKindPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _LayerWin *LayerWinPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _LayerList *LayerListPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _LayerGC *LayerGCPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _Layer *LayerPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _LayerScreen *LayerScreenPtr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * We'll try to work without a list of windows in each layer
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * for now, this will make computing bounding boxes for each
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * layer rather expensive, so that may need to change at some point.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define LAYER_SCREEN_PIXMAP ((PixmapPtr) 1)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct _Layer {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LayerPtr pNext; /* a list of all layers for this screen */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync LayerKindPtr pKind; /* characteristics of this layer */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int refcnt; /* reference count, layer is freed when zero */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int windows; /* number of windows, free pixmap when zero */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int depth; /* window depth in this layer */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync PixmapPtr pPixmap; /* pixmap for this layer (may be frame buffer) */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync Bool freePixmap; /* whether to free this pixmap when done */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync RegionRec region; /* valid set of pPixmap for drawing */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ShadowUpdateProc update; /* for shadow layers, update/window/closure values */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ShadowWindowProc window;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int randr;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync void *closure;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync} LayerRec;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Call this before wrapping stuff for acceleration, it
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * gives layer pointers to the raw frame buffer functions
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncBool
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerStartInit (ScreenPtr pScreen);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Initialize wrappers for each acceleration type and
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * call this function, it will move the needed functions
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * into a new LayerKind and replace them with the generic
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * functions.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncint
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerNewKind (ScreenPtr pScreen);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Finally, call this function and layer
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * will wrap the screen functions and prepare for execution
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncBool
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerFinishInit (ScreenPtr pScreen);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * At any point after LayerStartInit, a new layer can be created.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerPtr
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerCreate (ScreenPtr pScreen,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int kind,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int depth,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync PixmapPtr pPixmap,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ShadowUpdateProc update,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync ShadowWindowProc window,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int randr,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync void *closure);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Create a layer pixmap
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncBool
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerCreatePixmap (ScreenPtr pScreen, LayerPtr pLayer);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Change a layer pixmap
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerSetPixmap (ScreenPtr pScreen, LayerPtr pLayer, PixmapPtr pPixmap);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Destroy a layer pixmap
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerDestroyPixmap (ScreenPtr pScreen, LayerPtr pLayer);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Change a layer kind
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerSetKind (ScreenPtr pScreen, LayerPtr pLayer, int kind);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Destroy a layer. The layer must not contain any windows.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerDestroy (ScreenPtr pScreen, LayerPtr layer);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Add a window to a layer
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncBool
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerWindowAdd (ScreenPtr pScreen, LayerPtr pLayer, WindowPtr pWin);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Remove a window from a layer
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncvoid
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncLayerWindowRemove (ScreenPtr pScreen, LayerPtr pLayer, WindowPtr pWin);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#endif /* _LAYER_H_ */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync