cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * External interface to generic rootless mode
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Copyright (c) 2001 Greg Parker. All Rights Reserved.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Copyright (c) 2002-2003 Torrey T. Lyons. All Rights Reserved.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Permission is hereby granted, free of charge, to any person obtaining a
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * copy of this software and associated documentation files (the "Software"),
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * to deal in the Software without restriction, including without limitation
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * the rights to use, copy, modify, merge, publish, distribute, sublicense,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * and/or sell copies of the Software, and to permit persons to whom the
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Software is furnished to do so, subject to the following conditions:
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * The above copyright notice and this permission notice shall be included in
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * all copies or substantial portions of the Software.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * DEALINGS IN THE SOFTWARE.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Except as contained in this notice, the name(s) of the above copyright
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * holders shall not be used in advertising or otherwise to promote the sale,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * use or other dealings in this Software without prior written authorization.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Each top-level rootless window has a one-to-one correspondence to a physical
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync on-screen window. The physical window is refered to as a "frame".
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * RootlessWindowRec
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * This structure stores the per-frame data used by the rootless code.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Each top-level X window has one RootlessWindowRec associated with it.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync // Position and size includes the window border
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync // Position is in per-screen coordinates
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RootlessFrameID wid; // implementation specific frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync // Valid only when drawing (ie. is_drawing is set)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* Offset for screen-local to global coordinate transforms */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* The minimum number of bytes or pixels for which to use the
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync implementation's accelerated functions. */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern unsigned int rootless_CopyBytes_threshold;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern unsigned int rootless_FillBytes_threshold;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern unsigned int rootless_CompositePixels_threshold;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncextern unsigned int rootless_CopyWindow_threshold;
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* Operations used by CompositePixels */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* Data formats for depth field and composite functions */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_DEPTH_NIL = 0, /* null source when compositing */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* Macro to form the composite function for CompositePixels */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#define RL_COMPOSITE_FUNCTION(op, src_depth, mask_depth, dest_depth) \
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/* Gravity for window contents during resizing */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_GRAVITY_NONE = 0, /* no gravity, fill everything */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_GRAVITY_NORTH_WEST = 1, /* anchor to top-left corner */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_GRAVITY_NORTH_EAST = 2, /* anchor to top-right corner */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_GRAVITY_SOUTH_EAST = 3, /* anchor to bottom-right corner */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync RL_GRAVITY_SOUTH_WEST = 4, /* anchor to bottom-left corner */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync/*------------------------------------------
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync Rootless Implementation Functions
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync ------------------------------------------*/
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Create a new frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * The frame is created unmapped.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pFrame RootlessWindowPtr for this frame should be completely
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * initialized before calling except for pFrame->wid, which
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * is set by this function.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pScreen Screen on which to place the new frame
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * newX, newY Position of the frame. These will be identical to pFrame-x,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pFrame->y unless ROOTLESS_GLOBAL_COORDS is set.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pNewShape Shape for the frame (in frame-local coordinates). NULL for
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * unshaped frames.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (RootlessWindowPtr pFrame, ScreenPtr pScreen, int newX, int newY,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Destroy a frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped and all updates are flushed before this is called.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Move a frame on screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped and all updates are flushed before this is called.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pScreen Screen to move the new frame to
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * newX, newY New position of the frame
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (RootlessFrameID wid, ScreenPtr pScreen, int newX, int newY);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Resize and move a frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped and all updates are flushed before this is called.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pScreen Screen to move the new frame to
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * newX, newY New position of the frame
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * newW, newH New size of the frame
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * gravity Gravity for window contents (rl_gravity_enum). This is always
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * RL_GRAVITY_NONE unless ROOTLESS_RESIZE_GRAVITY is set.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync int newX, int newY, unsigned int newW, unsigned int newH,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync unsigned int gravity);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Change frame ordering (AKA stacking, layering).
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped before this is called. Unmapped frames are mapped by
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * setting their ordering.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * nextWid Frame id of frame that is now above this one or NULL if this
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * frame is at the top.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Change frame's shape.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped before this is called.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pNewShape New shape for the frame (in frame-local coordinates)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * or NULL if now unshaped.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Unmap a frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Start drawing to a frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Prepare a frame for direct access to its backing buffer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pixelData Address of the backing buffer (returned)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * bytesPerRow Width in bytes of the backing buffer (returned)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (RootlessFrameID wid, char **pixelData, int *bytesPerRow);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Stop drawing to a frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * No drawing to the frame's backing buffer will occur until drawing
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * is started again.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * flush Flush drawing updates for this frame to the screen. This
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * will always be FALSE if ROOTLESS_TRACK_DAMAGE is set.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Flush drawing updates to the screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Drawing is stopped before this is called.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pDamage Region containing all the changed pixels in frame-lcoal
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * coordinates. This is clipped to the window's clip. This
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * will be NULL if ROOTLESS_TRACK_DAMAGE is not set.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Mark damaged rectangles as requiring redisplay to screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * This will only be called if ROOTLESS_TRACK_DAMAGE is not set.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * nrects Number of damaged rectangles
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * rects Array of damaged rectangles in frame-local coordinates
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * shift_x, Vector to shift rectangles by
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (RootlessFrameID wid, int nrects, const BoxRec *rects,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Switch the window associated with a frame. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * When a framed window is reparented, the frame is resized and set to
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * use the new top-level parent. If defined this function will be called
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * afterwards for implementation specific bookkeeping.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pFrame Frame whose window has switched
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * oldWin Previous window wrapped by this frame
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Check if window should be reordered. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * The underlying window system may animate windows being ordered in.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * We want them to be mapped but remain ordered out until the animation
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * completes. If defined this function will be called to check if a
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * framed window should be reordered now. If this function returns
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * FALSE, the window will still be mapped from the X11 perspective, but
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * the RestackFrame function will not be called for its frame.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * pFrame Frame to reorder
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Copy bytes. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Source and destinate may overlap and the right thing should happen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * width Bytes to copy per row
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * height Number of rows
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * src Source data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * srcRowBytes Width of source in bytes
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dst Destination data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dstRowBytes Width of destination in bytes
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Fill memory with 32-bit pattern. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * width Bytes to fill per row
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * height Number of rows
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * value 32-bit pattern to fill with
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dst Destination data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dstRowBytes Width of destination in bytes
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (unsigned int width, unsigned int height, unsigned int value,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Composite pixels from source and mask to destination. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * width, height Size of area to composite to in pizels
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * function Composite function built with RL_COMPOSITE_FUNCTION
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * src Source data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * srcRowBytes Width of source in bytes (Passing NULL means source
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * is a single pixel.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * mask Mask data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * maskRowBytes Width of mask in bytes
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dst Destination data
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dstRowBytes Width of destination in bytes
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * For src and dst, the first element of the array is the color data. If
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * the second element is non-null it implies there is alpha data (which
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * may be meshed or planar). Data without alpha is assumed to be opaque.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * An X11 error code is returned.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (unsigned int width, unsigned int height, unsigned int function,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Copy area in frame to another part of frame. (Optional)
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * wid Frame id
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dstNrects Number of rectangles to copy
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dstRects Array of rectangles to copy
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * dx, dy Number of pixels away to copy area
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync (RootlessFrameID wid, int dstNrects, const BoxRec *dstRects,
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Rootless implementation function list
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync /* Optional frame functions */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync /* Optional acceleration functions */
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Initialize rootless mode on the given screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncBool RootlessInit(ScreenPtr pScreen, RootlessFrameProcsPtr procs);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Initialize acceleration for rootless mode on a given screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Note: RootlessAccelInit() must be called before DamageSetup()
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * and RootlessInit() must be called afterwards.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Return the frame ID for the physical window displaying the given window.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * create If true and the window has no frame, attempt to create one
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncRootlessFrameID RootlessFrameForWindow(WindowPtr pWin, Bool create);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Return the top-level parent of a window.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * The root is the top-level parent of itself, even though the root is
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * not otherwise considered to be a top-level window.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Prepare a window for direct access to its backing buffer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Finish drawing to a window's backing buffer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * flush If true and ROOTLESS_TRACK_DAMAGE is set, damaged areas
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * are flushed to the screen.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncvoid RootlessStopDrawing(WindowPtr pWindow, Bool flush);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Alocate a new screen pixmap.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * miCreateScreenResources does not do this properly with a null
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * framebuffer pointer.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Reposition all windows on a screen to their correct positions.
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync * Bring all windows to the front of the native stack
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsyncvoid RootlessOrderAllWindows (Bool include_unhitable);
cabde247f900dcf6e58d009bbdd15099c028c6fcvboxsync#endif /* _ROOTLESS_H */