components/x11/libXext/srcs/man/XSolarisOvlSetWindowTransparent.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 XSolarisOvlSetWindowTransparent __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  23 .IX "XSolarisOvlSetWindowTransparent" "" "\f3XSolarisOvlSetWindowTransparent\f1(3) \(em sets the background state of an overlay window to be transparent.
  24 .SH NAME
  25 XSolarisOvlSetWindowTransparent \- sets the background state of an overlay window to be transparent
  26 .SH SYNOPSIS
  27 .LP
  28 \&#include <X11/extensions/transovl.h>
  29
  30 .IP \f3void\f1 5n
  31 .B XSolarisOvlSetWindowTransparent
  32 .B (Display
  33 .I *display,
  34 .B Window
  35 .I w)
  36 .SH Arguments
  37 .TP
  38 .I display
  39 Specifies the connection to the X server.
  40 .TP
  41 .I w
  42 Specifies the window.
  43 .SH DESCRIPTION
  44 This routine sets the background state of the given overlay to be transparent.
  45 Any background rendering that occurs after this request will cause the
  46 background to be transparent.  Use
  47 .BR XChangeWindowAttributes (3) ,
  48 .BR XSetWindowBackground (3) ,
  49 or
  50 .BR XSetWindowBackgroundPixmap (3)
  51 to change background state to any other value.
  52 .LP
  53 If
  54 .I w
  55 is not an overlay window,
  56 .SB BadMatch
  57 is generated.
  58 .SH ERRORS
  59 .LP
  60 .nf
  61 .SB BadMatch
  62 .fi