GRASS GIS 8 Programmer's Manual
8.5.0dev(2025)-3df7050671
maskfd.c
Go to the documentation of this file.
1
/*!
2
* \file lib/raster/maskfd.c
3
*
4
* \brief Raster Library - Mask file descriptor and state.
5
*
6
* (C) 2001-2024 by the GRASS Development Team
7
*
8
* This program is free software under the GNU General Public License
9
* (>=v2). Read the file COPYING that comes with GRASS for details.
10
*
11
* \author Original author CERL
12
* \author Vaclav Petras (documentation)
13
*/
14
15
#include <
grass/gis.h
>
16
#include <
grass/raster.h
>
17
18
#include "
R.h
"
19
20
/*!
21
* \brief Test for raster mask presence and get file descriptor if present.
22
*
23
* This function tests the mask presence and takes into account the state of
24
* auto-masking in the library, so mask is considered as not present when
25
* masking is suppressed regardless of the presence of the mask raster.
26
*
27
* \return -1 if mask is not present
28
* \return file descriptor if raster mask is present and active
29
*/
30
int
Rast_maskfd
(
void
)
31
{
32
Rast__check_for_auto_masking
();
33
34
return
R__
.
auto_mask
> 0 ?
R__
.
mask_fd
: -1;
35
}
R.h
Rast__check_for_auto_masking
int Rast__check_for_auto_masking(void)
Checks for auto masking.
Definition:
auto_mask.c:33
gis.h
Rast_maskfd
int Rast_maskfd(void)
Test for raster mask presence and get file descriptor if present.
Definition:
maskfd.c:30
raster.h
R__
Definition:
R.h:87
R__::auto_mask
int auto_mask
Definition:
R.h:90
R__::mask_fd
int mask_fd
Definition:
R.h:89
lib
raster
maskfd.c
Generated on Tue Mar 11 2025 07:33:58 for GRASS GIS 8 Programmer's Manual by
1.9.1