Tao.Sdl SDK Documentation

Sdl.SDL_ListModes Method 

Return a pointer to an array of available screen dimensions for the given format and video flags, sorted largest to smallest. Returns NULL if there are no dimensions available for a particular format, or (SDL_Rect **)-1 if any dimension is okay for the given format.

[Visual Basic]
Public Shared Function SDL_ListModes( _
   ByVal format As IntPtr, _
   ByVal flags As Integer _
) As SDL_Rect()
[C#]
public static SDL_Rect[] SDL_ListModes(
   IntPtr format,
   int flags
);

Parameters

format
flags

Return Value

Returns null if no modes are available. If all modes are available returns an empty array.

Remarks

If 'format' is NULL, the mode list will be for the format given by SDL_GetVideoInfo()->vfmt. The flag parameter is an OR'd combination of surface flags. The flags are the same as those used SDL_SetVideoMode and they play a strong role in deciding what modes are valid. For instance, if you pass SDL_HWSURFACE as a flag only modes that support hardware video surfaces will be returned.

Binds to C-function call in SDL_video.h:

extern DECLSPEC SDL_Rect ** SDLCALL SDL_ListModes(SDL_PixelFormat *format, Uint32 flags)

See Also

Sdl Class | Tao.Sdl Namespace | SDL_SetVideoMode | SDL_GetVideoInfo | SDL_Rect | SDL_PixelFormat