xref: /petsc/src/sys/classes/draw/impls/x/drawopenx.c (revision 66af8762ec03dbef0e079729eb2a1734a35ed7ff)
1 /*
2     Defines the operations for the X PetscDraw implementation.
3 */
4 
5 #include <../src/sys/classes/draw/impls/x/ximpl.h> /*I  "petscsys.h" I*/
6 
7 /*@C
8   PetscDrawOpenX - Opens an X-window for use with the `PetscDraw` routines.
9 
10   Collective
11 
12   Input Parameters:
13 + comm    - the communicator that will share X-window
14 . display - the X display on which to open, or `NULL` for the local machine
15 . title   - the title to put in the title bar, or `NULL` for no title
16 . x       - the x screen coordinates of the upper left corner of window (or `PETSC_DECIDE`)
17 . y       - the y screen coordinates of the upper left corner of window (or `PETSC_DECIDE`)
18 . w       - the screen width in pixels of (or `PETSC_DRAW_HALF_SIZE`, `PETSC_DRAW_FULL_SIZE`, or `PETSC_DRAW_THIRD_SIZE` or `PETSC_DRAW_QUARTER_SIZE`)
19 - h       - the screen height in pixels of (or `PETSC_DRAW_HALF_SIZE`, `PETSC_DRAW_FULL_SIZE`, or `PETSC_DRAW_THIRD_SIZE` or `PETSC_DRAW_QUARTER_SIZE`)
20 
21   Output Parameter:
22 . draw - the drawing context.
23 
24   Options Database Keys:
25 + -nox                    - Disables all x-windows output
26 . -display <name>         - Sets name of machine for the X display
27 . -draw_pause <pause>     - Sets time (in seconds) that the
28        program pauses after PetscDrawPause() has been called
29        (0 is default, -1 implies until user input).
30 . -draw_cmap <name>       - Sets the colormap to use.
31 . -draw_cmap_reverse      - Reverses the colormap.
32 . -draw_cmap_brighten     - Brighten (0 < beta < 1) or darken (-1 < beta < 0) the colormap.
33 . -draw_x_shared_colormap - Causes PETSc to use a shared
34        colormap. By default PETSc creates a separate color
35        for its windows, you must put the mouse into the graphics
36        window to see  the correct colors. This options forces
37        PETSc to use the default colormap which will usually result
38        in bad contour plots.
39 . -draw_fast              - Does not create colormap for contour plots.
40 . -draw_double_buffer     - Uses double buffering for smooth animation.
41 - -geometry               - Indicates location and size of window.
42 
43   Level: beginner
44 
45   Notes:
46   If `x` and `y` are both `PETSC_DECIDE` then PETSc places the window automatically.
47 
48   When finished with the drawing context, it should be destroyed
49   with `PetscDrawDestroy()`.
50 
51   Fortran Notes:
52   Whenever indicating null character data in a Fortran code,
53   `PETSC_NULL_CHARACTER` must be employed; using NULL is not
54   correct for character data!  Thus, `PETSC_NULL_CHARACTER` can be
55   used for the display and title input parameters.
56 
57 .seealso: `PetscDrawFlush()`, `PetscDrawDestroy()`, `PetscDrawCreate()`, `PetscDrawOpnOpenGL()`
58 @*/
59 PetscErrorCode PetscDrawOpenX(MPI_Comm comm, const char display[], const char title[], int x, int y, int w, int h, PetscDraw *draw)
60 {
61   PetscFunctionBegin;
62   PetscCall(PetscDrawCreate(comm, display, title, x, y, w, h, draw));
63   PetscCall(PetscDrawSetType(*draw, PETSC_DRAW_X));
64   PetscFunctionReturn(PETSC_SUCCESS);
65 }
66