Ooogles

Ooogles - OpenGL-ES 2.0 orienté objet

Ooogles est un wrapper Delphi ultra-mince orienté objet autour d'OpenGL-ES 2.0 avec un impact quasi nul sur les performances. Il peut également être utilisé pour créer des applications OpenGL pour les plates-formes de bureau à l'aide du sous-ensemble OpenGL-ES d'OpenGL.

Ce wrapper est encore assez bas. Il ne s'agit pas d'un "moteur de rendu" ou d'un framework de haut niveau, vous avez donc toujours besoin de connaissances OpenGL.

Les principaux objectifs d'Ooogles sont de rendre l'utilisation d'OpenGL-ES plus facile et moins sujette aux erreurs, en offrant un rapport d'erreurs dans les versions DEBUG et une meilleure expérience Code Insight dans l'IDE Delphi.

Caractéristiques

Ooogles présente les fonctionnalités suivantes :

• Encapsule les "objets" OpenGL dans des enregistrements + méthodes Delphi pour une interface OpenGL mieux organisée et plus facile à utiliser.
• Fournit un accès sécurisé à la plupart des constructions OpenGL. Par exemple:
  • En OpenGL, chaque "objet" n'est qu'un entier (ou Handle), et rien ne vous empêche d'appeler une API de texture sur un objet shader. Ce wrapper enveloppe l'API dans des classes (en fait des enregistrements) comme TGLTexture et TGLShader , empêchant ce type d'erreurs.
  • Une autre source importante d'erreurs OpenGL courantes consiste à utiliser des valeurs d'énumération incorrectes, entraînant des erreurs GL_INVALID_ENUM . Ce wrapper utilise à la place de véritables énumérations Delphi, évitant ainsi la plupart de ces erreurs.
• L'emballage est très fin. Les handles OpenGL ne sont pas encapsulés dans des classes Delphi ou des interfaces d’objet, mais plutôt dans des enregistrements. La plupart des méthodes sont intégrées et n'encapsulent qu'une seule API OpenGL. Ainsi, la surcharge du wrapper est pratiquement nulle.
• Quelques méthodes effectuent plusieurs appels OpenGL pour plus de commodité. Par exemple, lors de la compilation d'un shader, le wrapper appelle non seulement l'API de compilation, mais vérifie également les erreurs de compilation. En mode DEBUG , il exposera ces erreurs via des exceptions et enregistrera également tous les avertissements dans la console de débogage.
• Les API OpenGL qui ne sont pas liées à un "objet" OpenGL sont encapsulées dans la classe statique gl (qui agit davantage comme un espace de noms). Par exemple, l'API OpenGL glClear est enveloppée dans la méthode gl.Clear .
• Le wrapper fournit certaines fonctionnalités pour rendre les constructions spécifiques à OpenGL-ES compatibles avec OpenGL (de bureau). Par exemple, OpenGL-ES nécessite l'utilisation de qualificatifs de précision dans les fragment shaders, mais ceux-ci ne sont pas pris en charge par OpenGL. Ce wrapper modifiera la source du shader afin qu'il fonctionne également avec OpenGL.
• Le wrapper expose uniquement les méthodes compatibles OpenGL-ES, vous ne pouvez donc pas utiliser accidentellement des API qui fonctionnent uniquement avec OpenGL, mais pas avec OpenGL-ES. Cependant, vous avez toujours accès au handle OpenGL sous-jacent et vous pouvez donc l'utiliser directement avec l'API OpenGL si vous le souhaitez.
• Le wrapper gère les noms d'API parfois légèrement différents sur différentes plates-formes.
• Lors de la compilation avec la définition conditionnelle DEBUG et les assertions activées (la configuration par défaut pour les builds Debug), chaque appel OpenGL est vérifié pour les erreurs et une exception est levée lorsqu'une erreur se produit, indiquant le type d'erreur et dans quelle méthode elle s'est produite. Lorsque DEBUG n’est pas défini ou que les assertions sont désactivées, tout le code de vérification des erreurs est supprimé de la build afin qu’il n’ait aucun impact sur les performances.
• De plus, lors de la compilation en mode DEBUG avec les assertions activées, des avertissements seront enregistrés dans la console de débogage si vous oubliez de lier un objet avant de l'utiliser (ou lorsqu'un objet différent de celui que vous utilisez est actuellement lié).
• Le wrapper est bien documenté. Chaque enregistrement et méthode contient la documentation de la référence officielle OpenGL-ES 2.0, ainsi qu'une documentation personnalisée si nécessaire. La documentation montre également quels appels d'API OpenGL d'origine sont utilisés dans l'implémentation, pour faciliter la recherche d'une méthode si vous connaissez déjà l'équivalent de l'API.
• Livré avec divers exemples qui montrent comment utiliser ce wrapper. Ces exemples fonctionnent sous Windows, macOS, iOS et Android. Cependant, ils n'utilisent pas le framework FireMonkey, mais un framework personnalisé léger (et limité) que vous pouvez trouver dans le répertoire ExamplesCommon .

Non-fonctionnalités

Le wrapper ne fournit pas de fonctionnalités de niveau supérieur telles que la gestion automatique des ressources OpenGL. Vous devez libérer vous-même les ressources OpenGL lorsque vous n'en avez plus besoin. Les ressources sont généralement créées à l'aide d'une méthode appelée New et publiées à l'aide d'une méthode appelée Delete . Par exemple:

 var
  Texture: TGLTexture;
begin
  Texture.New;
  // Do something with texture
  Texture.Delete;
end ;

Je pourrai ajouter la gestion automatique des ressources à l'avenir si et quand Delphi obtient la prise en charge des finaliseurs d'enregistrement.

De plus, le wrapper ne prend en charge qu'OpenGL-ES version 2.0. Il ne prend pas en charge « l’ancienne » version 1 du pipeline de rendu à fonction fixe. Je pourrai ajouter la prise en charge de la version 3.0 et ultérieure une fois qu'elle sera proposée par Delphi et deviendra plus courante.

Dépendances

Ce wrapper n'a aucune dépendance autre que la nécessité de la bibliothèque FastMath. Cette bibliothèque offre (entre autres choses) des calculs mathématiques vectoriels et matriciels très rapides, ce qui la rend idéale pour une utilisation dans des applications hautes performances (OpenGL).

Commencer

Pour commencer :

• Assurez-vous que le répertoire FastMath est au même niveau que le répertoire Ooogles.
• Vous souhaitez généralement ajouter la définition conditionnelle FM_COLUMN_MAJOR à votre projet (pour Toutes les configurations - Toutes les plateformes). Cela permet le stockage des matrices par colonne, ce qui est plus logique pour les applications OpenGL.
• Après avoir créé et activé votre contexte OpenGL, appelez InitOoogles . Ceci est nécessaire pour émuler OpenGL-ES sur les plateformes OpenGL. Si votre application utilise plusieurs contextes, vous devez appeler InitOoogles une fois pour chaque contexte (après l'avoir rendu actuel). Jetez un œil aux unités Sample.Platform.* pour savoir quand appeler cela.
• Lorsque vous utilisez Ooogles dans votre unité, vous pouvez obtenir des indications du compilateur indiquant quelque chose comme "H2443 La fonction Inline X n'a ​​pas été étendue car l'unité Y n'est pas spécifiée dans la liste USES" . En effet, Ooogles intègre la plupart des fonctions et Delphi nécessite que vous utilisiez les unités OpenGL pour que l'intégration fonctionne. Malheureusement, les noms de ces unités diffèrent selon la plate-forme (par exemple Winapi.OpenGL , iOSapi.OpenGLES etc). Pour faciliter l'utilisation des unités OpenGL correctes, il est plus simple d'inclure le fichier 'OpenGL.inc' dans vos clauses use, comme dans :

 uses
  { $INCLUDE 'OpenGL.inc' }
  Neslib.Ooogles;

Assurez-vous simplement d'"utiliser" au moins une autre unité après le fichier d'inclusion.

Cours principaux et documentation

Voici une liste des principales classes (en fait des enregistrements) utilisées dans Ooogles, ainsi que des liens vers leur documentation :

• gl : classe statique (ou espace de noms) pour les API OpenGL qui ne sont pas liées à un objet spécifique.
• TGLShader : un vertex ou un fragment shader.
• TGLProgram : un programme qui combine un vertex shader et un fragment shader.
• TGLVertexAttrib : représente un seul attribut de sommet dans un TGLProgram. Ce sont des variables marquées d’ attribute dans un vertex shader.
• TGLUniform : représente un uniforme dans un TGLProgram. Ce sont des variables marquées d' uniform dans un vertex ou un fragment shader.
• TGLBuffer : un tampon de tableau (de sommets) ou un tampon de tableau d'éléments (d'index).
• TGLTexture : une texture 2D ou une texture cubemap.
• TGLFramebuffer : un framebuffer.
• TGLRenderbuffer : un tampon de rendu. Sert de stockage pour un TGLFramebuffer.

Mappage d'OpenGL vers Ooogles

Si vous maîtrisez OpenGL, le tableau suivant peut vous être utile pour traduire une API OpenGL vers une méthode Ooogles. Tout devrait être assez simple.

OpenGL	Ooogles
glActiveTexture	TGLTexture.BindToTextureUnit
glAttachShader	TGLProgram.AttachShader
glBindAttribLocation	TGLVertexAttrib.Bind
glBindBuffer	TGLBuffer.Bind
glBindFramebuffer	TGLFramebuffer.Bind
glBindTexture	TGLTexture.Bind
glBlendColor	gl.BlendColor
glBlendEquation	gl.BlendEquation
glBlendEquationSeparate	gl.BlendEquationSeparate
glBlendFunc	gl.BlendFunc
glBlendFuncSeparate	gl.BlendFuncSeparate
glBufferData	TGLBuffer.Data
glBufferSubData	TGLBuffer.SubData
glCheckFramebufferStatus	TGLFramebuffer.Status
glEffacer	gl.Effacer
glClearColor	gl.ClearColor
glClearDepthf	gl.ClearDepth
glClearPochoir	gl.ClearStencil
glColorMask	gl.ColorMask
glCompileShader	TGLShader.Compile
glCompressedTexImage2D	TGLTexture.UploadCompressed
glCompressedTexSubImage2D	TGLTexture.SubUploadCompressed
glCopieTexImage2D	TGLTexture.Copie
glCopieTexSubImage2D	TGLTexture.SubCopy
glCréerProgramme	TGLProgram.Nouveau
glCréerShader	TGLShader.Nouveau
glCullFace	gl.CullFace
glSupprimerBuffers	TGLBuffer.Supprimer
glDeleteFramebuffers	TGLFramebuffer.Delete
glSupprimerProgramme	TGLProgram.Delete
glDeleteRenderbuffers	TGLRenderbuffer.Delete
glSupprimerShader	TGLShader.Delete
glSupprimerTextures	TGLTexture.Supprimer
glDepthFunc	gl.DepthFunc
glDepthMask	gl.DepthMask
glDepthRangef	gl.DepthRange
glDetachShader	TGLProgram.DetachShader
glDésactiver	gl.Désactiver
glDisableVertexAttribArray	TGLVertexAttrib.Disable
glDrawArrays	gl.DrawArrays
glDrawElements	gl.DrawElements
glActiver	gl.Activer
glEnableVertexAttribArray	TGLVertexAttrib.Enable
glFinition	gl.Finition
glFlush	gl.Flush
glFramebufferRenderbuffer	TGLFramebuffer.AttachRenderbuffer
glFramebufferTexture2D	TGLFramebuffer.AttachTexture
glFrontFace	gl.FrontFace
glGenBuffers	TGLBuffer.Nouveau
glGenFramebuffers	TGLFramebuffer.Nouveau
glGenRenderbuffers	TGLRenderbuffer.Nouveau
glGenTextures	TGLTexture.Nouveau
glGenerateMipmap	TGLTexture.GenerateMipmap
glGetBooleanv	diverses méthodes Get*
glObtenirFloatv	diverses méthodes Get*
glObtenirEntierv	diverses méthodes Get*
glGetActiveAttrib	TGLProgram.GetAttributeInfo
glGetActiveUniform	TGLProgram.GetUniformInfo
glGetAttachedShaders	TGLProgram.GetAttachedShaders
glGetAttribLocation	TGLVertexAttrib.Init
glGetBufferParameteriv	TGLBuffer.Get*
glObtenirErreur	gl.GetError
glGetFramebufferAttachmentParameteriv	TGLFramebuffer.Get*
glGetProgramInfoLog	Programme TGL (en mode DEBUG)
glGetProgramiv	TGLProgram.Get*
glGetRenderbufferParameteriv	TGLRenderbuffer.Get*
glGetShaderInfoLog	TGLShader (en mode DÉBOGAGE)
glGetShaderSource	TGLShader.GetSource
glObtenirShaderiv	TGLShader.Get*
glObtenirChaîne	gl.Obtenir*
glGetTexParamètre*	TGLTexture.Get*
glObtenirUniforme	TGLUniform.GetValue
glGetUniformLocation	TGLUniform.Init
glGetVertexAttrib*	TGLVertexAttrib.Get*
glGetVertexAttribPointerv	TGLVertexAttrib.GetOffset/GetData
glIndice	TGLTexture.MipmapHint
glIsBuffer	pas nécessaire
glIsEnabled	gl.IsEnabled
glIsFramebuffer	pas nécessaire
glIsProgramme	pas nécessaire
glIsRenderbuffer	pas nécessaire
glIsShader	pas nécessaire
glIsTexture	pas nécessaire
glLineWidth	gl.LineWidth
glLinkProgram	TGLProgram.Link
glPixelStorei	gl.PixelStore
glPolygonOffset	gl.PolygonOffset
glLirePixels	TGLFramebuffer.ReadPixels
glReleaseShaderCompiler	TGLShader.ReleaseCompiler
glRenderbufferStorage	TGLRenderbuffer.Storage
glSampleCoverage	gl.SampleCoverage
glCiseaux	gl.Ciseaux
glShaderSource	TGLShader.SetSource
glStencilFunc	gl.StencilFunc
glStencilFuncSeparate	gl.StencilFuncSeparate
glPochoirMasque	gl.StencilMask
glStencilMaskSéparé	gl.StencilMaskSeparate
glStencilOp	gl.StencilOp
glStencilOpSeparate	gl.StencilOpSeparate
glTexImage2D	TGLTexture.Télécharger
glTexParamètre	TGLTexture.MinFilter/MagFilter/WrapS/WrapT
glTexSubImage2D	TGLTexture.SubUpload
glUniforme*	TGLUniform.SetValue/SetValues
glUseProgram	TGLProgram.Utilisation
glValidateProgramme	TGLProgram.Validate
glVertexAttrib*	TGLVertexAttrib.SetValue
glVertexAttribPointer	TGLVertexAttrib.SetConfig/SetData
glViewport	gl.Viewport