components/x11/libXext/srcs/man/XSolarisOvlCreateWindow.man

   1 .\" Copyright (c) 1995, 2008, Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XSolarisOvlCreateWindow __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  23 .IX "XSolarisOvlCreateWindow" "" "\f3XSolarisOvlCreateWindow\f1(3) \(em creates an overlay window" ""
  24 .SH NAME
  25 XSolarisOvlCreateWindow \- creates an overlay window
  26 .SH SYNOPSIS
  27 .LP
  28 \&#include <X11/extensions/transovl.h>
  29
  30 .IP \f3Window\f1 9n
  31 .B XSolarisOvlCreateWindow
  32 .B (Display
  33 .I *display,
  34 .B Window
  35 .I parent,
  36 .B int
  37 .I x,
  38 .B int
  39 .I y,
  40 .B unsigned
  41 .I int width,
  42 .B unsigned
  43 .I int height,
  44 .B unsigned
  45 .I int border_width,
  46 .B int
  47 .I depth,
  48 .B unsigned
  49 .I int class,
  50 .B Visual
  51 .I *visual,
  52 .B unsigned long
  53 .I valuemask,
  54 .B XSetWindowAttributes
  55 .I *attr)
  56 .SH Arguments
  57 The arguments for this routine are exactly the same as
  58 XCreateWindow.
  59 .TP
  60 .I display
  61 Specifies the connection to the X server.
  62 .TP
  63 .I parent
  64 Specifies the parent window.
  65 .TP
  66 .I x, y
  67 Specifies the coordinates of the upper-left pixel of this window,
  68 relative to the parent window.
  69 .TP
  70 .I width, height
  71 Specifies the width and height, in pixels, of the window.
  72 .TP
  73 .I border_width
  74 Specifies the width, in pixels, of the window's borders.
  75 .TP
  76 .I depth
  77 Specifies the depth of the window.
  78 .TP
  79 .I class
  80 Specifies the class of the window. If it is not
  81 .B InputOutput,
  82 the window will not be an overlay window.
  83 .TP
  84 .I visual
  85 Specifies a pointer to the visual structure for this window.
  86 .TP
  87 .I valuemask
  88 Specifies which window attributes are defined in the attr argument.
  89 .TP
  90 .I attr
  91 Specifies the attributes of the window.
  92 .SH DESCRIPTION
  93 This routine creates an overlay window with the given characteristics.
  94 It behaves exactly as its counterpart
  95 .B XCreateWindow,
  96 except the newly created window can be rendered into with both opaque
  97 and transparent paint, and the background is transparent.
  98 .SH SEE ALSO
  99 .LP
 100 .BR XCreateWindow (3)