xref: /petsc/src/sys/classes/draw/interface/dclear.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__ "PetscDrawClear"
9*5c6c1daeSBarry Smith /*@
10*5c6c1daeSBarry Smith    PetscDrawClear - Clears graphical output.
11*5c6c1daeSBarry Smith 
12*5c6c1daeSBarry Smith    Not collective (Use PetscDrawSynchronizedClear() for collective)
13*5c6c1daeSBarry Smith 
14*5c6c1daeSBarry Smith    Input Parameter:
15*5c6c1daeSBarry Smith .  draw - the drawing context
16*5c6c1daeSBarry Smith 
17*5c6c1daeSBarry Smith    Level: beginner
18*5c6c1daeSBarry Smith 
19*5c6c1daeSBarry Smith    Concepts: clear^window
20*5c6c1daeSBarry Smith 
21*5c6c1daeSBarry Smith .seealso: PetscDrawBOP(), PetscDrawEOP(), PetscDrawSynchronizedClear()
22*5c6c1daeSBarry Smith @*/
23*5c6c1daeSBarry Smith PetscErrorCode  PetscDrawClear(PetscDraw draw)
24*5c6c1daeSBarry Smith {
25*5c6c1daeSBarry Smith   PetscErrorCode ierr;
26*5c6c1daeSBarry Smith 
27*5c6c1daeSBarry Smith   PetscFunctionBegin;
28*5c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
29*5c6c1daeSBarry Smith   if (draw->ops->clear) {
30*5c6c1daeSBarry Smith     ierr = (*draw->ops->clear)(draw);CHKERRQ(ierr);
31*5c6c1daeSBarry Smith   }
32*5c6c1daeSBarry Smith   PetscFunctionReturn(0);
33*5c6c1daeSBarry Smith }
34*5c6c1daeSBarry Smith 
35*5c6c1daeSBarry Smith #undef __FUNCT__
36*5c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawBOP"
37*5c6c1daeSBarry Smith /*@
38*5c6c1daeSBarry Smith    PetscDrawBOP - Begins a new page or frame on the selected graphical device.
39*5c6c1daeSBarry Smith 
40*5c6c1daeSBarry Smith    Logically Collective on PetscDraw
41*5c6c1daeSBarry Smith 
42*5c6c1daeSBarry Smith    Input Parameter:
43*5c6c1daeSBarry Smith .  draw - the drawing context
44*5c6c1daeSBarry Smith 
45*5c6c1daeSBarry Smith    Level: advanced
46*5c6c1daeSBarry Smith 
47*5c6c1daeSBarry Smith .seealso: PetscDrawEOP(), PetscDrawClear()
48*5c6c1daeSBarry Smith @*/
49*5c6c1daeSBarry Smith PetscErrorCode  PetscDrawBOP(PetscDraw draw)
50*5c6c1daeSBarry Smith {
51*5c6c1daeSBarry Smith   PetscErrorCode ierr;
52*5c6c1daeSBarry Smith 
53*5c6c1daeSBarry Smith   PetscFunctionBegin;
54*5c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
55*5c6c1daeSBarry Smith   if (draw->ops->beginpage) {
56*5c6c1daeSBarry Smith     ierr = (*draw->ops->beginpage)(draw);CHKERRQ(ierr);
57*5c6c1daeSBarry Smith   }
58*5c6c1daeSBarry Smith   PetscFunctionReturn(0);
59*5c6c1daeSBarry Smith }
60*5c6c1daeSBarry Smith #undef __FUNCT__
61*5c6c1daeSBarry Smith #define __FUNCT__ "PetscDrawEOP"
62*5c6c1daeSBarry Smith /*@
63*5c6c1daeSBarry Smith    PetscDrawEOP - Ends a page or frame on the selected graphical device.
64*5c6c1daeSBarry Smith 
65*5c6c1daeSBarry Smith    Logically Collective on PetscDraw
66*5c6c1daeSBarry Smith 
67*5c6c1daeSBarry Smith    Input Parameter:
68*5c6c1daeSBarry Smith .  draw - the drawing context
69*5c6c1daeSBarry Smith 
70*5c6c1daeSBarry Smith    Level: advanced
71*5c6c1daeSBarry Smith 
72*5c6c1daeSBarry Smith .seealso: PetscDrawBOP(), PetscDrawClear()
73*5c6c1daeSBarry Smith @*/
74*5c6c1daeSBarry Smith PetscErrorCode  PetscDrawEOP(PetscDraw draw)
75*5c6c1daeSBarry Smith {
76*5c6c1daeSBarry Smith   PetscErrorCode ierr;
77*5c6c1daeSBarry Smith 
78*5c6c1daeSBarry Smith   PetscFunctionBegin;
79*5c6c1daeSBarry Smith   PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1);
80*5c6c1daeSBarry Smith   if (draw->ops->endpage) {
81*5c6c1daeSBarry Smith     ierr =  (*draw->ops->endpage)(draw);CHKERRQ(ierr);
82*5c6c1daeSBarry Smith   }
83*5c6c1daeSBarry Smith   PetscFunctionReturn(0);
84*5c6c1daeSBarry Smith }
85*5c6c1daeSBarry Smith 
86