Scrolled_t*_params(3NCARG)

✨ NAME ✨

Scrolled_title_params — this doc is the whole rundown of every single internal parameter that Scrolled_title has. all of them. no skips. 💅

🌸 DESCRIPTION 🌸

okay bestie so here's the tea: below you'll find descriptions of all the Scrolled_title internal parameters, listed in alphabetical order. each entry starts with a line that tells you the parameter name and what it defaults to, so you always know what you're getting if you don't touch anything.

• ALN — default 0 🎀 — this is a flag controlling whether alignment frames with dots in the corners get produced in non-test mode. ALN = 0 means "suppress them", ALN = 1 means "produce them", and ALN = 2 means "produce them and label the frames as alignment frames".
• BGC — default 0 🎨 — an integer specifying the color index to use for the background color. if BGC = 0, then GKS is depended upon to fill the background; otherwise, STITLE does a GFA call to fill it. (not me trusting GKS with the whole background, iykyk)
• BGF — default -2 🌈 — an integer specifying the type of background fade-in/fade-out.
  • the value -1 implies that background fades are suppressed.
  • the value -2 implies a fade from/to black by mapping RGB values to HSV values and varying V.
  • a non-negative value of the form ni x 1000 + no implies a fade-in from the color with color index ni and a fade-out to the color with color index no; for example, the value 11012 implies fading in from color 11 and out to color 12. use 999 to suppress one of the fades; for example, the value 26999 implies fading in from color 26, but no fade-out, while the value 999026 implies no fade-in, but a fade-out to color 26. these fades are done using linear interpolation in the RGB system.
• BGR, BGG, and BGB — default Device default. 💖 — real values, in the range 0. to 1., to be used for the red, green, and blue components of the background color. when one of these values is set, it defines a component of the color associated with the current value of the color index BGC.
• FGC — default 1 🌟 — an integer specifying the color index to be used for the default foreground color. all informative information on "test run" frames and all title lines for which no other color index is specified will be in the color specified by this color index.
• FGF — default -2 🌈 — an integer specifying the type of foreground fade-in/fade-out.
  • the value -1 implies that foreground fades are suppressed.
  • the value -2 implies a fade from/to black by mapping RGB values to HSV values and varying V.
  • a non-negative value of the form ni x 1000 + no implies a fade-in from the color with color index ni and a fade-out to the color with color index no; for example, the value 11012 implies fading in from color 11 and out to color 12. use 999 to suppress one of the fades; for example, the value 26999 implies fading in from color 26, but no fade-out, while the value 999026 implies no fade-in, but a fade-out to color 26. these fades are done using linear interpolation in the RGB system.
  • fades are done on all foreground colors known to STITLE because SLSETR has been called to define their RGB components or because their color indices have appeared on card images defined by the argument CRDS.
• FGR, FGG, and FGB — default Device default. 💜 — real values, in the range 0. to 1., to be used for the red, green, and blue components of a specified foreground color.
  • the index of the color being defined may be specified in parentheses following the FGR, FGG, or FGB; for example, the statement CALL SLSETR ('FGR(2)',.5) defines the red component of the color associated with color index 2 to be .5. if no subscript appears, the color index defined by the current value of FGC is the one whose definition is affected.
  • a color can also be defined by calling the GKS subroutine GSCR and specifying the color index on one of the card images in the CRDS array. note, however, that any color which is to be used solely in a user-supplied version of the routine SLUBKG and which is desired to be subject to fade-in/fade-out should be defined by means of SLSETR calls.
  • characters may be drawn in any of the foreground colors.
• FIN — default 0. ⏳ — number of seconds during which to fade in titles. the background color and foreground color are faded in independently. each color is faded in in the manner specified by the value of either BGF or FGF, whichever is appropriate.
• FOU — default 0. ⏳ — number of seconds during which to fade out titles. the background color and foreground color are faded out independently. each color is faded out in the manner specified by the value of either BGF or FGF, whichever is appropriate.
• GSZ — default 40. 📏 — value for interline spacing, defined in terms of a 1024x1024 grid. used only by FTITLE.
• ICO — default 1 📐 — centering option. set to 0 to get left edges lined up at X-coordinate 64, and to 2 to get right edges lined up at X-coordinate 960. set to 1 for centered text. used only by FTITLE.
• ICU — default 5 🎧 — unit number for reading input. used only by FTITLE.
• INC — default 300 📊 — vertical spacing between test frames.
• LOG — default 4 📓 — FORTRAN logical unit number for opening WISS (Workstation-Independent Segment Storage).
• LX1 — default 0 🪟 — integer, in the range 0 to 32767, specifying the X coordinate of the lower left corner of the viewport. use VPL, instead.
• LX2 — default 32767 🪟 — integer, in the range 0 to 32767, specifying the X coordinate of the upper right corner of the viewport. use VPR, instead.
• LY1 — default 0 🪟 — integer, in the range 0 to 32767, specifying the Y coordinate of the lower left corner of the viewport. use VPB, instead.
• LY2 — default 32767 🪟 — integer, in the range 0 to 32767, specifying the Y coordinate of the upper right corner of the viewport. use VPT, instead.
• MAP — default 100 🗺️ — internal parameter MA is to be set; otherwise, the user will be assumed to have set it. the default values of MAP and ORV are such as to create scrolled titles in the normal way; other values may be used to create titles that scroll upwards on the surface of the globe or that scroll off into space (a la Star Wars); the appropriate transformations need to be embedded in a user-written version of the Plotchar routine PCMPXY. (this is still rather new; eventually, there will be an example showing how to do this.)
• NFS — default 24. 🎬 — the number of frames per second. the default, 24, is appropriate for film. for video, use NFS = 30.
• NXE — default 512 ↔️ — analogous to the Scrolled_title argument IYND, to allow for limited scrolling in the X direction. NXE must be within the current Scrolled_title window.
• NXS — default 512 ↔️ — analogous to the Scrolled_title argument IYST, to allow for limited scrolling in the X direction. NXS must be within the current Scrolled_title window.
• ORV — default 1.E12 🔢 — if non-zero, the value to which Plotchar's internal parameter OR is to be set; otherwise, the user will be assumed to have set it. see the discussion of the parameter MAP, above.
• PSZ — default 21. 🔤 — default character height on a 1024 by 1024 grid.
• SBK — default 0 🌫️ — suppresses fade in/out of the background color when a fade in/out time has been specified. if SBK=0, then the fade in/out will be honored; otherwise, the background color will appear at full intensity during a fade in/out. this parameter has been superseded by BGF, which should be used instead. SBK = 0 is equivalent to BGF = -2, while SBK = 1 is equivalent to BGF = -1.

okay bestie heads up: SBK is superseded, so don't be out here building your whole look on it when BGF is right there. 👑

• SFG — default 0 🌫️ — suppresses fade in/out of the foreground color when a fade in/out time has been specified. if SFG=0, then the fade in/out will be honored; otherwise, the foreground color will appear at full intensity during a fade in/out. this parameter has been superseded by FGF, which should be used instead. SFG = 0 is equivalent to FGF = -2, while SFG = 1 is equivalent to FGF = -1.

same energy: SFG is superseded too, so FGF is the moment. 💅

• TM1 — default 1. ⏱️ — number of seconds worth of blank frames (at NFS frames/second) generated before any title frames produced by a call to FTITLE. used only by FTITLE.
• TM2 — default .5 ⏱️ — number of seconds worth of blank frames (at NFS frames/second), between sets of title frames, and after the last set of title frames, produced by a call to FTITLE. used only by FTITLE.
• TM3 — default 0. ⏱️ — number of additional seconds worth of blank frames (at NFS frames/second) after the last title frame produced by a call to FTITLE. TM3 may be negative to suppress some of the frames specified by TM2; the number of seconds of blank frames after the last title frame will be the sum of TM2 and TM3. used only by FTITLE.
• VPB — default 0. 🖼️ — a real, in the range from 0. to 1., specifying the Y coordinate of the bottom edge of the STITLE viewport.
  • the STITLE viewport is used in two ways: 1) characters are clipped at its edges; and 2) it defines the rectangle which is filled by STITLE when the value of BGC is non-zero.
  • changing the values of VPL, VPR, VPB, and VPT changes the values of LX1, LX2, LY1, and LY2 (and vice-versa); use of the names VPL, VPR, VPB, and VPT is now preferred.
• VPL — default 0. 🖼️ — a real, in the range from 0. to 1., specifying the X coordinate of the left edge of the STITLE viewport.
• VPR — default 0. 🖼️ — a real, in the range from 0. to 1., specifying the X coordinate of the right edge of the STITLE viewport.
• VPT — default 0. 🖼️ — a real, in the range from 0. to 1., specifying the Y coordinate of the top edge of the STITLE viewport.
• WID — default 9 🖥️ — workstation identifier for WISS (Workstation-Independent Segment Storage); this is used internally in the calls to Gflash.

🔭 SEE ALSO 🔭

Online: gflash, plotchar, slgeti, slgetr, slseti, slsetr, ncarg_cbind.

Hardcopy: NCAR Graphics Fundamentals, UNIX Version; User's Guide for NCAR GKS-0A Graphics

bestie this was part 1 🫶 the rest is still coming, don't go anywhere ✨

💖 COPYRIGHT 💖

okay bestie, final section, and it's the legal one — but it's short so we're fine 🫶

• Copyright (C) 1987-2009 — yeah, that's the whole run, from 1987 all the way to 2009. long-term commitment, we love that for them 👑
• University Corporation for Atmospheric Research — that's the whole entire entity holding the copyright. iconic institution behavior, no cap 🌈
• and the vibe check on using this software? The use of this Software is governed by a License Agreement. — so like, it's not a free-for-all, there's an actual license agreement calling the shots. read it, respect it, periodt 💅

and that's a wrap on Scrolled_t*_params(3NCARG), bestie!! 🎀 this page came from the UNIX manual, dated July 1995 — yes, 1995, she's vintage and she's still serving ✨ go forth and scroll responsibly, mwah 💜🦋🌸