[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

Introduction

This manual describes the syntax and operations of the subroutines available in the graPHIGS API interface.

Calling Conventions for Subroutines

The graPHIGS API can be invoked from a number of programming languages. (To obtain language specific information, see The graPHIGS Programming Interface: Writing Applications Each invocation consists of the subroutine name with the appropriate parameters required by the subroutine. The graPHIGS API subroutine names are up to six characters long. Mnemonic conventions make the purpose of the subroutine calls evident in the names. Each subroutine name includes the 2-character prefix "GP" and the initial letter or letters from words in the subroutine name. All parameters must be specified in each subroutine and must be in the order shown in the subroutine description.

Request Control Parameter Codes

The Request Control Parameter (RCP) codes give alternative access to the graPHIGS API subroutines. These codes comprise a system programmer's interface (SPI) which provides a common entry point (AFMASP) for the graPHIGS API For more information on using the SPI, see The graPHIGS Programming Interface: Writing Applications

graPHIGS API Subroutines

For each graPHIGS API subroutine, you will find a description of the subroutine, its purpose, the processing performed, a list and description of the parameters, a list of associated error codes and messages, a list of related subroutines, and the associated RCP code (used only in programming for the System Programming Interface)

The graPHIGS API subroutine groups are as follows:

  1. Control
  2. Output Primitives
  3. Attribute Structure Elements
  4. Miscellaneous Structure Elements
  5. Structure Operations
  6. Archive
  7. Workstation Table Operations
  8. Display
  9. Transformation
  10. Input
  11. Font
  12. Image
  13. Utility
  14. Error Handling
  15. Miscellaneous
  16. Inquire
  17. Compatibility
  18. Distributed Application Processing (DAP)
  19. Explicit Traversal

Subroutine Descriptions

The page preceding each group of subroutines presents a brief overview of the purpose and result caused by invoking the subroutines referenced within the given section. This introductory material highlights important information that applies to all the subroutines in that section.

Reference Manual Abbreviations

The following abbreviations are used frequently:

ADIB
Application Defaults Interface Block
ARCL
Archive Closed
AROP
Archive Open
ASAP
As Soon As Possible
ASF
Attribute Source Flag
ASTI
At Some Time
BNIG
Before Next Interaction Globally
BNIL
Before Next Interaction Locally
CMY
Cyan-Magenta-Yellow color model
CSID
Character Set Identifier
EDF
External Defaults File
HSV
Hue-Saturation-Value color model
NDT
Nucleus Descriptor Table
NROP
Non-Retained Structure Open
NSL
Nucleus State List
PDT
graPHIGS API Description Table
PHCL
graPHIGS Closed
PHOP
graPHIGS Open
PSL
graPHIGS API State List
RGB
Red-Green-Blue color model
SSCL
Structure Store Close
SSL
Structure Store State List
SSOP
Structure Store Open
STCL
Structure Closed
STOP
Structure Open
UQUM
Quick Update Method
USL
Utility State List
WAIT
When Application Requests It
WDO
Workstation-Dependent Output
WDT
Workstation Description Table
WSCL
Workstation Closed
WSID
Workstation Identifier
WSL
Workstation State List
WSOP
Workstation Open
WSSL
Workstation Selected
WSTYPE
Workstation Type

The following abbreviations for coordinate spaces are used:

DC
Device Coordinates
MC
Modeling Coordinates
NPC
Normalized Projection Coordinates
VC
Viewing Coordinates
WC
World Coordinates
WU
Window Units

Note: For more information, see The graPHIGS Programming Interface: Understanding Concepts



[ Previous | Next | Contents | Glossary | Home | Search ]