GRASS GIS 8 Programmer's Manual  8.5.0dev(2025)-565e82de51
maskfd.c File Reference

Raster Library - Mask file descriptor and state. More...

#include <grass/gis.h>
#include <grass/raster.h>
#include "R.h"
Include dependency graph for maskfd.c:

Go to the source code of this file.

Functions

int Rast_maskfd (void)
 Test for raster mask presence and get file descriptor if present. More...
 

Detailed Description

Raster Library - Mask file descriptor and state.

(C) 2001-2024 by the GRASS Development Team

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author
Original author CERL
Vaclav Petras (documentation)

Definition in file maskfd.c.

Function Documentation

◆ Rast_maskfd()

int Rast_maskfd ( void  )

Test for raster mask presence and get file descriptor if present.

This function tests the mask presence and takes into account the state of auto-masking in the library, so mask is considered as not present when masking is suppressed regardless of the presence of the mask raster.

Returns
-1 if mask is not present
file descriptor if raster mask is present and active

Definition at line 30 of file maskfd.c.

References R__::auto_mask, R__::mask_fd, and Rast__check_for_auto_masking().

Referenced by IL_create_bitmask().