xref: /petsc/src/sys/classes/draw/impls/x/drawopenx.c (revision 09b68a49ed2854d1e4985cc2aa6af33c7c4e69b3)

/*
    Defines the operations for the X PetscDraw implementation.
*/

#include <../src/sys/classes/draw/impls/x/ximpl.h> /*I  "petscdraw.h" I*/

/*@
  PetscDrawOpenX - Opens an X-window for use with the `PetscDraw` routines.

  Collective

  Input Parameters:
+ comm    - the communicator that will share X-window
. display - the X display on which to open, or `NULL` for the local machine
. title   - the title to put in the title bar, or `NULL` for no title
. x       - the x screen coordinates of the upper left corner of window (or `PETSC_DECIDE`)
. y       - the y screen coordinates of the upper left corner of window (or `PETSC_DECIDE`)
. 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`)
- 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`)

  Output Parameter:
. draw - the drawing context.

  Options Database Keys:
+ -nox                    - Disables all x-windows output
. -display <name>         - Sets name of machine for the X display
. -draw_pause <pause>     - Sets time (in seconds) that the program pauses after `PetscDrawPause()` has been called
                            (0 is default, -1 implies until user input).
. -draw_cmap <name>       - Sets the colormap to use.
. -draw_cmap_reverse      - Reverses the colormap.
. -draw_cmap_brighten     - Brighten (0 < beta < 1) or darken (-1 < beta < 0) the colormap.
. -draw_x_shared_colormap - Causes PETSc to use a shared colormap. By default PETSc creates a separate color
                            for its windows, you must put the mouse into the graphics
                            window to see  the correct colors. This options forces
                            PETSc to use the default colormap which will usually result
                            in bad contour plots.
. -draw_fast              - Does not create colormap for contour plots.
. -draw_double_buffer     - Uses double buffering for smooth animation.
- -geometry               - Indicates location and size of window.

  Level: beginner

  Notes:
  If `x` and `y` are both `PETSC_DECIDE` then PETSc places the window automatically.

  When finished with the drawing context, it should be destroyed
  with `PetscDrawDestroy()`.

  Fortran Note:
  Whenever indicating null character data in a Fortran code,
  `PETSC_NULL_CHARACTER` must be employed. Thus, `PETSC_NULL_CHARACTER` can be
  used for the `display` and `title` input parameters.

.seealso: `PetscDrawFlush()`, `PetscDrawDestroy()`, `PetscDrawCreate()`, `PetscDrawOpnOpenGL()`
@*/
PetscErrorCode PetscDrawOpenX(MPI_Comm comm, const char display[], const char title[], int x, int y, int w, int h, PetscDraw *draw)
{
  PetscFunctionBegin;
  PetscCall(PetscDrawCreate(comm, display, title, x, y, w, h, draw));
  PetscCall(PetscDrawSetType(*draw, PETSC_DRAW_X));
  PetscFunctionReturn(PETSC_SUCCESS);
}