libvips/cplusplus/include/vips/VInterpolate8.h

// VIPS interpolate wrapper

/*

    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., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA

 */

/*

    These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk

 */

#ifndef VIPS_VINTERPOLATE_H
#define VIPS_VINTERPOLATE_H

#include <vips/vips.h>

VIPS_NAMESPACE_START

/** 
 * An interpolation. You can pass one of these to something like
 * VImage::affine for it to use to interpolate pixels.
 *
 * The available interpolators vary a bit with your libvips version and how it
 * was built, but will include `nearest`, `bilinear` and `bicubic`. Run 
 * vips -l interpolate` to see them all.
 */
class VInterpolate : public VObject
{
public:
	/**
	 * Create a VInterpolate that wraps a VipsInterpolate object. If steal
	 * is STEAL, then this VInterpolate takes over ownership of the libvips
	 * object and will automatically unref it.
	 */
	VInterpolate( VipsInterpolate *interpolate, VSteal steal = STEAL ) : 
		VObject( (VipsObject *) interpolate, steal )
	{
	}

	/**
	 * Create a VInterpolate from a name, for example `"bicubic"`.
	 */
	static 
	VInterpolate new_from_name( const char *name, VOption *options = 0 );

	/**
	 * Get a pointer to the underlying VipsInterpolate object.
	 */
	VipsInterpolate *
	get_interpolate() const
	{
		return( (VipsInterpolate *) VObject::get_object() );
	}

};

VIPS_NAMESPACE_END

#endif /*VIPS_VINTERPOLATE_H*/