NGPICT(3NCARG)

✨ NGPICT ✨

okay bestie, gather round 💖 this one lives in the NCAR GRAPHICS corner of the 3NCARG manuals and it is genuinely so useful. it's the move where you go "pause the whole picture-drawing situation for a sec" inside a FORTRAN program that's using GKS.

and here's the tea: what actually happens depends on whether the workstation you point at is a metafile or an output/input workstation. plus there's an option that prompts the user when an output/input workstation is all ready and just... waiting after a pause. main character energy tbh 🎀

---

🌸 NAME 🌸

NGPICT — effects a break in the picture drawing sequence in a FORTRAN code using GKS. The actions taken depend on whether the designated workstation is a metafile or an output/input workstation. An option is provided for prompting the user when an output/input workstation is ready and waiting after a pause.

---

🦋 SYNOPSIS 🦋

CALL NGPICT(WKID,ACTION)

---

🎀 C-BINDING SYNOPSIS 🎀

#include <ncarg/ncargC.h>

void c_ngpict(int wkid, int action)

---

💅 DESCRIPTION 💅

• WKID — an input parameter of type INTEGER which designates the workstation identifier of a workstation as it was specified in a GOPWK call.
• ACTION — an input parameter of type INTEGER the value of which specifies the action to be taken on the workstation WKID. Legal values are:
  0. Execute an UPDATE WORKSTATION on WKID.
  1. Execute an UPDATE WORKSTATION followed by a CLEAR WORKSTATION.
  2. Execute an UPDATE WORKSTATION followed by a pause waiting for a mouse click or a key click.
  3. Execute an UPDATE WORKSTATION followed by a pause followed by a CLEAR WORKSTATION after the pause has been terminated by a mouse click or a key click.
  4. Same as 3 except a "<READY>" prompt is issued in the lower left corner of the window after the UPDATE WORKSTATION.

---

🌈 C-BINDING DESCRIPTION 🌈

The C binding argument descriptions are the same as the FORTRAN argument descriptions. no notes, same vibe, slay ✨

---

💖 USAGE 💖

okay so here's the important part, bestie, listen up 👑

If WKID designates a metafile, then a CLEAR WORKSTATION is done which inserts an END PICTURE into the metafile. The result produced in this case would be the same as that resulting from a call to FRAME. The only valid actions for a metafile workstation are 0 and 1.

⚠️ literally only 0 and 1 for metafiles. don't try the others, they're not it. 💀

NGPICT is designed to be used when more precise control over individual workstations is desired than that offered by FRAME. This might be desirable, for example, when an application is controlling several simultaneously active workstations. To use NGPICT one should be opening GKS workstations with GOPWK rather than with OPNGKS.

---

🔥 EXAMPLES 🔥

If WKID=2 designates a metafile workstation, then

CALL NGPICT(2,1)

would duplicate the action of a FRAME call.

If WKID=2 designates an X11 workstation, then

CALL NGPICT(2,4)

would cause a pause in the X11 window and wait for a key click or a mouse click. A "<READY>" prompt, indicating that the window is waiting for a mouse click or a key click, would appear at the lower left of the X11 window after the window has been updated. After a mouse click in the X11 window, that window will be cleared before program execution continues.

---

🫶 ACCESS 🫶

To use NGPICT or c_ngpict, load the NCAR Graphics libraries ncarg, ncarg_gks, and ncarg_c, preferably in that order. yes the order matters, do it in that order, trust 🧚

---

💜 MESSAGES 💜

Non-fatal errors are reported for values of ACTION out of range and for values of ACTION inappropriately applied to a metafile. Also, a non-fatal error is reported if NGPICT is called while a segment is open.

(not fatal, so like... you'll live, but it's giving a warning bestie 😭)

---

⭐ SEE ALSO ⭐

• Online: frame(3NCARG), gflash(3NCARG), gopwk(3NCARG), opngks(3NCARG), gclrwk(3NCARG), gupwk(3NCARG), ncarg_cbind(3NCARG)
• Online URL: http://ngwww.ucar.edu/ngdoc/ng/gks/gkshome.html
• Hardcopy: NCAR Graphics Contouring and Mapping Tutorial; NCAR Graphics Fundamentals, UNIX Version;

---

👑 COPYRIGHT 👑

Copyright (C) 1987-2009 University Corporation for Atmospheric Research The use of this Software is governed by a License Agreement.

---

and that's the whole page, bestie!! 🎀 this one came out of the UNIX manual set, dated March 1993, and it's filed under NGPICT(3NCARG). periodt. 💅✨