miext/rootless/README.txt

33 is referred to as a "frame". The generic rootless layer associates each
34 mapped top-level X11 window with a frame. An X11 window may be said
35 to be "framed" if it or its top-level parent is represented by a frame.
37         The generic rootless layer models each frame as being backed at
44 will be called when the drawing is concluded. The address of the frame's
48         Because each frame is assumed to have a backing buffer, the
50 regions of visibility of a frame change on screen. This is similar to backing
92         some frame resizes can be optimized by relying on the frame contents
94         of the frame contents need to be preserved by the generic rootless
96         during resizing and rely on the frame contents being preserved
163 not use this frame id other than to pass it back to the rootless
164 implementation to indicate the frame to operate on.
167  * Create a new frame.
168  *  The frame is created unmapped.
170  *  pFrame      RootlessWindowPtr for this frame should be completely
173  *  pScreen     Screen on which to place the new frame
174  *  newX, newY  Position of the frame.
175  *  pNewShape   Shape for the frame (in frame-local coordinates). NULL for
183  * Destroy a frame.
186  *  wid         Frame id
192  * Move a frame on screen.
195  *  wid         Frame id
196  *  pScreen     Screen to move the new frame to
197  *  newX, newY  New position of the frame
203  * Resize and move a frame.
206  *  wid         Frame id
207  *  pScreen     Screen to move the new frame to
208  *  newX, newY  New position of the frame
209  *  newW, newH  New size of the frame
219  * Change frame ordering (AKA stacking, layering).
223  *  wid         Frame id
224  *  nextWid     Frame id of frame that is now above this one or NULL if this
225  *              frame is at the top.
231  * Change frame's shape.
234  *  wid         Frame id
235  *  pNewShape   New shape for the frame (in frame-local coordinates)
242  * Unmap a frame.
244  *  wid         Frame id
250  * Start drawing to a frame.
251  *  Prepare a frame for direct access to its backing buffer.
253  *  wid         Frame id
261  * Stop drawing to a frame.
262  *  No drawing to the frame's backing buffer will occur until drawing
265  *  wid         Frame id
266  *  flush       Flush drawing updates for this frame to the screen.
275  *  wid         Frame id
276  *  pDamage     Region containing all the changed pixels in frame-local
285  *  wid         Frame id
287  *  rects       Array of damaged rectangles in frame-local coordinates
296  * Switch the window associated with a frame. (Optional)
297  *  When a framed window is reparented, the frame is resized and set to
301  *  pFrame      Frame whose window has switched
302  *  oldWin      Previous window wrapped by this frame
324  * Copy area in frame to another part of frame. (Optional)
326  *  wid         Frame id