Tao.Sdl SDK Documentation

Sdl.SDL_VideoModeOK Method 

Check to see if a particular video mode is supported.

[Visual Basic]
Public Shared Function SDL_VideoModeOK( _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal bpp As Integer, _
   ByVal flags As Integer _
) As Integer
[C#]
public static int SDL_VideoModeOK(
   int width,
   int height,
   int bpp,
   int flags
);

Parameters

width
Width of mode
height
Height of mode
bpp
bit depth of Mode
flags

Return Value

Remarks

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 Sdl.SDL_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

Binds to C-function call in SDL_video.h:

extern DECLSPEC int SDLCALL SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags)

See Also

Sdl Class | Tao.Sdl Namespace