xref: /petsc/src/sys/classes/draw/interface/dpause.c (revision 5fd668637986a8d8518383a9159eebc368e1d5b4)
15c6c1daeSBarry Smith 
25c6c1daeSBarry Smith /*
35c6c1daeSBarry Smith        Provides the calling sequences for all the basic PetscDraw routines.
45c6c1daeSBarry Smith */
55c6c1daeSBarry Smith #include <petsc-private/drawimpl.h>  /*I "petscdraw.h" I*/
65c6c1daeSBarry Smith 
75c6c1daeSBarry Smith #undef __FUNCT__
85c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawPause"
95c6c1daeSBarry Smith /*@
105c6c1daeSBarry Smith    PetscDrawPause - Waits n seconds or until user input, depending on input
115c6c1daeSBarry Smith                to PetscDrawSetPause().
125c6c1daeSBarry Smith 
135c6c1daeSBarry Smith    Collective operation on PetscDraw object.
145c6c1daeSBarry Smith 
155c6c1daeSBarry Smith    Input Parameter:
165c6c1daeSBarry Smith .  draw - the drawing context
175c6c1daeSBarry Smith 
185c6c1daeSBarry Smith    Level: beginner
195c6c1daeSBarry Smith 
205c6c1daeSBarry Smith    Concepts: waiting^for user input
215c6c1daeSBarry Smith    Concepts: drawing^waiting
225c6c1daeSBarry Smith    Concepts: graphics^waiting
235c6c1daeSBarry Smith 
245c6c1daeSBarry Smith .seealso: PetscDrawSetPause(), PetscDrawGetPause()
255c6c1daeSBarry Smith @*/
265c6c1daeSBarry Smith PetscErrorCode  PetscDrawPause(PetscDraw draw)
275c6c1daeSBarry Smith {
285c6c1daeSBarry Smith   PetscErrorCode ierr;
29*5fd66863SKarl Rupp 
305c6c1daeSBarry Smith   PetscFunctionBegin;
315c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
325c6c1daeSBarry Smith   if (draw->ops->pause) {
335c6c1daeSBarry Smith     ierr = (*draw->ops->pause)(draw);CHKERRQ(ierr);
345c6c1daeSBarry Smith   }
355c6c1daeSBarry Smith   PetscFunctionReturn(0);
365c6c1daeSBarry Smith }
37