SDL API
Cette documentation est une traduction de la documentation anglaise disponible sur le même wiki. La documentation anglaise est fondée sur le travail du projet de documentation de la SDL original anciennement disponible à cette adresse : http://sdldoc.csn.ul.ie/, effectué par :
Sam Lantinga
Martin Donlon
- Mattias Engdegård
- Julian Peterson
- Ken Jordan
- Maxim Sobolev
- Wesley Poole
- Michael Vance
- Andreas Umbach
Référence API de la SDL
- Général
SDL_Init - Initialise SDL
SDL_InitSubSystem - Initialise les sous-systèmes
SDL_QuitSubSystem - Arrête un sous-système
SDL_Quit - Ferme la SDL
SDL_WasInit - Vérifie si un sous-système a été initialisé
SDL_GetError - Retourne la dernière erreur SDL sous forme de chaîne de caractères
SDL_SetError - Définit la dernière erreur SDL
SDL_Error - Définit la dernière erreur SDL à partir d'un code d'erreur
SDL_ClearError - Efface la dernière erreur SDL
SDL_LoadObject - Charge un shared object
SDL_LoadFunction - Retourne l'adresse d'une fonction dans un shared object chargé.
SDL_UnloadObject - Décharge un shared object
SDL_envvars - Variables d'environnement SDL
SDL_VERSION - Détermine la version compilée de SDL
SDL_Linked_Version - Détermine la version de la bibliothèque SDL liée
SDL_version - Structure d'information sur la version SDL
- Vidéo
SDL_GetVideoSurface - Retourne un pointeur vers la surface d'affichage courante
SDL_GetVideoInfo - Retourne un pointeur vers la structure d'informations matérielles
SDL_VideoDriverName - Retourne le nom du pilote vidéo
SDL_ListModes - Retourne un pointeur vers un tableau de dimensions d'écran disponibles pour le format et les flags vidéos donnés
SDL_VideoModeOK - Vérifie si un mode vidéo particulier est supporté
SDL_SetVideoMode - Met en place un mode vidéo avec la hauteur, largeur et la quantité de bit par pixels spécifiés
SDL_UpdateRect - Assure que la zone donnée est mise à jour sur l'écran donné
SDL_UpdateRects - Assure que la liste de rectangles donnée est mise à jour sur l'écran donné
SDL_Flip - Echange les buffers écran (double-buffering)
SDL_SetColors - Définit une portion de colormap pour la surface 8 bits spécifiée.
SDL_SetPalette - Définit les couleurs de la palette d'une surface 8-bits.
SDL_SetGamma - Définit la courbe des gamma de l'affichage
SDL_SetGammaRamp - Récupère la table de conversion des gamma de l'affichage
SDL_SetGammaRamp - Définit la table de conversion des gamma de l'affichage
SDL_MapRGB - Convertit une couleur RGB vers un format de pixels.
SDL_MapRGBA - Convertit une couleur RGBA vers un format de pixels.
SDL_GetRGB - Récupère les valeurs RGB d'un pixel dans le format de pixels spécifié.Gets RGB values from a pixel in the specified pixel format
SDL_GetRGBA - Retourne les valeurs RGBA pour un pixel dans un pixel format donné
SDL_CreateRGBSurface - Crée une surface SDL_Surface vide
SDL_CreateRGBSurfaceFrom - Crée une surface SDL_Surface à partir de données pixel
SDL_FreeSurface - Libère (avec delete) une surface SDL_Surface
SDL_LockSurface - Verrouille une surface pour permettre l'accès direct
SDL_UnlockSurface - Déverrouille une surface préalablement verrouillée
SDL_ConvertSurface - Convertit une surface vers le format d'une autre surface
SDL_DisplayFormat - Convertit une surface vers le format d'affichage
SDL_DisplayFormatAlpha - Convertit une surface alpha vers le format d'affichage
SDL_LoadBMP - Charge un bitmap Windows dans une surface SDL_Surface
SDL_SaveBMP - Enregistre une surface SDL_Surface sous forme d'un bitmap Windows
SDL_SetColorKey - Définit la colorkey (pixel transparent) et l'accélération RLE sur une surface blittable.
SDL_SetAlpha - Ajuste la propriété alpha d'une surface
SDL_SetClipRect - Definit le rectangle de clipping d'une surface.
SDL_GetClipRect - Récupère le rectangle de clipping d'une surface.
SDL_BlitSurface - Effectue un blit rapide de la surface source vers la surface de destination.
SDL_FillRect - Effectue un remplissage rapide du rectangle donné avec la couleur spécifiée
SDLDoc-fr/SDL_GL_LoadLibrary - Spécifie une bibliothèque OpenGL
SDLDoc-fr/SDL_GL_GetProcAddress - Retourne l'adresse d'une fonction OpenGL.
SDLDoc-fr/SDL_GL_GetAttribute - Retourne la valeur d'un attribut spécial SDL/OpenGL.
SDLDoc-fr/SDL_GL_SetAttribute - Définit la valeur d'un attribut spécial SDL/OpenGL.
SDLDoc-fr/SDL_GL_SwapBuffers - Permute les framebuffers OpenGL/Met à jour l'affichage.
SDLDoc-fr/SDL_GLattr - Structure d'attribut SDL/OpenGL
SDL_CreateYUVOverlay - Crée un overlay YUV.
SDL_LockYUVOverlay - Verrouille un overlay.
SDL_UnlockYUVOverlay - Déverrouille un overlay.
SDL_DisplayYUVOverlay - Blite un overlay sur l'affichage.
SDL_FreeYUVOverlay - Libère un overlay YUV.
SDL_Rect - Structure définissant une zone rectangulaire
SDL_Color - Description de couleur générique
SDL_Palette - Structure de palette de couleur pour les formats de pixel 8-bits.
SDL_PixelFormat - Structure de format d'une SDL_Surface
SDL_Surface - Structure d'une surface
SDL_VideoInfo - Structure d'informations le mode vidéo
SDL_Overlay - Structure d'overlay YUV
- Gestion des fenêtres
SDL_GetWMInfo - Récupère des données spécifiques du gestionnaire de fenêtres, si disponibles.
SDL_WM_SetCaption - Définit le titre de la fenêtre et le nom de l'icône.
SDL_WM_GetCaption - Récupère le titre de la fenêtre et le nom de l'icône.
SDL_WM_SetIcon - Définit l'icône de la fenêtre d'affichage.
SDL_WM_IconifyWindow - Icônifie/Minimise la fenêtre.
SDL_WM_ToggleFullScreen - Bascule en mode plein écran/fenêtré
SDL_WM_GrabInput - Capture les entrées de la souris et du clavier.
- Gestion des événements
SDLKey - Définition des touches (Keysym).
SDLMod - Définition des modificateurs de touche.
SDL_PumpEvents - Remplit la file d'événements, rassemblant les événements provenant des périphériques d'entrée
SDL_PeepEvents - Cherche la file d'événements, et éventuellement renvoie les.
SDL_PollEvent - Lit les derniers événements (non bloquant)
SDL_WaitEvent - Attend jusqu'au prochain événement disponible
SDL_PushEvent - Ajoute un événement dans la file
SDL_SetEventFilter - Definit une fonction pour filtrer les événements
SDL_EventState - Définit la manière dont sont traité certains types d'événements
SDL_GetKeyState - Retourne un instantané de l'état actuel du clavier.
SDL_GetModState - Retourne l'état des modificateurs clavier.
SDL_SetModState - Définit l'état des modificateurs clavier.
SDL_GetKeyName - Retourne le nom d'une touche.
SDL_EnableUNICODE - Active la traduction UNICODE des touches
SDL_EnableKeyRepeat - Fixe la vitesse de répetition du clavier
SDL_GetMouseState - Récupère l'état actuel de la souris
SDL_GetRelativeMouseState - Récupère l'état actuel de la souris
SDL_GetAppState - Récupère l'état actuel de l'application
SDL_JoystickEventState - Active/Désactive la capture des événements du joystick
- Souris
SDL_WarpMouse - Fixe la position du curseur de la souris.
SDL_CreateCursor - Crée un nouveau pointeur de souris.
SDL_FreeCursor - Libère un curseyr créé avec SDL_CreateCursor.
SDL_SetCursor - Change le curseur de souris actuellement actif.
SDL_GetCursor - Renvoie le curseur de souris actuellement actif.
SDL_ShowCursor - Montre/Cache le curseur de souris à l'écran.
- Joystick
SDL_NumJoysticks - Compte le nombre de joysticks.
SDL_JoystickName - Retourne le nom du joystick.
SDL_JoystickOpen - Ouvre un joystick pour utilisation.
SDL_JoystickOpened - Détermine si un joystick est ouvert.
SDL_JoystickIndex - Retourne l'index d'un SDL_Joystick.
SDL_JoystickNumAxes - Retourne le nombre d'axes du joystick.
SDL_JoystickNumBalls - Retourne le nombre de trackballs du joystick.
SDL_JoystickNumHats - Retourne le nombre de chapeaux (hats) du joystick.
SDL_JoystickNumButtons - Retourne le nombre de boutons du joystick.
SDL_JoystickUpdate - Met à jour l'état de tous les joysticks.
SDL_JoystickGetAxis - Retourne l'état d'un axe.
SDL_JoystickGetHat - Retourne l'état d'un chapeau (hat).
SDL_JoystickGetButton - Retourne l'état d'un bouton donné sur le joystick spécifié.
SDL_JoystickGetBall - Retourne le mouvement relatif d'un trackball
SDL_JoystickClose - Ferme un joystick précedemment ouvert.
- Audio
SDL_AudioSpec - Structure de Spécifications Audio
SDL_OpenAudio - Ouvre le périphérique audio avec les paramètres voulus.
SDL_PauseAudio - Active/Désactive la pause de la fonction callback de traitement audio.
SDL_GetAudioStatus - Retourne l'état actuel de l'audio.
SDL_LoadWAV - Charge un fichier WAVE.
SDL_FreeWAV - Libère les données WAVE.
SDL_AudioCVT - Structure de conversion audio.
SDL_BuildAudioCVT - Initialise une structure SDL_AudioCVT - pour conversion.
SDL_ConvertAudio - Convertit les données audio dans le format voulu.
SDL_MixAudio - Mixe des données audio.
SDL_LockAudio - Verrouille la fonction callback.
SDL_UnlockAudio - Deverrouille la fonction callback.
SDL_CloseAudio - Arrête les traitements audio et ferme le périphérique.
- CD-ROM
SDL_CDNumDrives - Renvoie le nombre de lecteur CD-ROM du système.
SDL_CDName - Renvoie un identifiant humainement lisible, et dépendant du système pour un CD-ROM.
SDL_CDOpen - Ouvre un lecteur de CD-ROM pour y accéder.
SDL_CDStatus - Renvoie le status actuel du lecteur spécifié.
SDL_CDPlay - Joue un CD.
SDL_CDPlayTracks - Joue la/les piste(s) CD spécifiée(s).
SDL_CDPause - Met le CD-ROM en pause.
SDL_CDResume - Reprend la lecteur d'un CDROM
SDL_CDStop - Stoppe un CD-ROM
SDL_CDEject - Ejecte un CDROM
SDL_CDClose - Ferme une instance de SDL_CD
SDL_CD - Structure d'information du Lecteur CDROM
SDL_CDtrack - Structure d'information de piste de CD
- Programmation Concurrente (Multithread)
SDL_CreateThread - Crée un nouveau thread partageant les propriétés du parent.
SDL_ThreadID - Renvoie un identifiant de thread 32-bits pour le thread actuel.
SDL_GetThreadID - Retourne l'identifiant de thread ID d'un SDL_Thread
SDL_WaitThread - Attends qu'un thread finisse.
SDL_KillThread - Termine violemment un thread.
SDL_CreateMutex - Crée un mutex
SDL_DestroyMutex - Détruit un mutex
SDL_mutexP - Verrouille un mutex
SDL_mutexV - Déverrouille un mutex
SDL_CreateSemaphore - Crée un nouveau semaphore et fixe sa valeur initiale.
SDL_DestroySemaphore - Détruit un semaphore créé avec SDL_CreateSemaphore.
SDL_SemWait - Verrouille un sémaphore et suspend le thread si la valeur du sémaphore est zéro.
SDL_SemTryWait - Tente de verrouiller un sémaphore mais ne suspend pas le thread.
SDL_SemWaitTimeout - Verrouille un sémaphore, mais attends seulement pendant la durée maximum spécifiée.
SDL_SemPost - Déverrouille un semaphore.
SDL_SemValue - Renvoie la valeur actuelle du semaphore.
SDL_CreateCond - Crée une variable conditionnelle.
SDL_DestroyCond - Détruit une variable conditionnelle.
SDL_CondSignal - Reprend un thread qui attend sur une variable conditionnelle.
SDL_CondBroadcast - Reprend tous les threads qui attendent sur une variable conditionnelle.
SDL_CondWait - Attend sur une variable conditionnelle.
SDL_CondWaitTimeout - Attends sur une variable conditionnelle, avec une durée maximale.
- Gestion du temps
SDL_GetTicks - Retourne le nombre de millisecondes depuis l'initialisation de la SDL.
SDL_Delay - Attend le nombre de millisecondes spécifié avant de rendre la main.
SDL_AddTimer - Ajoute un timer qui appelera une fonction callback au bout du nombre de millisecondes spécifié.
SDL_RemoveTimer - Supprime un timer ajouté précédemment par SDL_AddTimer.
SDL_SetTimer - Définit une fonction de callback qui sera appelée au bout du nombre de millisecondes spécifié (obsolète).
- Fichiers (RWops)
SDL_RWFromFile - Ouvre un fichier
SDL_RWFromFP - Ouvre un fichier depuis un pointeur vers un fichier stdio.
SDL_RWFromMem - Prépare une zone mémoire pour être utilisée par SDL_RWops.
SDL_RWFromConstMem - Prépare une zone mémoire constante pour être utilisée par SDL_RWops.
SDL_AllocRW - Alloue une structure SDL_RWops.
SDL_FreeRW - Libère une structuer SDL_RWops.
SDL_RWseek - Définit la position courante dans la source de données.
SDL_RWtell - Renvoie la position courante dans la source de données.
SDL_RWread - Lit depuis une source de données.
SDL_RWwrite - Ecrit dans une source de données.
SDL_RWclose - Ferme une source de données.
SDL_RWops - Structure pour les opérations de lecture/écriture.