App Class Reference

classe application. More...

#include <app.h>

Inheritance diagram for App:

Public Member Functions
	App (const int width, const int height, const int major=3, const int minor=3, const int samples=0)
	constructeur, dimensions de la fenetre et version d'openGL.
virtual int	init ()=0
	a deriver pour creer les objets openGL. renvoie -1 pour indiquer une erreur, 0 sinon.
virtual int	quit ()=0
	a deriver pour detruire les objets openGL. renvoie -1 pour indiquer une erreur, 0 sinon.
virtual int	update (const float time, const float delta)
	a deriver et redefinir pour animer les objets en fonction du temps.
virtual int	render ()=0
	a deriver pour afficher les objets. renvoie 1 pour continuer, 0 pour fermer l'application.
int	run ()
	execution de l'application.

Protected Member Functions
virtual int	prerender ()
virtual int	postrender ()
void	vsync_off ()

Protected Attributes
Window	m_window
Context	m_context
bool	sync

Detailed Description

classe application.

squelette d'application: creation d'une fenetre, d'un contexte openGL et gestion des evenements. tuto7.cpp et tuto8.cpp presentent un exemple simple d'utilisation.

la class App expose les fonctionnalites de window.h, elles sont juste presentees differemment. les fonctions globales de window.h sont toujours utilisables (a part run() qui est remplace par App::run()).

Definition at line 19 of file app.h.

Constructor & Destructor Documentation

App()

App::App	(	const int	width,
		const int	height,
		const int	major = 3,
		const int	minor = 3,
		const int	samples = 0 )

constructeur, dimensions de la fenetre et version d'openGL.

Definition at line 11 of file app.cpp.

    : m_window(nullptr), m_context(nullptr), sync(true)
{
    m_window= create_window(width, height, major, minor, samples);
    m_context= create_context(m_window);
}

~App()

App::~App ( )

virtual

Definition at line 18 of file app.cpp.

{
    if(m_context)
        release_context(m_context);
    if(m_window)
        release_window(m_window);
}

Member Function Documentation

init()

virtual int App::init ( )

pure virtual

a deriver pour creer les objets openGL. renvoie -1 pour indiquer une erreur, 0 sinon.

Implemented in AppCamera, AppTime, ComputeBuffer, ComputeImage, DrawInstanceBuffer, DrawInstanceBuffer, DrawInstanceID, Histogram, Histogram, Histogram, ImageViewer, IS, MeshShader, MeshViewer, Pad, ReadBuffer, ReadBuffer, RT, RT, StorageBuffer, StorageImage, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TPFramebuffer, Tuto2GL, and VertexCompute.

quit()

virtual int App::quit ( )

pure virtual

a deriver pour detruire les objets openGL. renvoie -1 pour indiquer une erreur, 0 sinon.

Implemented in AppCamera, AppTime, ComputeBuffer, ComputeImage, DrawInstanceBuffer, DrawInstanceBuffer, DrawInstanceID, Histogram, Histogram, Histogram, ImageViewer, IS, MeshShader, MeshViewer, Pad, ReadBuffer, ReadBuffer, RT, RT, StorageBuffer, StorageImage, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TPFramebuffer, Tuto2GL, and VertexCompute.

update()

virtual int App::update ( const float time, const float delta )

inlinevirtual

a deriver et redefinir pour animer les objets en fonction du temps.

Reimplemented in AppCamera, AppTime, DrawInstanceBuffer, DrawInstanceBuffer, DrawInstanceID, Pad, StorageImage, TP, TP, TP, TP, TP, and TPFramebuffer.

Definition at line 32 of file app.h.

{ return 0; }

render()

virtual int App::render ( )

pure virtual

a deriver pour afficher les objets. renvoie 1 pour continuer, 0 pour fermer l'application.

Implemented in AppCamera, AppTime, ComputeBuffer, ComputeImage, DrawInstanceBuffer, DrawInstanceBuffer, DrawInstanceID, Histogram, Histogram, Histogram, ImageViewer, IS, MeshShader, MeshViewer, Pad, ReadBuffer, ReadBuffer, RT, RT, StorageBuffer, StorageImage, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TP, TPFramebuffer, Tuto2GL, and VertexCompute.

run()

int App::run

(

)

execution de l'application.

Definition at line 36 of file app.cpp.

{
    if(init() < 0)
        return -1;
    
    // configure openGL
    glViewport(0, 0, window_width(), window_height());
    
    // gestion des evenements
    while(events(m_window))
    {
        if(prerender() < 0)
            break;
        
        if(render() < 1)
            break;
        
        if(postrender() < 0)
            break;
        
        // presenter le resultat
        SDL_GL_SwapWindow(m_window);
        
        // force openGL a finir d'executer toutes les commandes, 
        // cf https://www.khronos.org/opengl/wiki/Swap_Interval#GPU_vs_CPU_synchronization
        // devrait limiter la consommation sur portable
        if(sync)
            glFinish();
    }
    
    if(quit() < 0)
        return -1;
    
    // tout c'est bien passe...
    return 0;
}

prerender()

virtual int App::prerender ( )

inlineprotectedvirtual

Definition at line 40 of file app.h.

{ return update(global_time(), delta_time()); }

postrender()

virtual int App::postrender ( )

inlineprotectedvirtual

Definition at line 41 of file app.h.

{ return 0; }

vsync_off()

void App::vsync_off ( )

protected

Definition at line 26 of file app.cpp.

{
    // desactive vsync pour les mesures de temps
    SDL_GL_SetSwapInterval(0);
    printf("sync + vsync  OFF...\n");
    
    // desactive aussi la synchro cpu / gpu...
    sync= false;
}

Member Data Documentation

m_window

Window App::m_window

protected

Definition at line 45 of file app.h.

m_context

Context App::m_context

protected

Definition at line 46 of file app.h.

sync

bool App::sync

protected

Definition at line 48 of file app.h.

---

The documentation for this class was generated from the following files:

• src/gKit/app.h
• src/gKit/app.cpp