---

vmd.h

Go to the documentation of this file.

/***************************************************************************
 *cr
 *cr            (C) Copyright 1995-2019 The Board of Trustees of the
 *cr                        University of Illinois
 *cr                         All Rights Reserved
 *cr
 ***************************************************************************/

/***************************************************************************
 * RCS INFORMATION:
 *
 *      $RCSfile: vmd.h,v $
 *      $Author: johns $        $Locker:  $             $State: Exp $
 *      $Revision: 1.12 $       $Date: 2019/01/17 21:21:03 $
 *
 ***************************************************************************
 * DESCRIPTION:
 *
 * Main program interface header.
 *
 ***************************************************************************/

#ifndef VMD_H_
#define VMD_H_

// This header file contains all the functions exported by the VMD library
// for various VMD implementations; e.g. standalone executable, Python 
// module, etc.

#ifdef ANDROID
// prototype for main program JNI shared library entry point 
int VMDmain(int argc, char **argv);
#endif

#include "VMDApp.h"

// Perform various one-time startup operations prior to creating a
// VMDApp instance.  Reads the command line arguments, processes environnment
// variables, and prepares a set startup operations that will be carried
// out by VMDreadStartup.  Upon return, *argc will be set to the number of 
// unprocessed arguments that should be passed to VMDinit, including argv[0]
// (the path to the executable) and argv will hold the arguments themselves.
// The mpienabled flag tells VMD whether to initialize MPI or not
extern int VMDinitialize(int *argc, char ***argv, int mpienabled);

// Return the display type name that was chosen by VMDinitialize()
extern const char *VMDgetDisplayTypeName();

// Return the display location and display size that were chosen by
// VMDinitialize()
extern void VMDgetDisplayFrame(int *loc, int *size);

// read various default settings defined in scripts/vmd/.  Should be done
// after a successful VMDinitialize, but before VMDreadStartup().
void VMDreadInit(VMDApp *app);
 
// Get the unprocessed command line arguments 
// Read startup files (.vmdrc, -e files), and load molecules specified on
// the command line.  Must be called _after_ calling VMDinitialize()
extern void VMDreadStartup(VMDApp *);

// Shut down VMD properly, after all VMDApp instances have been deleted
// The mpienabled flag tells VMD whether to shutdown MPI or not
extern void VMDshutdown(int mpienabled);

// check for Fltk events, if available.
extern void VMDupdateFltk();

#endif

---