added some java doc

This commit is contained in:
Marc-Pierre-Barbier
2020-09-07 08:01:10 +02:00
parent 589d6b7a80
commit 22ef65835d
@@ -38,17 +38,33 @@ public class CanevasView extends SurfaceView implements SurfaceHolder.Callback {
toDraw = new ArrayList<>(); toDraw = new ArrayList<>();
} }
/**
* cette fonction demare le thread graphique
* @param holder
*/
@Override @Override
public void surfaceCreated(@NonNull SurfaceHolder holder) { public void surfaceCreated(@NonNull SurfaceHolder holder) {
fullscreen = holder.getSurfaceFrame(); fullscreen = holder.getSurfaceFrame();
drawingThread.start(); drawingThread.start();
} }
/**
* cette fonction est appeler a chaque fois que l'utilisateur tourne son ecran
* this function is unused since the screen is locked
* @param surfaceHolder
* @param i
* @param i1
* @param i2
*/
@Override @Override
public void surfaceChanged(@NonNull SurfaceHolder surfaceHolder, int i, int i1, int i2) { public void surfaceChanged(@NonNull SurfaceHolder surfaceHolder, int i, int i1, int i2) {
} }
/**
* on surface destruction stop the thread
* @param surfaceHolder
*/
@Override @Override
public void surfaceDestroyed(@NonNull SurfaceHolder surfaceHolder) { public void surfaceDestroyed(@NonNull SurfaceHolder surfaceHolder) {
drawingThread.keepDrawing = false; drawingThread.keepDrawing = false;
@@ -57,6 +73,10 @@ public class CanevasView extends SurfaceView implements SurfaceHolder.Callback {
} catch (InterruptedException e) {} } catch (InterruptedException e) {}
} }
/**
* function ran for each frame to draw all the drawables
* @param canvas canevas on wich to draw on
*/
@Override @Override
protected void onDraw(Canvas canvas) { protected void onDraw(Canvas canvas) {
for(Drawable d : toDraw) for(Drawable d : toDraw)
@@ -65,6 +85,9 @@ public class CanevasView extends SurfaceView implements SurfaceHolder.Callback {
} }
} }
/**
* main drawing thread render each frame
*/
private class DrawingThread extends Thread { private class DrawingThread extends Thread {
public boolean keepDrawing = true; public boolean keepDrawing = true;