1 .\" Copyright (c) 2003, Sun Microsystems, Inc.
   2 .\" Copyright (c) 2017, Joyent, Inc.
   3 .\" The contents of this file are subject to the terms of the
   4 .\" Common Development and Distribution License (the "License").
   5 .\" You may not use this file except in compliance with the License.
   6 .\"
   7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" or http://www.opensolaris.org/os/licensing.
   9 .\" See the License for the specific language governing permissions
  10 .\" and limitations under the License.
  11 .\"
  12 .\" When distributing Covered Code, include this CDDL HEADER in each
  13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" If applicable, add the following below this CDDL HEADER, with the fields
  15 .\" enclosed by brackets "[]" replaced with your own identifying
  16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17 .Dd October 22, 2017
  18 .Dt FBIO 7I
  19 .Os
  20 .Sh NAME
  21 .Nm fbio
  22 .Nd frame buffer control operations
  23 .Sh DESCRIPTION
  24 The frame buffers provided with this release support the same general interface
  25 that is defined by
  26 .In sys/fbio.h .
  27 Each responds to an
  28 .Dv FBIOGTYPE
  29 .Xr ioctl 2
  30 request which returns information in a
  31 .Vt fbtype
  32 structure.
  33 .Pp
  34 Each device has an
  35 .\" FBTYPE isn't macro, enum, or type, just used to describe a number of
  36 .\" CPP-macros of the form #define FBTYPE_xxxx
  37 .Sy FBTYPE

 120 .Pp
 121 .Dv FBIOSCURSOR ,
 122 .Dv FBIOGCURSOR ,
 123 .Dv FBIOSCURPOS
 124 and
 125 .Dv FBIOGCURPOS
 126 are used to control the hardware cursor for those framebuffers that have this
 127 feature.
 128 .Dv FBIOGCURMAX
 129 returns the maximum sized cursor supported by the framebuffer.
 130 Attempts to create a cursor larger than this will fail.
 131 .Pp
 132 Finally
 133 .Dv FBIOSDEVINFO
 134 and
 135 .Dv FBIOGDEVINFO
 136 are used to transfer
 137 variable-length, device-specific information into and out of framebuffers.
 138 .Sh SEE ALSO
 139 .Xr ioctl 2 ,
 140 .Xr mmap 2 ,
 141 .Xr cgsix 7D
 142 .Sh BUGS
 143 The
 144 .Dv FBIOSATTR
 145 and
 146 .Dv FBIOGATTR
 147 .Xr ioctl 2
 148 requests are only
 149 supported by frame buffers which emulate older frame buffer types.
 150 If a frame buffer emulates another frame buffer,
 151 .Dv FBIOGTYPE
 152 returns the emulated type.
 153 To get the real type, use
 154 .Dv FBIOGATTR .
 155 .Pp
 156 The
 157 .Dv FBIOGCURPOS
 158 ioctl was incorrectly defined in previous operating
 159 systems, and older code running in binary compatibility mode may get incorrect
 160 results.

   1 .\" Copyright (c) 2003, Sun Microsystems, Inc.
   2 .\" Copyright (c) 2017, Joyent, Inc.
   3 .\" The contents of this file are subject to the terms of the
   4 .\" Common Development and Distribution License (the "License").
   5 .\" You may not use this file except in compliance with the License.
   6 .\"
   7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   8 .\" or http://www.opensolaris.org/os/licensing.
   9 .\" See the License for the specific language governing permissions
  10 .\" and limitations under the License.
  11 .\"
  12 .\" When distributing Covered Code, include this CDDL HEADER in each
  13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  14 .\" If applicable, add the following below this CDDL HEADER, with the fields
  15 .\" enclosed by brackets "[]" replaced with your own identifying
  16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  17 .Dd February 17, 2020
  18 .Dt FBIO 7I
  19 .Os
  20 .Sh NAME
  21 .Nm fbio
  22 .Nd frame buffer control operations
  23 .Sh DESCRIPTION
  24 The frame buffers provided with this release support the same general interface
  25 that is defined by
  26 .In sys/fbio.h .
  27 Each responds to an
  28 .Dv FBIOGTYPE
  29 .Xr ioctl 2
  30 request which returns information in a
  31 .Vt fbtype
  32 structure.
  33 .Pp
  34 Each device has an
  35 .\" FBTYPE isn't macro, enum, or type, just used to describe a number of
  36 .\" CPP-macros of the form #define FBTYPE_xxxx
  37 .Sy FBTYPE

 120 .Pp
 121 .Dv FBIOSCURSOR ,
 122 .Dv FBIOGCURSOR ,
 123 .Dv FBIOSCURPOS
 124 and
 125 .Dv FBIOGCURPOS
 126 are used to control the hardware cursor for those framebuffers that have this
 127 feature.
 128 .Dv FBIOGCURMAX
 129 returns the maximum sized cursor supported by the framebuffer.
 130 Attempts to create a cursor larger than this will fail.
 131 .Pp
 132 Finally
 133 .Dv FBIOSDEVINFO
 134 and
 135 .Dv FBIOGDEVINFO
 136 are used to transfer
 137 variable-length, device-specific information into and out of framebuffers.
 138 .Sh SEE ALSO
 139 .Xr ioctl 2 ,
 140 .Xr mmap 2

 141 .Sh BUGS
 142 The
 143 .Dv FBIOSATTR
 144 and
 145 .Dv FBIOGATTR
 146 .Xr ioctl 2
 147 requests are only
 148 supported by frame buffers which emulate older frame buffer types.
 149 If a frame buffer emulates another frame buffer,
 150 .Dv FBIOGTYPE
 151 returns the emulated type.
 152 To get the real type, use
 153 .Dv FBIOGATTR .
 154 .Pp
 155 The
 156 .Dv FBIOGCURPOS
 157 ioctl was incorrectly defined in previous operating
 158 systems, and older code running in binary compatibility mode may get incorrect
 159 results.