xref: /petsc/src/sys/classes/draw/interface/dpause.c (revision 5c6c1daec53e1d9ab0bec9db5309fd8fc7645b8d)
1*5c6c1daeSBarry Smith 
2*5c6c1daeSBarry Smith /*
3*5c6c1daeSBarry Smith        Provides the calling sequences for all the basic PetscDraw routines.
4*5c6c1daeSBarry Smith */
5*5c6c1daeSBarry Smith #include <petsc-private/drawimpl.h>  /*I "petscdraw.h" I*/
6*5c6c1daeSBarry Smith 
7*5c6c1daeSBarry Smith #undef __FUNCT__
8*5c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawPause"
9*5c6c1daeSBarry Smith /*@
10*5c6c1daeSBarry Smith    PetscDrawPause - Waits n seconds or until user input, depending on input
11*5c6c1daeSBarry Smith                to PetscDrawSetPause().
12*5c6c1daeSBarry Smith 
13*5c6c1daeSBarry Smith    Collective operation on PetscDraw object.
14*5c6c1daeSBarry Smith 
15*5c6c1daeSBarry Smith    Input Parameter:
16*5c6c1daeSBarry Smith .  draw - the drawing context
17*5c6c1daeSBarry Smith 
18*5c6c1daeSBarry Smith    Level: beginner
19*5c6c1daeSBarry Smith 
20*5c6c1daeSBarry Smith    Concepts: waiting^for user input
21*5c6c1daeSBarry Smith    Concepts: drawing^waiting
22*5c6c1daeSBarry Smith    Concepts: graphics^waiting
23*5c6c1daeSBarry Smith 
24*5c6c1daeSBarry Smith .seealso: PetscDrawSetPause(), PetscDrawGetPause()
25*5c6c1daeSBarry Smith @*/
26*5c6c1daeSBarry Smith PetscErrorCode  PetscDrawPause(PetscDraw draw)
27*5c6c1daeSBarry Smith {
28*5c6c1daeSBarry Smith   PetscErrorCode ierr;
29*5c6c1daeSBarry Smith   PetscFunctionBegin;
30*5c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
31*5c6c1daeSBarry Smith   if (draw->ops->pause) {
32*5c6c1daeSBarry Smith     ierr = (*draw->ops->pause)(draw);CHKERRQ(ierr);
33*5c6c1daeSBarry Smith   }
34*5c6c1daeSBarry Smith   PetscFunctionReturn(0);
35*5c6c1daeSBarry Smith }
36