diff options
Diffstat (limited to 'nx-X11/programs/Xserver/miext/rootless/rootless.h')
| -rw-r--r-- | nx-X11/programs/Xserver/miext/rootless/rootless.h | 436 |
1 files changed, 0 insertions, 436 deletions
diff --git a/nx-X11/programs/Xserver/miext/rootless/rootless.h b/nx-X11/programs/Xserver/miext/rootless/rootless.h deleted file mode 100644 index dec0e2c64..000000000 --- a/nx-X11/programs/Xserver/miext/rootless/rootless.h +++ /dev/null @@ -1,436 +0,0 @@ -/* - * External interface to generic rootless mode - */ -/* - * Copyright (c) 2001 Greg Parker. All Rights Reserved. - * Copyright (c) 2002-2003 Torrey T. Lyons. All Rights Reserved. - * - * Permission is hereby granted, free of charge, to any person obtaining a - * copy of this software and associated documentation files (the "Software"), - * to deal in the Software without restriction, including without limitation - * the rights to use, copy, modify, merge, publish, distribute, sublicense, - * and/or sell copies of the Software, and to permit persons to whom the - * Software is furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL - * THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR - * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, - * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - * DEALINGS IN THE SOFTWARE. - * - * Except as contained in this notice, the name(s) of the above copyright - * holders shall not be used in advertising or otherwise to promote the sale, - * use or other dealings in this Software without prior written authorization. - */ -/* $XFree86: xc/programs/Xserver/miext/rootless/rootless.h,v 1.7 2004/07/02 01:30:33 torrey Exp $ */ - -#ifdef HAVE_DIX_CONFIG_H -#include <dix-config.h> -#endif - -#ifndef _ROOTLESS_H -#define _ROOTLESS_H - -#include "rootlessConfig.h" -#include "mi.h" -#include "gcstruct.h" - -/* - Each top-level rootless window has a one-to-one correspondence to a physical - on-screen window. The physical window is refered to as a "frame". - */ - -typedef void * RootlessFrameID; - -/* - * RootlessWindowRec - * This structure stores the per-frame data used by the rootless code. - * Each top-level X window has one RootlessWindowRec associated with it. - */ -typedef struct _RootlessWindowRec { - // Position and size includes the window border - // Position is in per-screen coordinates - int x, y; - unsigned int width, height; - unsigned int borderWidth; - - RootlessFrameID wid; // implementation specific frame id - WindowPtr win; // underlying X window - - // Valid only when drawing (ie. is_drawing is set) - char *pixelData; - int bytesPerRow; - - PixmapPtr pixmap; - PixmapPtr oldPixmap; - -#ifdef ROOTLESS_TRACK_DAMAGE - RegionRec damage; -#endif - - unsigned int is_drawing :1; // Currently drawing? - unsigned int is_reorder_pending :1; -} RootlessWindowRec, *RootlessWindowPtr; - - -/* Offset for screen-local to global coordinate transforms */ -#ifdef ROOTLESS_GLOBAL_COORDS -extern int rootlessGlobalOffsetX; -extern int rootlessGlobalOffsetY; -#endif - -/* The minimum number of bytes or pixels for which to use the - implementation's accelerated functions. */ -extern unsigned int rootless_CopyBytes_threshold; -extern unsigned int rootless_FillBytes_threshold; -extern unsigned int rootless_CompositePixels_threshold; -extern unsigned int rootless_CopyWindow_threshold; - -/* Operations used by CompositePixels */ -enum rl_composite_op_enum { - RL_COMPOSITE_SRC = 0, - RL_COMPOSITE_OVER, -}; - -/* Data formats for depth field and composite functions */ -enum rl_depth_enum { - RL_DEPTH_NIL = 0, /* null source when compositing */ - RL_DEPTH_ARGB8888, - RL_DEPTH_RGB555, - RL_DEPTH_A8, /* for masks when compositing */ - RL_DEPTH_INDEX8, -}; - -/* Macro to form the composite function for CompositePixels */ -#define RL_COMPOSITE_FUNCTION(op, src_depth, mask_depth, dest_depth) \ - (((op) << 24) | ((src_depth) << 16) \ - | ((mask_depth) << 8) | ((dest_depth) << 0)) - -/* Gravity for window contents during resizing */ -enum rl_gravity_enum { - RL_GRAVITY_NONE = 0, /* no gravity, fill everything */ - RL_GRAVITY_NORTH_WEST = 1, /* anchor to top-left corner */ - RL_GRAVITY_NORTH_EAST = 2, /* anchor to top-right corner */ - RL_GRAVITY_SOUTH_EAST = 3, /* anchor to bottom-right corner */ - RL_GRAVITY_SOUTH_WEST = 4, /* anchor to bottom-left corner */ -}; - - -/*------------------------------------------ - Rootless Implementation Functions - ------------------------------------------*/ - -/* - * Create a new frame. - * The frame is created unmapped. - * - * pFrame RootlessWindowPtr for this frame should be completely - * initialized before calling except for pFrame->wid, which - * is set by this function. - * pScreen Screen on which to place the new frame - * newX, newY Position of the frame. These will be identical to pFrame-x, - * pFrame->y unless ROOTLESS_GLOBAL_COORDS is set. - * pNewShape Shape for the frame (in frame-local coordinates). NULL for - * unshaped frames. - */ -typedef Bool (*RootlessCreateFrameProc) - (RootlessWindowPtr pFrame, ScreenPtr pScreen, int newX, int newY, - RegionPtr pNewShape); - -/* - * Destroy a frame. - * Drawing is stopped and all updates are flushed before this is called. - * - * wid Frame id - */ -typedef void (*RootlessDestroyFrameProc) - (RootlessFrameID wid); - -/* - * Move a frame on screen. - * Drawing is stopped and all updates are flushed before this is called. - * - * wid Frame id - * pScreen Screen to move the new frame to - * newX, newY New position of the frame - */ -typedef void (*RootlessMoveFrameProc) - (RootlessFrameID wid, ScreenPtr pScreen, int newX, int newY); - -/* - * Resize and move a frame. - * Drawing is stopped and all updates are flushed before this is called. - * - * wid Frame id - * pScreen Screen to move the new frame to - * newX, newY New position of the frame - * newW, newH New size of the frame - * gravity Gravity for window contents (rl_gravity_enum). This is always - * RL_GRAVITY_NONE unless ROOTLESS_RESIZE_GRAVITY is set. - */ -typedef void (*RootlessResizeFrameProc) - (RootlessFrameID wid, ScreenPtr pScreen, - int newX, int newY, unsigned int newW, unsigned int newH, - unsigned int gravity); - -/* - * Change frame ordering (AKA stacking, layering). - * Drawing is stopped before this is called. Unmapped frames are mapped by - * setting their ordering. - * - * wid Frame id - * nextWid Frame id of frame that is now above this one or NULL if this - * frame is at the top. - */ -typedef void (*RootlessRestackFrameProc) - (RootlessFrameID wid, RootlessFrameID nextWid); - -/* - * Change frame's shape. - * Drawing is stopped before this is called. - * - * wid Frame id - * pNewShape New shape for the frame (in frame-local coordinates) - * or NULL if now unshaped. - */ -typedef void (*RootlessReshapeFrameProc) - (RootlessFrameID wid, RegionPtr pNewShape); - -/* - * Unmap a frame. - * - * wid Frame id - */ -typedef void (*RootlessUnmapFrameProc) - (RootlessFrameID wid); - -/* - * Start drawing to a frame. - * Prepare a frame for direct access to its backing buffer. - * - * wid Frame id - * pixelData Address of the backing buffer (returned) - * bytesPerRow Width in bytes of the backing buffer (returned) - */ -typedef void (*RootlessStartDrawingProc) - (RootlessFrameID wid, char **pixelData, int *bytesPerRow); - -/* - * Stop drawing to a frame. - * No drawing to the frame's backing buffer will occur until drawing - * is started again. - * - * wid Frame id - * flush Flush drawing updates for this frame to the screen. This - * will always be FALSE if ROOTLESS_TRACK_DAMAGE is set. - */ -typedef void (*RootlessStopDrawingProc) - (RootlessFrameID wid, Bool flush); - -/* - * Flush drawing updates to the screen. - * Drawing is stopped before this is called. - * - * wid Frame id - * pDamage Region containing all the changed pixels in frame-lcoal - * coordinates. This is clipped to the window's clip. This - * will be NULL if ROOTLESS_TRACK_DAMAGE is not set. - */ -typedef void (*RootlessUpdateRegionProc) - (RootlessFrameID wid, RegionPtr pDamage); - -/* - * Mark damaged rectangles as requiring redisplay to screen. - * This will only be called if ROOTLESS_TRACK_DAMAGE is not set. - * - * wid Frame id - * nrects Number of damaged rectangles - * rects Array of damaged rectangles in frame-local coordinates - * shift_x, Vector to shift rectangles by - * shift_y - */ -typedef void (*RootlessDamageRectsProc) - (RootlessFrameID wid, int nrects, const BoxRec *rects, - int shift_x, int shift_y); - -/* - * Switch the window associated with a frame. (Optional) - * When a framed window is reparented, the frame is resized and set to - * use the new top-level parent. If defined this function will be called - * afterwards for implementation specific bookkeeping. - * - * pFrame Frame whose window has switched - * oldWin Previous window wrapped by this frame - */ -typedef void (*RootlessSwitchWindowProc) - (RootlessWindowPtr pFrame, WindowPtr oldWin); - -/* - * Check if window should be reordered. (Optional) - * The underlying window system may animate windows being ordered in. - * We want them to be mapped but remain ordered out until the animation - * completes. If defined this function will be called to check if a - * framed window should be reordered now. If this function returns - * FALSE, the window will still be mapped from the X11 perspective, but - * the RestackFrame function will not be called for its frame. - * - * pFrame Frame to reorder - */ -typedef Bool (*RootlessDoReorderWindowProc) - (RootlessWindowPtr pFrame); - -/* - * Copy bytes. (Optional) - * Source and destinate may overlap and the right thing should happen. - * - * width Bytes to copy per row - * height Number of rows - * src Source data - * srcRowBytes Width of source in bytes - * dst Destination data - * dstRowBytes Width of destination in bytes - */ -typedef void (*RootlessCopyBytesProc) - (unsigned int width, unsigned int height, - const void *src, unsigned int srcRowBytes, - void *dst, unsigned int dstRowBytes); - -/* - * Fill memory with 32-bit pattern. (Optional) - * - * width Bytes to fill per row - * height Number of rows - * value 32-bit pattern to fill with - * dst Destination data - * dstRowBytes Width of destination in bytes - */ -typedef void (*RootlessFillBytesProc) - (unsigned int width, unsigned int height, unsigned int value, - void *dst, unsigned int dstRowBytes); - -/* - * Composite pixels from source and mask to destination. (Optional) - * - * width, height Size of area to composite to in pizels - * function Composite function built with RL_COMPOSITE_FUNCTION - * src Source data - * srcRowBytes Width of source in bytes (Passing NULL means source - * is a single pixel. - * mask Mask data - * maskRowBytes Width of mask in bytes - * dst Destination data - * dstRowBytes Width of destination in bytes - * - * For src and dst, the first element of the array is the color data. If - * the second element is non-null it implies there is alpha data (which - * may be meshed or planar). Data without alpha is assumed to be opaque. - * - * An X11 error code is returned. - */ -typedef int (*RootlessCompositePixelsProc) - (unsigned int width, unsigned int height, unsigned int function, - void *src[2], unsigned int srcRowBytes[2], - void *mask, unsigned int maskRowBytes, - void *dst[2], unsigned int dstRowBytes[2]); - -/* - * Copy area in frame to another part of frame. (Optional) - * - * wid Frame id - * dstNrects Number of rectangles to copy - * dstRects Array of rectangles to copy - * dx, dy Number of pixels away to copy area - */ -typedef void (*RootlessCopyWindowProc) - (RootlessFrameID wid, int dstNrects, const BoxRec *dstRects, - int dx, int dy); - -/* - * Rootless implementation function list - */ -typedef struct _RootlessFrameProcs { - RootlessCreateFrameProc CreateFrame; - RootlessDestroyFrameProc DestroyFrame; - - RootlessMoveFrameProc MoveFrame; - RootlessResizeFrameProc ResizeFrame; - RootlessRestackFrameProc RestackFrame; - RootlessReshapeFrameProc ReshapeFrame; - RootlessUnmapFrameProc UnmapFrame; - - RootlessStartDrawingProc StartDrawing; - RootlessStopDrawingProc StopDrawing; - RootlessUpdateRegionProc UpdateRegion; -#ifndef ROOTLESS_TRACK_DAMAGE - RootlessDamageRectsProc DamageRects; -#endif - - /* Optional frame functions */ - RootlessSwitchWindowProc SwitchWindow; - RootlessDoReorderWindowProc DoReorderWindow; - - /* Optional acceleration functions */ - RootlessCopyBytesProc CopyBytes; - RootlessFillBytesProc FillBytes; - RootlessCompositePixelsProc CompositePixels; - RootlessCopyWindowProc CopyWindow; -} RootlessFrameProcsRec, *RootlessFrameProcsPtr; - - -/* - * Initialize rootless mode on the given screen. - */ -Bool RootlessInit(ScreenPtr pScreen, RootlessFrameProcsPtr procs); - -/* - * Initialize acceleration for rootless mode on a given screen. - * Note: RootlessAccelInit() must be called before DamageSetup() - * and RootlessInit() must be called afterwards. - */ -Bool RootlessAccelInit(ScreenPtr pScreen); - -/* - * Return the frame ID for the physical window displaying the given window. - * - * create If true and the window has no frame, attempt to create one - */ -RootlessFrameID RootlessFrameForWindow(WindowPtr pWin, Bool create); - -/* - * Return the top-level parent of a window. - * The root is the top-level parent of itself, even though the root is - * not otherwise considered to be a top-level window. - */ -WindowPtr TopLevelParent(WindowPtr pWindow); - -/* - * Prepare a window for direct access to its backing buffer. - */ -void RootlessStartDrawing(WindowPtr pWindow); - -/* - * Finish drawing to a window's backing buffer. - * - * flush If true and ROOTLESS_TRACK_DAMAGE is set, damaged areas - * are flushed to the screen. - */ -void RootlessStopDrawing(WindowPtr pWindow, Bool flush); - -/* - * Alocate a new screen pixmap. - * miCreateScreenResources does not do this properly with a null - * framebuffer pointer. - */ -void RootlessUpdateScreenPixmap(ScreenPtr pScreen); - -/* - * Reposition all windows on a screen to their correct positions. - */ -void RootlessRepositionWindows(ScreenPtr pScreen); - -#endif /* _ROOTLESS_H */ |