SDL_VideoModeOK

Name

SDL_VideoModeOK -- Check to see if a particular video mode is supported.

Synopsis

uses
SDL;

function SDL_VideoModeOK( width, height, bpp : Integer; flags: UInt32 ) : Integer;

Description

SDL_VideoModeOK returns 0 if the requested mode is not supported under any bit depth, or returns the bits-per-pixel of the closest available mode with the given width, height and requested surface flags (see SDL_SetVideoMode ).

The bits-per-pixel value returned is only a suggested mode. You can usually request and bpp you want when setting the video mode and SDL will emulate that color depth with a shadow video surface.

The arguments to SDL_VideoModeOK are the same ones you would pass to SDL_SetVideoMode

Example

screen_ : PSDL_Surface;
bpp : Uint32;
.
.
.
WriteLn( 'Checking mode 640x480@16bpp.' );
bpp := SDL_VideoModeOK( 640, 480, 16, SDL_HWSURFACE );

if
( bpp = 0 ) then
begin
WriteLn( 'Mode not available.' );
halt( -1 );
end;

WriteLn( Format( 'SDL Recommends 640x480@%dbpp.', [bpp] ) );
screen := SDL_SetVideoMode( 640, 480, bpp, SDL_HWSURFACE );
.
.

See Also

SDL_SetVideoMode , SDL_GetVideoInfo