xref: /petsc/src/sys/classes/draw/interface/dclear.c (revision 811af0c4b09a35de4306c442f88bd09fdc09897d)
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*811af0c4SBarry Smith    Collective on draw
118f69470aSLisandro Dalcin 
128f69470aSLisandro Dalcin    Input Parameters:
138f69470aSLisandro Dalcin .  draw - the drawing context
148f69470aSLisandro Dalcin 
158f69470aSLisandro Dalcin    Level: intermediate
168f69470aSLisandro Dalcin 
178f69470aSLisandro Dalcin @*/
189371c9d4SSatish Balay PetscErrorCode PetscDrawClear(PetscDraw draw) {
198f69470aSLisandro Dalcin   PetscFunctionBegin;
208f69470aSLisandro Dalcin   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
219566063dSJacob Faibussowitsch   if (draw->saveonclear) PetscCall(PetscDrawSave(draw));
22dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, clear);
238f69470aSLisandro Dalcin   PetscFunctionReturn(0);
248f69470aSLisandro Dalcin }
258f69470aSLisandro Dalcin 
265c6c1daeSBarry Smith /*@
275c6c1daeSBarry Smith    PetscDrawBOP - Begins a new page or frame on the selected graphical device.
285c6c1daeSBarry Smith 
29*811af0c4SBarry Smith    Logically Collective on draw
305c6c1daeSBarry Smith 
315c6c1daeSBarry Smith    Input Parameter:
325c6c1daeSBarry Smith .  draw - the drawing context
335c6c1daeSBarry Smith 
345c6c1daeSBarry Smith    Level: advanced
355c6c1daeSBarry Smith 
36db781477SPatrick Sanan .seealso: `PetscDrawEOP()`, `PetscDrawClear()`
375c6c1daeSBarry Smith @*/
389371c9d4SSatish Balay PetscErrorCode PetscDrawBOP(PetscDraw draw) {
395c6c1daeSBarry Smith   PetscFunctionBegin;
405c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
41dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, beginpage);
425c6c1daeSBarry Smith   PetscFunctionReturn(0);
435c6c1daeSBarry Smith }
445c6c1daeSBarry Smith /*@
455c6c1daeSBarry Smith    PetscDrawEOP - Ends a page or frame on the selected graphical device.
465c6c1daeSBarry Smith 
47*811af0c4SBarry Smith    Logically Collective on draw
485c6c1daeSBarry Smith 
495c6c1daeSBarry Smith    Input Parameter:
505c6c1daeSBarry Smith .  draw - the drawing context
515c6c1daeSBarry Smith 
525c6c1daeSBarry Smith    Level: advanced
535c6c1daeSBarry Smith 
54db781477SPatrick Sanan .seealso: `PetscDrawBOP()`, `PetscDrawClear()`
555c6c1daeSBarry Smith @*/
569371c9d4SSatish Balay PetscErrorCode PetscDrawEOP(PetscDraw draw) {
575c6c1daeSBarry Smith   PetscFunctionBegin;
585c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
59dbbe0bcdSBarry Smith   PetscTryTypeMethod(draw, endpage);
605c6c1daeSBarry Smith   PetscFunctionReturn(0);
615c6c1daeSBarry Smith }
62