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