blob: a2fa068ba754266a8137799aca20e8285f7a07ac [file] [log] [blame]
/* im_black.c
*
* Copyright: 1990, J. Cupitt
*
* Author: J. Cupitt
* Written on: 02/08/1990
* Modified on : 16/04/1991 by N. Dessipris to work on a line by line basis
* 15/8/94 JC
* - adapted for partials
* - ANSIfied
* - memory leaks fixed!
* 2/3/98 JC
* - IM_ANY added
* 18/1/09
* - gtkdoc
*/
/*
This file is part of VIPS.
VIPS is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>
#include <stdio.h>
#include <string.h>
#include <vips/vips.h>
#include <vips/internal.h>
#ifdef WITH_DMALLOC
#include <dmalloc.h>
#endif /*WITH_DMALLOC*/
/* Generate function --- just black out the region.
*/
static int
black_gen( REGION *or, void *seq, void *a, void *b )
{
im_region_black( or );
return( 0 );
}
/**
* im_black:
* @out: output #IMAGE
* @x: output width
* @y: output height
* @bands: number of output bands
*
* Make a black unsigned char image of a specified size.
*
* See also: im_make_xy(), im_text(), im_gaussnoise().
*
* Returns: 0 on success, -1 on error
*/
int
im_black( IMAGE *out, int x, int y, int bands )
{
if( x <= 0 || y <= 0 || bands <= 0 ) {
im_error( "im_black", "%s", _( "bad parameter" ) );
return( -1 );
}
if( im_poutcheck( out ) )
return( -1 );
im_initdesc( out,
x, y, bands,
IM_BBITS_BYTE, IM_BANDFMT_UCHAR, IM_CODING_NONE,
bands == 1 ? IM_TYPE_B_W : IM_TYPE_MULTIBAND,
1.0, 1.0, 0, 0 );
if( im_demand_hint( out, IM_ANY, NULL ) )
return( -1 );
if( im_generate( out, NULL, black_gen, NULL, NULL, NULL ) )
return( -1 );
return( 0 );
}