SDL PeepEvents

Aus DGL Wiki
Wechseln zu: Navigation, Suche
Hinweis: Dieser Artikel ist noch unvollständig.
(Mehr Informationen/weitere Artikel)

Dokumentation für den Parameter "events".
Was soll "optional" bedeuten? Wie kann man das beeinflussen?
Beispiel fehlt noch.

Incomplete.jpg

SDL_PeepEvents

Name

SDL_PeepEvents - Prüft die Event-Warteschlange auf anstehende Ereignisse und liefert die Anzahl dieser zurück.


Delphi-Spezifikation

function SDL_PeepEvents(events : PSDL_Event; numevents : Integer; action : SDL_eventaction; mask : Uint32;) :Integer;



Parameter

events Zeiger auf eine Liste von Events die der Suchanfrage entsprechen. (Steht so nicht in der Doku. Ist aus dem Text geschlussfolgert.)
numevents Beschränkt die Anzahl der Manipulationen.
action Legt fest wie die Warteschlange abgefragt bzw. manipuliert werden soll.

Gültige Werte sind: SDL_ADDEVENT, SDL_PEEKEVENT sowie SDL_GETEVENT.

mask Maske mit deren Hilfe die Events ausgefiltert werden sollen, die von Interesse sind.



Beschreibung

SDL_PeepEvents prüft die Event-Warteschlange auf anstehende Nachrichten und liefert diese optional zurück.

Falls action gleich SDL_ADDEVENT ist, werden bis zu numevents Events an das Ende der Event-Warteschlange angefügt.

Falls action gleich SDL_PEEKEVENT ist, werden bis zu numevents Events, welche mask entsprechen, über events zurück geliefert. Die zurückgelieferten Events werden nicht aus der Warteschlange entfernt. Die Suche beginnt an der Spitze der Warteschlange.

Falls action gleich SDL_GETEVENT ist, werden bis zu numevents Events, welche mask entsprechen, über events zurück geliefert. Außerdem werden diese Events aus der Warteschlange entfernt. Die Suche beginnt an der Spitze der Warteschlange.


Der Parameter mask wird erstellt indem die Ergebnisse von SDL_EVENTMASK(event_type), für alle Ereignistypen die abgefragt werden sollen, bitweise OR-Verknüpft werden.

Diese Funktion ist threadsicher.

Rückgabewert

Liefert die Anzahl gespeicherter Events zurück, oder -1 falls ein Fehler aufgetreten ist.


Beispiel

Beispiel bitte hier nachliefern

Siehe auch

SDL_Event, SDL_PollEvent, SDL_PushEvent