xref: /petsc/src/sys/classes/draw/interface/dclear.c (revision c3339decea92175325d9368fa13196bcd0e0e58b)
15c6c1daeSBarry Smith /*
25c6c1daeSBarry Smith        Provides the calling sequences for all the basic PetscDraw routines.
35c6c1daeSBarry Smith */
4af0996ceSBarry Smith #include <petsc/private/drawimpl.h> /*I "petscdraw.h" I*/
55c6c1daeSBarry Smith 
65c6c1daeSBarry Smith /*@
75b399a63SLisandro Dalcin    PetscDrawClear - Clears graphical output. All processors must call this routine.
88f69470aSLisandro Dalcin    Does not return until the draw in context is clear.
98f69470aSLisandro Dalcin 
10*c3339decSBarry Smith    Collective
118f69470aSLisandro Dalcin 
128f69470aSLisandro Dalcin    Input Parameters:
138f69470aSLisandro Dalcin .  draw - the drawing context
148f69470aSLisandro Dalcin 
158f69470aSLisandro Dalcin    Level: intermediate
168f69470aSLisandro Dalcin 
178f69470aSLisandro Dalcin @*/
18d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDrawClear(PetscDraw draw)
19d71ae5a4SJacob Faibussowitsch {
208f69470aSLisandro Dalcin   PetscFunctionBegin;
218f69470aSLisandro Dalcin   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
229566063dSJacob Faibussowitsch   if (draw->saveonclear) PetscCall(PetscDrawSave(draw));
23dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, clear);
248f69470aSLisandro Dalcin   PetscFunctionReturn(0);
258f69470aSLisandro Dalcin }
268f69470aSLisandro Dalcin 
275c6c1daeSBarry Smith /*@
285c6c1daeSBarry Smith    PetscDrawBOP - Begins a new page or frame on the selected graphical device.
295c6c1daeSBarry Smith 
30*c3339decSBarry Smith    Logically Collective
315c6c1daeSBarry Smith 
325c6c1daeSBarry Smith    Input Parameter:
335c6c1daeSBarry Smith .  draw - the drawing context
345c6c1daeSBarry Smith 
355c6c1daeSBarry Smith    Level: advanced
365c6c1daeSBarry Smith 
37db781477SPatrick Sanan .seealso: `PetscDrawEOP()`, `PetscDrawClear()`
385c6c1daeSBarry Smith @*/
39d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDrawBOP(PetscDraw draw)
40d71ae5a4SJacob Faibussowitsch {
415c6c1daeSBarry Smith   PetscFunctionBegin;
425c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
43dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, beginpage);
445c6c1daeSBarry Smith   PetscFunctionReturn(0);
455c6c1daeSBarry Smith }
465c6c1daeSBarry Smith /*@
475c6c1daeSBarry Smith    PetscDrawEOP - Ends a page or frame on the selected graphical device.
485c6c1daeSBarry Smith 
49*c3339decSBarry Smith    Logically Collective
505c6c1daeSBarry Smith 
515c6c1daeSBarry Smith    Input Parameter:
525c6c1daeSBarry Smith .  draw - the drawing context
535c6c1daeSBarry Smith 
545c6c1daeSBarry Smith    Level: advanced
555c6c1daeSBarry Smith 
56db781477SPatrick Sanan .seealso: `PetscDrawBOP()`, `PetscDrawClear()`
575c6c1daeSBarry Smith @*/
58d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscDrawEOP(PetscDraw draw)
59d71ae5a4SJacob Faibussowitsch {
605c6c1daeSBarry Smith   PetscFunctionBegin;
615c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
62dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, endpage);
635c6c1daeSBarry Smith   PetscFunctionReturn(0);
645c6c1daeSBarry Smith }
65