star-gs

Literate program for a geometric sensitivity calculation
git clone git://git.meso-star.fr/star-gs.git
Log | Files | Refs | README | LICENSE

sgs.h (2231B)


      1 /* Copyright (C) 2021-2023 Centre National de la Recherche Scientifique
      2  * Copyright (C) 2021-2023 INSA Lyon
      3  * Copyright (C) 2021-2023 Institut Mines Télécom Albi-Carmaux
      4  * Copyright (C) 2021-2023 |Méso|Star> (contact@meso-star.com)
      5  * Copyright (C) 2021-2023 Institut Pascal
      6  * Copyright (C) 2021-2023 PhotonLyX (info@photonlyx.com)
      7  * Copyright (C) 2021-2023 Université de Lorraine
      8  * Copyright (C) 2021-2023 Université Paul Sabatier
      9  * Copyright (C) 2021-2023 Université Toulouse - Jean Jaurès
     10  *
     11  * This program is free software: you can redistribute it and/or modify
     12  * it under the terms of the GNU General Public License as published by
     13  * the Free Software Foundation, either version 3 of the License, or
     14  * (at your option) any later version.
     15  *
     16  * This program is distributed in the hope that it will be useful,
     17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
     18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     19  * GNU General Public License for more details.
     20  *
     21  * You should have received a copy of the GNU General Public License
     22  * along with this program. If not, see <http://www.gnu.org/licenses/>. */
     23 
     24 #ifndef SGS_H
     25 #define SGS_H
     26 
     27 #include <rsys/rsys.h>
     28 
     29 /* Forward declarations */
     30 struct mem_allocator;
     31 struct s3d_device;
     32 struct sgs;
     33 struct sgs_args;
     34 
     35 /*******************************************************************************
     36  * Helper functions
     37  ******************************************************************************/
     38 extern LOCAL_SYM void
     39 sgs_fprint_copyright
     40   (FILE* stream);
     41 
     42 extern LOCAL_SYM void
     43 sgs_fprint_license
     44   (FILE* stream);
     45 
     46 /*******************************************************************************
     47  * sgs API
     48  ******************************************************************************/
     49 extern LOCAL_SYM res_T
     50 sgs_create
     51   (struct mem_allocator* allocator, /* NULL <=> Use default allocator */
     52    const struct sgs_args* args,
     53    struct sgs** sgs);
     54 
     55 extern LOCAL_SYM void
     56 sgs_release
     57   (struct sgs* sgs);
     58 
     59 extern LOCAL_SYM res_T
     60 sgs_run
     61   (struct sgs* sgs);
     62 
     63 extern LOCAL_SYM struct mem_allocator*
     64 sgs_get_allocator
     65   (struct sgs* sgs);
     66 
     67 extern LOCAL_SYM struct s3d_device*
     68 sgs_get_s3d_device
     69   (struct sgs* sgs);
     70 
     71 #endif /* SGS_H */