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