.\" Copyright (c) 2010-2023 Julien Nadeau Carriere <vedge@csoft.net>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd December 23, 2022
.Dt AG_DRIVERSDLFB 3
.Os Agar 1.7
.Sh NAME
.Nm AG_DriverSDLFB
.Nd agar SDL1 frame-buffer driver
.Sh DESCRIPTION
.\" IMAGE(/widgets/AG_DriverSDLFB.png, "The sdlfb driver")
The Agar
.Va sdlfb
driver provides an interface to the Simple DirectMedia Layer (SDL) library
version 1.2, and renders GUI elements directly to the frame-buffer.
Using
.Xr AG_InitVideoSDL 3
as opposed to
.Xr AG_InitGraphics 3 ,
it is possible to attach Agar to an existing SDL display surface.
.Sh INHERITANCE HIERARCHY
.Xr AG_Driver 3 ->
.Xr AG_DriverSw 3 ->
.Nm .
.Sh EXAMPLES
.Bd -literal -offset indent
.\" SYNTAX(c)
AG_InitGraphics("sdlfb(width=640:height=480:joy)");
AG_InitGraphics("sdlfb(width=60%:height=80%)");
AG_InitGraphics("sdlgl(bgColor=0/120/120)");

AG_InitVideoSDL(an_existing_SDL_screen, 0);
.Ed
.Sh OPTIONS
.Bl -tag -compact -width "clampOnResize"
.It joy
Enable joystick input device support.
.It width
Width (in pixels, in % of desktop space or "auto").
.It height
Height (in pixels, in % of desktop space or "auto").
.It depth
Depth (in bits per pixel or "auto").
.It fpsMax
Limit refresh rate in frames/second (e.g., "60").
.It bgColor
Solid background color specified as "R/G/B", from "0/0/0" (black) to
"255/255/255" (white).
.It !bgPopup
Disable the right-click background popup menu
(which includes, notably the list of active windows).
.It clampOnResize
Whenever the display is resized, clamp Agar window positions and sizes
to fit the new display size.
.El
.Sh SEE ALSO
.Xr AG_DriverSDL2FB 3 ,
.Xr AG_DriverSDL2GL 3 ,
.Xr AG_Driver 3 ,
.Xr AG_DriverSw 3 ,
.Xr AG_InitGraphics 3 ,
.Xr AG_Intro 3
.Pp
.Bl -tag -compact
.It Lk https://libsdl.org/ Simple DirectMedia Layer
.It Lk https://www.opengl.org/ OpenGL
.El
.Sh HISTORY
The
.Va sdlfb
driver first appeared in Agar 1.4.0.
The
.Va clampOnResize
and
.Va joy
options appeared in Agar 1.7.0.