.\" Copyright (c) 2022-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_DRIVERSDL2FB 3
.Os Agar 1.7
.Sh NAME
.Nm AG_DriverSDL2FB
.Nd agar SDL2 frame-buffer driver
.Sh DESCRIPTION
.\" IMAGE(/widgets/AG_DriverSDL2FB.png, "The sdl2fb driver")
The Agar
.Va sdl2fb
driver provides an interface to the
Simple DirectMedia Layer (SDL) library version 2 (SDL2), and renders
Agar GUI elements directly to the frame-buffer.
.Pp
Using
.Xr AG_InitVideoSDL 3
as opposed to
.Xr AG_InitGraphics 3 ,
it is possible to attach Agar to an existing SDL2 display surface.
.Sh INHERITANCE HIERARCHY
.Xr AG_Driver 3 ->
.Xr AG_DriverSw 3 ->
.Nm .
.Sh EXAMPLES
.Bd -literal -offset indent
.\" SYNTAX(c)
AG_InitGraphics("sdl2fb(width=640:height=480)");
AG_InitGraphics("sdl2fb(width=60%:height=80%)");

AG_InitVideoSDL(an_existing_SDL_screen, 0);
.Ed
.Sh OPTIONS
.Bl -tag -compact -width "clampOnResize "
.It ctrl
Enable game controller (gamepad) support.
.It haptic
Enable haptic (force feedback) subsystem.
.It joy
Enable joystick input device support.
.It width
Width (in pixels, in % of total desktop or "auto").
.It height
Height (in pixels, in % of total desktop or "auto").
.It bgColor
Solid background color (in 8-bit "R/G/B" format).
.It !bgPopup
Disable the standard contextual popup menu shown on right-click against
the background.
The standard popup menu shows the list of active Agar windows.
.It clampOnResize
Whenever the display is resized, clamp Agar window positions and sizes
to fit the new display size.
.It depth
Depth (in bits per pixel or "auto").
.It fpsMax
Limit refresh rate in frames/second (e.g, "60").
.El
.Sh SEE ALSO
.Xr AG_DriverSDL2GL 3 ,
.Xr AG_DriverSDL2MW 3 ,
.Xr AG_DriverSDLFB 3 ,
.Xr AG_DriverSDLGL 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 sdl2fb
driver first appeared in Agar 1.7.0.