xref: /petsc/include/petscdrawtypes.h (revision 4ad8454beace47809662cdae21ee081016eaa39a)
1 #pragma once
2 
3 /* SUBMANSEC = Draw */
4 
5 /*J
6    PetscDrawType - String with the name of a `PetscDraw` implementation, for example `PETSC_DRAW_X` is for X Windows.
7 
8    Level: beginner
9 
10 .seealso: `PetscDrawSetType()`, `PetscDraw`, `PetscViewer`, `PetscDrawCreate()`, `PetscDrawRegister()`
11 J*/
12 typedef const char *PetscDrawType;
13 #define PETSC_DRAW_X     "x"
14 #define PETSC_DRAW_NULL  "null"
15 #define PETSC_DRAW_WIN32 "win32"
16 #define PETSC_DRAW_TIKZ  "tikz"
17 #define PETSC_DRAW_IMAGE "image"
18 
19 /*S
20    PetscDraw - Abstract PETSc object for graphics, often represents a window on the screen
21 
22    Level: beginner
23 
24 .seealso: `PetscDrawCreate()`, `PetscDrawSetType()`, `PetscDrawType`
25 S*/
26 typedef struct _p_PetscDraw *PetscDraw;
27 
28 /*S
29    PetscDrawAxis - An object that manages X-Y axis for a `PetscDraw`
30 
31    Level: advanced
32 
33 .seealso: `PetscDraw`, `PetscDrawAxisCreate()`, `PetscDrawAxisSetLimits()`, `PetscDrawAxisSetColors()`, `PetscDrawAxisSetLabels()`
34 S*/
35 typedef struct _p_PetscDrawAxis *PetscDrawAxis;
36 
37 /*S
38    PetscDrawLG - An object that manages drawing simple x-y plots
39 
40    Level: advanced
41 
42 .seealso: `PetscDrawAxis`, `PetscDraw`, `PetscDrawBar`, `PetscDrawHG`, `PetscDrawSP`, `PetscDrawAxisCreate()`, `PetscDrawLGCreate()`, `PetscDrawLGAddPoint()`
43 S*/
44 typedef struct _p_PetscDrawLG *PetscDrawLG;
45 
46 /*S
47    PetscDrawSP - An object that manages drawing scatter plots
48 
49    Level: advanced
50 
51 .seealso: `PetscDrawAxis`, `PetscDraw`, `PetscDrawLG`, `PetscDrawBar`, `PetscDrawHG`, `PetscDrawSPCreate()`
52 S*/
53 typedef struct _p_PetscDrawSP *PetscDrawSP;
54 
55 /*S
56    PetscDrawHG - An object that manages drawing histograms
57 
58    Level: advanced
59 
60 .seealso: `PetscDrawAxis`, `PetscDraw`, `PetscDrawLG`, `PetscDrawBar`, `PetscDrawSP`, `PetscDrawHGCreate()`
61 S*/
62 typedef struct _p_PetscDrawHG *PetscDrawHG;
63 
64 /*S
65    PetscDrawBar - An object that manages drawing bar graphs
66 
67    Level: advanced
68 
69 .seealso: `PetscDrawAxis`, `PetscDraw`, `PetscDrawLG`, `PetscDrawHG`, `PetscDrawSP`, `PetscDrawBarCreate()`
70 S*/
71 typedef struct _p_PetscDrawBar *PetscDrawBar;
72