xref: /petsc/src/sys/classes/draw/interface/dclear.c (revision 8f69470a7058bcc0cf21d9492705f60bbdfc5aa4)
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 #undef __FUNCT__
75c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawClear"
85c6c1daeSBarry Smith /*@
95c6c1daeSBarry Smith    PetscDrawClear - Clears graphical output.
105c6c1daeSBarry Smith 
115c6c1daeSBarry Smith    Not collective (Use PetscDrawSynchronizedClear() for collective)
125c6c1daeSBarry Smith 
135c6c1daeSBarry Smith    Input Parameter:
145c6c1daeSBarry Smith .  draw - the drawing context
155c6c1daeSBarry Smith 
165c6c1daeSBarry Smith    Level: beginner
175c6c1daeSBarry Smith 
185c6c1daeSBarry Smith    Concepts: clear^window
195c6c1daeSBarry Smith 
205c6c1daeSBarry Smith .seealso: PetscDrawBOP(), PetscDrawEOP(), PetscDrawSynchronizedClear()
215c6c1daeSBarry Smith @*/
225c6c1daeSBarry Smith PetscErrorCode  PetscDrawClear(PetscDraw draw)
235c6c1daeSBarry Smith {
245c6c1daeSBarry Smith   PetscErrorCode ierr;
255c6c1daeSBarry Smith 
265c6c1daeSBarry Smith   PetscFunctionBegin;
275c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
285c6c1daeSBarry Smith   if (draw->ops->clear) {
295c6c1daeSBarry Smith     ierr = (*draw->ops->clear)(draw);CHKERRQ(ierr);
305c6c1daeSBarry Smith   }
315c6c1daeSBarry Smith   PetscFunctionReturn(0);
325c6c1daeSBarry Smith }
335c6c1daeSBarry Smith 
345c6c1daeSBarry Smith #undef __FUNCT__
35*8f69470aSLisandro Dalcin #define __FUNCT__ "PetscDrawSynchronizedClear"
36*8f69470aSLisandro Dalcin /*@
37*8f69470aSLisandro Dalcin    PetscDrawSynchronizedClear - Clears graphical output. All processors must call this routine.
38*8f69470aSLisandro Dalcin    Does not return until the draw in context is clear.
39*8f69470aSLisandro Dalcin 
40*8f69470aSLisandro Dalcin    Collective on PetscDraw
41*8f69470aSLisandro Dalcin 
42*8f69470aSLisandro Dalcin    Input Parameters:
43*8f69470aSLisandro Dalcin .  draw - the drawing context
44*8f69470aSLisandro Dalcin 
45*8f69470aSLisandro Dalcin    Level: intermediate
46*8f69470aSLisandro Dalcin 
47*8f69470aSLisandro Dalcin    Concepts: clear^window
48*8f69470aSLisandro Dalcin 
49*8f69470aSLisandro Dalcin @*/
50*8f69470aSLisandro Dalcin PetscErrorCode  PetscDrawSynchronizedClear(PetscDraw draw)
51*8f69470aSLisandro Dalcin {
52*8f69470aSLisandro Dalcin   PetscErrorCode ierr;
53*8f69470aSLisandro Dalcin 
54*8f69470aSLisandro Dalcin   PetscFunctionBegin;
55*8f69470aSLisandro Dalcin   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
56*8f69470aSLisandro Dalcin   if (draw->ops->synchronizedclear) {
57*8f69470aSLisandro Dalcin     ierr = (*draw->ops->synchronizedclear)(draw);CHKERRQ(ierr);
58*8f69470aSLisandro Dalcin   }
59*8f69470aSLisandro Dalcin   PetscFunctionReturn(0);
60*8f69470aSLisandro Dalcin }
61*8f69470aSLisandro Dalcin 
62*8f69470aSLisandro Dalcin #undef __FUNCT__
635c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawBOP"
645c6c1daeSBarry Smith /*@
655c6c1daeSBarry Smith    PetscDrawBOP - Begins a new page or frame on the selected graphical device.
665c6c1daeSBarry Smith 
675c6c1daeSBarry Smith    Logically Collective on PetscDraw
685c6c1daeSBarry Smith 
695c6c1daeSBarry Smith    Input Parameter:
705c6c1daeSBarry Smith .  draw - the drawing context
715c6c1daeSBarry Smith 
725c6c1daeSBarry Smith    Level: advanced
735c6c1daeSBarry Smith 
745c6c1daeSBarry Smith .seealso: PetscDrawEOP(), PetscDrawClear()
755c6c1daeSBarry Smith @*/
765c6c1daeSBarry Smith PetscErrorCode  PetscDrawBOP(PetscDraw draw)
775c6c1daeSBarry Smith {
785c6c1daeSBarry Smith   PetscErrorCode ierr;
795c6c1daeSBarry Smith 
805c6c1daeSBarry Smith   PetscFunctionBegin;
815c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
825c6c1daeSBarry Smith   if (draw->ops->beginpage) {
835c6c1daeSBarry Smith     ierr = (*draw->ops->beginpage)(draw);CHKERRQ(ierr);
845c6c1daeSBarry Smith   }
855c6c1daeSBarry Smith   PetscFunctionReturn(0);
865c6c1daeSBarry Smith }
875c6c1daeSBarry Smith #undef __FUNCT__
885c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawEOP"
895c6c1daeSBarry Smith /*@
905c6c1daeSBarry Smith    PetscDrawEOP - Ends a page or frame on the selected graphical device.
915c6c1daeSBarry Smith 
925c6c1daeSBarry Smith    Logically Collective on PetscDraw
935c6c1daeSBarry Smith 
945c6c1daeSBarry Smith    Input Parameter:
955c6c1daeSBarry Smith .  draw - the drawing context
965c6c1daeSBarry Smith 
975c6c1daeSBarry Smith    Level: advanced
985c6c1daeSBarry Smith 
995c6c1daeSBarry Smith .seealso: PetscDrawBOP(), PetscDrawClear()
1005c6c1daeSBarry Smith @*/
1015c6c1daeSBarry Smith PetscErrorCode  PetscDrawEOP(PetscDraw draw)
1025c6c1daeSBarry Smith {
1035c6c1daeSBarry Smith   PetscErrorCode ierr;
1045c6c1daeSBarry Smith 
1055c6c1daeSBarry Smith   PetscFunctionBegin;
1065c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
1075c6c1daeSBarry Smith   if (draw->ops->endpage) {
1085c6c1daeSBarry Smith     ierr =  (*draw->ops->endpage)(draw);CHKERRQ(ierr);
1095c6c1daeSBarry Smith   }
1105c6c1daeSBarry Smith   PetscFunctionReturn(0);
1115c6c1daeSBarry Smith }
112