man/xkb/XkbAllocGeomOutlines.man

   1 .\" Copyright 1999 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 XkbAllocGeomOutlines __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbAllocGeomOutlines \- Allocate space for an arbitrary number of outlines to a
  25 shape
  26 .SH SYNOPSIS
  27 .HP
  28 .B Status XkbAllocGeomOutlines
  29 .BI "(\^XkbShapePtr " "shape" "\^,"
  30 .BI "int " "num_needed" "\^);"
  31 .if n .ti +5n
  32 .if t .ti +.5i
  33 .SH ARGUMENTS
  34 .TP
  35 .I \- shape
  36 shape for which outlines should be allocated
  37 .TP
  38 .I \- num_needed
  39 number of new outlines required
  40 .SH DESCRIPTION
  41 .LP
  42 Xkb provides a number of functions to allocate and free subcomponents of a
  43 keyboard geometry. Use these functions to create or modify keyboard geometries.
  44 Note that these functions merely allocate space for the new element(s), and it
  45 is up to you to fill in the values explicitly in your code. These allocation
  46 functions increase
  47 .I sz_*
  48 but never touch
  49 .I num_*
  50 (unless there is an allocation failure, in which case they reset both
  51 .I sz_*
  52 and
  53 .I num_*
  54 to zero). These functions return Success if they succeed, BadAlloc if they are
  55 not able to allocate space, or BadValue if a parameter is not as expected.
  56
  57 .I XkbAllocGeomOutlines
  58 allocates space for
  59 .I num_needed
  60 outlines in the specified
  61 .I shape.
  62 The outlines are not initialized.
  63
  64 To free geometry outlines, use
  65 .I XkbFreeGeomOutlines.
  66 .SH DIAGNOSTICS
  67 .TP 15
  68 .B BadAlloc
  69 Unable to allocate storage
  70 .TP 15
  71 .B BadValue
  72 An argument is out of range
  73 .SH "SEE ALSO"
  74 .BR XkbFreeGeomOutlines (__libmansuffix__)