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.

Detailed Description

Raster Library - Mask file descriptor and state.

SPDX-FileCopyrightText: 2001-2024 GRASS Development Team SPDX-License-Identifier: GPL-2.0-or-later

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 28 of file maskfd.c.

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

Referenced by IL_create_bitmask().