Funktionsvorlage: Unterschied zwischen den Versionen
Flo (Diskussion | Beiträge) (Was haltet ihr von dieser Tabelle?) |
K (Rechtschreibung) |
||
| (25 dazwischenliegende Versionen von 12 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
= Vorlage für die OpenGL-Funktionsübersicht = | = Vorlage für die OpenGL-Funktionsübersicht = | ||
| − | Wenn ihr eine neue OpenGL-Funktion in die Funktionsübersicht einbinden wollt, nehmt euch bitte folgende Vorlage als Grundlage eures Textes (der Einheitlichkeit halber), und entfernt dann ggf. Kapitel die für den von euch gewählten Artikel nicht nötig sind : | + | Wenn ihr eine neue OpenGL-Funktion in die Funktionsübersicht einbinden wollt, nehmt euch bitte folgende Vorlage als Grundlage eures Textes (der Einheitlichkeit halber), und entfernt dann ggf. Kapitel, die für den von euch gewählten Artikel nicht nötig sind: |
| + | Bei SDL-Funktionen bitte diese [[SDL_Funktionsvorlage|Vorlage]] verwenden.<br> | ||
| + | Bei OpenAL-Funktionen bitte diese [[OpenAL_Funktionsvorlage|Vorlage]] verwenden. | ||
| + | Danke | ||
---- | ---- | ||
| Zeile 9: | Zeile 12: | ||
= Funktionsname = | = Funktionsname = | ||
| − | + | ||
| + | |||
== Name == | == Name == | ||
| − | |||
'''Name der Funktion''' - Beschreibung... | '''Name der Funktion''' - Beschreibung... | ||
| − | + | ||
| + | |||
== Delphi-Spezifikation == | == Delphi-Spezifikation == | ||
| − | + | Syntax der Funktion (bitte an die dglOpenGL.pas halten), vorerst auch '''nur''' Delphi-Syntax. Bitte haltet euch dabei an folgende Vorgabe, die der Formatierung der glMan-Pages entspricht, und die für das Wiki wichtigen Teile der Syntax hervorhebt: | |
| − | Syntax der Funktion (bitte an die dglOpenGL.pas halten), vorerst auch '''nur''' Delphi-Syntax | + | |
| + | procedure/function '''glBefehl'''(''parameter1'' : typ; ... ''parameterN'' : typ) [ : Rückgabewert] | ||
| + | |||
| + | Bitte achtet auch auf ein '''Leerzeichen''' vor der Funktionsdefinition, denn dann wird diese automatisch als Quellcode formatiert. | ||
| + | |||
| + | |||
| − | |||
== Parameter == | == Parameter == | ||
| − | |||
{| border="1" rules="all" | {| border="1" rules="all" | ||
| − | + | ! ''Parameter1'' | |
| − | |||
| − | |||
| − | ! ''Parameter1'' | ||
| Beschreibung1 | | Beschreibung1 | ||
|- | |- | ||
| − | ! ''Parameter2'' | + | ! ''Parameter2'' |
| Beschreibung2 | | Beschreibung2 | ||
|} | |} | ||
| − | |||
| − | == Beschreibung == | + | |
| − | + | == Beschreibung == | |
Detaillierte Beschreibung des Befehls | Detaillierte Beschreibung des Befehls | ||
| + | Haltet euch bitte an die Originalspezifikation. | ||
| + | Eigenes Wissen kann dann ergänzt werden. | ||
| + | Keine Infos weglassen! | ||
| + | |||
| + | |||
| − | |||
== Hinweise == | == Hinweise == | ||
| − | + | Bitte beachten, dass... | |
| − | Bitte beachten dass... | + | |
| + | |||
| + | |||
| + | == Änderungen == | ||
| + | Folgende Erweiterungen hat die Funktion erfahren: | ||
| + | === Ab OpenGL-Version X.X === | ||
| + | |||
| + | Hier eine Beschreibung der neuen Konstanten, Funktionalitäten etc. Dabei Links auf eventuell neue verwandte Funktionen | ||
| + | |||
| + | |||
| − | |||
== Fehlermeldungen == | == Fehlermeldungen == | ||
| − | + | '''GL_FEHLER''' wird generiert, wenn.... | |
| − | GL_FEHLER wird generiert wenn.... | + | |
| + | '''GL_INVALID_OPERATION''' wird generiert, wenn FUNCTIONNAME innerhalb eines [[glBegin]]-[[glEnd]]-Blocks aufgerufen wird. | ||
| + | |||
| + | |||
| + | |||
| + | == Zugehörige Wertrückgaben == | ||
| + | [[glGet]] mit Token [[glGet#GL_MEIN_TOKEN|GL_MEIN_TOKEN]] | ||
| + | Der Rückgabewert der Funktion gehört in den Abschnitt "Beschreibung". | ||
| + | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Siehe auch == | == Siehe auch == | ||
| − | + | Hier eine Liste (als Medialinks) von Befehlen die diesem ähnlich sind. Bitte alle Begriffe hintereinander und mit einem Komma voneinander trennen. | |
| − | Hier eine Liste (als Medialinks) von Befehlen die diesem ähnlich sind | + | |
| + | Zum Abschluss noch an diese Stelle den Artikel einer Kategorie zuordnen. z.B.<br> | ||
| + | '''<nowiki>[[Kategorie:GL|FuncNameOhneGLamAnfang]]</nowiki>''' | ||
---- | ---- | ||
Um diese Vorlage direkt zu nutzen, bitte diese Seite bearbeiten und die Vorlage direkt rauskopieren! | Um diese Vorlage direkt zu nutzen, bitte diese Seite bearbeiten und die Vorlage direkt rauskopieren! | ||
Aktuelle Version vom 10. Juli 2011, 15:06 Uhr
Inhaltsverzeichnis
Vorlage für die OpenGL-Funktionsübersicht
Wenn ihr eine neue OpenGL-Funktion in die Funktionsübersicht einbinden wollt, nehmt euch bitte folgende Vorlage als Grundlage eures Textes (der Einheitlichkeit halber), und entfernt dann ggf. Kapitel, die für den von euch gewählten Artikel nicht nötig sind:
Bei SDL-Funktionen bitte diese Vorlage verwenden.
Bei OpenAL-Funktionen bitte diese Vorlage verwenden.
Danke
Funktionsname
Name
Name der Funktion - Beschreibung...
Delphi-Spezifikation
Syntax der Funktion (bitte an die dglOpenGL.pas halten), vorerst auch nur Delphi-Syntax. Bitte haltet euch dabei an folgende Vorgabe, die der Formatierung der glMan-Pages entspricht, und die für das Wiki wichtigen Teile der Syntax hervorhebt:
procedure/function glBefehl(parameter1 : typ; ... parameterN : typ) [ : Rückgabewert]
Bitte achtet auch auf ein Leerzeichen vor der Funktionsdefinition, denn dann wird diese automatisch als Quellcode formatiert.
Parameter
| Parameter1 | Beschreibung1 |
|---|---|
| Parameter2 | Beschreibung2 |
Beschreibung
Detaillierte Beschreibung des Befehls Haltet euch bitte an die Originalspezifikation. Eigenes Wissen kann dann ergänzt werden. Keine Infos weglassen!
Hinweise
Bitte beachten, dass...
Änderungen
Folgende Erweiterungen hat die Funktion erfahren:
Ab OpenGL-Version X.X
Hier eine Beschreibung der neuen Konstanten, Funktionalitäten etc. Dabei Links auf eventuell neue verwandte Funktionen
Fehlermeldungen
GL_FEHLER wird generiert, wenn....
GL_INVALID_OPERATION wird generiert, wenn FUNCTIONNAME innerhalb eines glBegin-glEnd-Blocks aufgerufen wird.
Zugehörige Wertrückgaben
glGet mit Token GL_MEIN_TOKEN Der Rückgabewert der Funktion gehört in den Abschnitt "Beschreibung".
Siehe auch
Hier eine Liste (als Medialinks) von Befehlen die diesem ähnlich sind. Bitte alle Begriffe hintereinander und mit einem Komma voneinander trennen.
Zum Abschluss noch an diese Stelle den Artikel einer Kategorie zuordnen. z.B.
[[Kategorie:GL|FuncNameOhneGLamAnfang]]
Um diese Vorlage direkt zu nutzen, bitte diese Seite bearbeiten und die Vorlage direkt rauskopieren!
