SDL3 - FFI Wrapper for Simple DirectMedia Layer (SDL) Version 3.0
use SDL3 qw[:all];
die 'Error initializing SDL: ' . SDL_GetError() unless SDL_Init(SDL_INIT_VIDEO) == 0;
my $win = SDL_CreateWindow( 'Example window!',
SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, 640, 480, SDL_WINDOW_RESIZABLE );
die 'Could not create window: ' . SDL_GetError() unless $win;
my $event = SDL3::Event->new;
SDL_Init(SDL_INIT_VIDEO);
my $renderer = SDL_CreateRenderer( $win, -1, 0 );
SDL_SetRenderDrawColor( $renderer, 242, 242, 242, 255 );
do {
SDL_WaitEventTimeout( $event, 10 );
SDL_RenderClear($renderer);
SDL_RenderPresent($renderer);
} until $event->type == SDL_QUIT;
SDL_DestroyRenderer($renderer);
SDL_DestroyWindow($win);
SDL_Quit();
SDL3 is a FFI::Platypus backed bindings to the Simple DirectMedia Layer - a cross-platform development library designed to provide low level access to audio, keyboard, mouse, joystick, and graphics hardware.
The functions in this category are used to set SDL up for use and generally
have global effects in your program. These functions may be imported with the
:init
or :default
tag.
Initializes the SDL library. This must be called before using most other SDL functions.
SDL_Init( SDL_INIT_TIMER | SDL_INIT_VIDEO | SDL_INIT_EVENTS );
SDL_Init( ... )
simply forwards to calling SDL_InitSubSystem( ... )
. Therefore, the two may be used
interchangeably. Though for readability of your code SDL_InitSubSystem( ... )
might be preferred.
The file I/O (for example: SDL_RWFromFile( ... )
) and threading
(SDL_CreateThread( ... )
) subsystems are initialized by default. Message
boxes (SDL_ShowSimpleMessageBox( ... )
) also attempt to work without
initializing the video subsystem, in hopes of being useful in showing an error
dialog when SDL_Init fails. You must specifically initialize other subsystems
if you use them in your application.
Logging (such as SDL_Log( ... )
) works without initialization, too.
Expected parameters include:
flags
which may be any be imported with the:init
tag and may be OR'd together
Subsystem initialization is ref-counted, you must call SDL_QuitSubSystem( ... )
for each SDL_InitSubSystem( ... )
to correctly shutdown a subsystem manually
(or call SDL_Quit( )
to force shutdown). If a
subsystem is already loaded then this call will increase the ref-count and
return.
Returns 0
on success or a negative error code on failure; call
SDL_GetError( )
for more information.
Compatibility function to initialize the SDL library.
In SDL2, this function and SDL_Init( ... )
are
interchangeable.
SDL_InitSubSystem( SDL_INIT_TIMER | SDL_INIT_VIDEO | SDL_INIT_EVENTS );
Expected parameters include:
flags
which may be any be imported with the:init
tag and may be OR'd together.
Returns 0
on success or a negative error code on failure; call
SDL_GetError( )
for more information.
Shut down specific SDL subsystems.
SDL_QuitSubSystem( SDL_INIT_VIDEO );
If you start a subsystem using a call to that subsystem's init function (for
example SDL_VideoInit( )
) instead of SDL_Init( ... )
or SDL_InitSubSystem( ... )
, SDL_QuitSubSystem( ... )
and SDL_WasInit( ... )
will not work. You will need to
use that subsystem's quit function (SDL_VideoQuit( )
directly instead. But
generally, you should not be using those functions directly anyhow; use SDL_Init( ... )
instead.
You still need to call SDL_Quit( )
even if you close
all open subsystems with SDL_QuitSubSystem( ... )
.
Expected parameters include:
flags
which may be any be imported with the:init
tag and may be OR'd together.
Get a mask of the specified subsystems which are currently initialized.
SDL_Init( SDL_INIT_VIDEO | SDL_INIT_AUDIO );
warn SDL_WasInit( SDL_INIT_TIMER ); # false
warn SDL_WasInit( SDL_INIT_VIDEO ); # true (32 == SDL_INIT_VIDEO)
my $mask = SDL_WasInit( );
warn 'video init!' if ($mask & SDL_INIT_VIDEO); # yep
warn 'video timer!' if ($mask & SDL_INIT_TIMER); # nope
Expected parameters include:
flags
which may be any be imported with the:init
tag and may be OR'd together.
If flags
is 0
, it returns a mask of all initialized subsystems, otherwise
it returns the initialization status of the specified subsystems.
The return value does not include SDL_INIT_NOPARACHUTE
.
Clean up all initialized subsystems.
SDL_Quit( );
You should call this function even if you have already shutdown each
initialized subsystem with SDL_QuitSubSystem( )
. It is safe to call this
function even in the case of errors in initialization.
If you start a subsystem using a call to that subsystem's init function (for
example SDL_VideoInit( )
) instead of SDL_Init( ... )
or SDL_InitSubSystem( ... )
, then
you must use that subsystem's quit function (SDL_VideoQuit( )
) to shut it
down before calling SDL_Quit( )
. But generally, you should not be using
those functions directly anyhow; use SDL_Init( ... )
instead.
You can use this function in an END { ... }
block to ensure that it is run
when your application is shutdown.
Defined values may be imported by name or with given tag.
These are the flags which may be passed to SDL_Init( ... )
. You should
specify the subsystems which you will be using in your application. These may
be imported with the :init
or :default
tag.
SDL_INIT_TIMER
SDL_INIT_AUDIO
SDL_INIT_VIDEO
-SDL_INIT_VIDEO
impliesSDL_INIT_EVENTS
SDL_INIT_JOYSTICK
-SDL_INIT_JOYSTICK
impliesSDL_INIT_EVENTS
SDL_INIT_HAPTIC
SDL_INIT_GAMECONTROLLER
-SDL_INIT_GAMECONTROLLER
impliesSDL_INIT_JOYSTICK
SDL_INIT_EVENTS
SDL_INIT_SENSOR
SDL_INIT_NOPARACHUTE
- compatibility; this flag is ignoredSDL_INIT_EVERYTHING
https://github.com/libsdl-org/SDL
Copyright (C) Sanko Robinson.
This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module.
Sanko Robinson sanko@cpan.org