vips

package

Go to main page

Versions in this module

v2

v2.16.0

Jan 12, 2025

Changes in this version

+ func GetGenericGrayGamma22ICCProfilePath() (string, error)

+ func GetSGrayV2MicroICCProfilePath() (string, error)

+ func GetSRGBIEC6196621ICCProfilePath() (string, error)

+ func GetSRGBV2MicroICCProfilePath() (string, error)

type TiffExportParams

+ Pyramid bool

+ Tile bool

+ TileHeight int

+ TileWidth int

v2.15.0

Jun 7, 2024

Changes in this version

type ImageRef

+ func (r *ImageRef) Gamma(gamma float64) error

+ func (r *ImageRef) Sobel() error

+ func (r *ImageRef) TransformICCProfileWithFallback(targetProfilePath, fallbackProfilePath string) error

v2.14.0

Feb 25, 2024

Changes in this version

type ImageRef

+ func (r *ImageRef) Crop(left int, top int, width int, height int) error

+ func (r *ImageRef) ExportJxl(params *JxlExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) HistogramCumulative() error

+ func (r *ImageRef) HistogramEntropy() (float64, error)

+ func (r *ImageRef) HistogramFind() error

+ func (r *ImageRef) HistogramNormalise() error

+ func (r *ImageRef) Recomb(matrix [][]float64) error

+ func (r *ImageRef) Stats() error

type ImageType

+ const ImageTypeJXL

+ type JxlExportParams struct

+ Distance float64

+ Effort int

+ Lossless bool

+ Quality int

+ Tier int

+ func NewJxlExportParams() *JxlExportParams

type WebpExportParams

+ MaxKeyFrames int

+ MinKeyFrames int

+ MinSize bool

v2.13.0

May 4, 2023

Changes in this version

+ const GaussBlurDefaultMinAMpl

type AvifExportParams

+ Bitdepth int

+ Effort int

type HeifExportParams

+ Bitdepth int

+ Effort int

type ImageRef

+ func (r *ImageRef) BandSplit() ([]*ImageRef, error)

+ func (r *ImageRef) CopyChangingInterpretation(interpretation Interpretation) (*ImageRef, error)

+ func (r *ImageRef) CopyChangingResolution(xres, yres float64) (*ImageRef, error)

+ func (r *ImageRef) ExtractBandToImage(band int, num int) (*ImageRef, error)

+ func (r *ImageRef) GetAsString(name string) string

+ func (r *ImageRef) GetBlob(name string) []byte

+ func (r *ImageRef) GetDouble(name string) float64

+ func (r *ImageRef) GetExif() map[string]string

+ func (r *ImageRef) GetFields() []string

+ func (r *ImageRef) GetICCProfile() []byte

+ func (r *ImageRef) GetInt(name string) int

+ func (r *ImageRef) GetString(name string) string

+ func (r *ImageRef) OriginalFormat() ImageType

+ func (r *ImageRef) SetBlob(name string, data []byte)

+ func (r *ImageRef) SetDouble(name string, f float64)

+ func (r *ImageRef) SetInt(name string, i int)

+ func (r *ImageRef) SetString(name string, str string)

type PngExportParams

+ Filter PngFilter

+ type PngFilter int

+ const PngFilterAll

+ const PngFilterAvg

+ const PngFilterNone

+ const PngFilterPaeth

+ const PngFilterSub

+ const PngFilterUo

v2.11.0

Mar 9, 2022

Changes in this version

type GifExportParams

+ Bitdepth int

+ Dither float64

+ Effort int

type ImageRef

+ func LoadThumbnailFromBuffer(buf []byte, width, height int, crop Interesting, size Size, ...) (*ImageRef, error)

+ func LoadThumbnailFromFile(file string, width, height int, crop Interesting, size Size, ...) (*ImageRef, error)

+ func (r *ImageRef) EmbedBackgroundRGBA(left, top, width, height int, backgroundColor *ColorRGBA) error

+ func (r *ImageRef) PageDelay() ([]int, error)

+ func (r *ImageRef) SetPageDelay(delay []int) error

type ImportParams

+ func (i *ImportParams) OptionString() string

v2.10.0

Jan 15, 2022

Changes in this version

+ var ErrUnsupportedMultiPageOperation = errors.New("unsupported operation for multi-page image")

+ func Pixelate(imageRef *ImageRef, factor float64) (err error)

type ImageMetadata

+ Pages int

type ImageRef

+ func LoadImageFromFile(file string, params *ImportParams) (*ImageRef, error)

+ func (r *ImageRef) GetPageHeight() int

+ func (r *ImageRef) Grid(tileHeight, across, down int) error

+ func (r *ImageRef) Orientation() int

+ func (r *ImageRef) PageHeight() int

+ func (r *ImageRef) Pages() int

+ func (r *ImageRef) Replicate(across int, down int) error

+ func (r *ImageRef) SetPageHeight(height int) error

+ func (r *ImageRef) SetPages(pages int) error

v2.9.0

Dec 30, 2021

Changes in this version

type ImageRef

+ func NewThumbnailFromBuffer(buf []byte, width, height int, crop Interesting) (*ImageRef, error)

+ func NewThumbnailFromFile(file string, width, height int, crop Interesting) (*ImageRef, error)

+ func NewThumbnailWithSizeFromBuffer(buf []byte, width, height int, crop Interesting, size Size) (*ImageRef, error)

+ func NewThumbnailWithSizeFromFile(file string, width, height int, crop Interesting, size Size) (*ImageRef, error)

+ func (r *ImageRef) EmbedBackground(left, top, width, height int, backgroundColor *Color) error

+ func (r *ImageRef) ThumbnailWithSize(width, height int, crop Interesting, size Size) error

+ func (r *ImageRef) TransformICCProfile(outputProfilePath string) error

+ type Size int

+ const SizeBoth

+ const SizeDown

+ const SizeForce

+ const SizeLast

+ const SizeUp

v2.8.1

Dec 12, 2021

v2.8.0

Dec 11, 2021

Changes in this version

+ var GenericGrayGamma22ICCProfilePath = filepath.Join(temporaryDirectory, "generic_gray_gamma_2_2.icc")

+ var SGrayV2MicroICCProfilePath = filepath.Join(temporaryDirectory, "sgray_v2_micro.icc")

+ var SRGBIEC6196621ICCProfilePath = filepath.Join(temporaryDirectory, "srgb_iec61966_2_1.icc")

+ var SRGBV2MicroICCProfilePath = filepath.Join(temporaryDirectory, "srgb_v2_micro.icc")

+ type BoolParameter struct

+ func (p *BoolParameter) Get() bool

+ func (p *BoolParameter) Set(v bool)

+ type Float64Parameter struct

+ func (p *Float64Parameter) Get() float64

+ func (p *Float64Parameter) Set(v float64)

type ImageRef

+ func LoadImageFromBuffer(buf []byte, params *ImportParams) (*ImageRef, error)

+ func (r *ImageRef) ArrayJoin(images []*ImageRef, across int) error

+ func (r *ImageRef) ExportJp2k(params *Jp2kExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) GetPoint(x int, y int) ([]float64, error)

+ func (r *ImageRef) HasExif() bool

+ func (r *ImageRef) ImageFields() []string

+ func (r *ImageRef) Join(in *ImageRef, dir Direction) error

type ImageType

+ const ImageTypeJP2K

+ type ImportParams struct

+ AutoRotate BoolParameter

+ Density IntParameter

+ FailOnError BoolParameter

+ HeifThumbnail BoolParameter

+ JpegShrinkFactor IntParameter

+ NumPages IntParameter

+ Page IntParameter

+ SvgUnlimited BoolParameter

+ func NewImportParams() *ImportParams

+ type IntParameter struct

+ func (p *IntParameter) Get() int

+ func (p *IntParameter) Set(v int)

+ type Intent int

+ const IntentAbsolute

+ const IntentLast

+ const IntentPerceptual

+ const IntentRelative

+ const IntentSaturation

+ type Jp2kExportParams struct

+ Lossless bool

+ Quality int

+ SubsampleMode SubsampleMode

+ TileHeight int

+ TileWidth int

+ func NewJp2kExportParams() *Jp2kExportParams

+ type Parameter struct

+ func (p *Parameter) IsSet() bool

type PngExportParams

+ Bitdepth int

+ Dither float64

+ Palette bool

+ Profile string

+ Quality int

type WebpExportParams

+ IccProfile string

+ NearLossless bool

v2.7.0

May 28, 2021

Changes in this version

+ type AvifExportParams struct

+ Lossless bool

+ Quality int

+ Speed int

+ StripMetadata bool

+ func NewAvifExportParams() *AvifExportParams

type ExportParams

+ Speed int

type ImageRef

+ func (r *ImageRef) ExportAvif(params *AvifExportParams) ([]byte, *ImageMetadata, error)

type ImageType

+ const ImageTypeAVIF

v2.6.0

May 8, 2021

Changes in this version

type ExportParams

+ OptimizeCoding bool

+ OptimizeScans bool

+ OvershootDeringing bool

+ QuantTable int

+ SubsampleMode SubsampleMode

+ TrellisQuant bool

+ type GifExportParams struct

+ Quality int

+ StripMetadata bool

+ func NewGifExportParams() *GifExportParams

type ImageRef

+ func (r *ImageRef) ExportGIF(params *GifExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) FindTrim(threshold float64, backgroundColor *Color) (int, int, int, int, error)

+ func (r *ImageRef) GetPages() int

+ func (r *ImageRef) Insert(sub *ImageRef, x, y int, expand bool, background *ColorRGBA) error

+ func (r *ImageRef) Rank(width int, height int, index int) error

type JpegExportParams

+ OptimizeCoding bool

+ OptimizeScans bool

+ OvershootDeringing bool

+ QuantTable int

+ SubsampleMode SubsampleMode

+ TrellisQuant bool

+ type SubsampleMode int

+ const VipsForeignSubsampleAuto

+ const VipsForeignSubsampleLast

+ const VipsForeignSubsampleOff

+ const VipsForeignSubsampleOn

v2.5.0

Jan 18, 2021

Changes in this version

type ImageRef

+ func Identity(ushort bool) (*ImageRef, error)

+ func (r *ImageRef) Average() (float64, error)

+ func (r *ImageRef) Cast(format BandFormat) error

+ func (r *ImageRef) Maplut(lut *ImageRef) error

type TiffCompression

+ const TiffCompressionDeflate

+ const TiffCompressionFax4

+ const TiffCompressionJpeg

+ const TiffCompressionPackbits

+ const TiffCompressionWebp

+ const TiffCompressionZstd

type TiffExportParams

+ Predictor TiffPredictor

+ type TiffPredictor int

+ const TiffPredictorFloat

+ const TiffPredictorHorizontal

+ const TiffPredictorNone

v2.4.0

Jan 6, 2021

Changes in this version

+ type ColorRGBA struct

+ A uint8

+ B uint8

+ G uint8

+ R uint8

+ type HeifExportParams struct

+ Lossless bool

+ Quality int

+ func NewHeifExportParams() *HeifExportParams

type ImageRef

+ func Black(width, height int) (*ImageRef, error)

+ func (r *ImageRef) BandJoinConst(constants []float64) error

+ func (r *ImageRef) DrawRect(ink ColorRGBA, left int, top int, width int, height int, fill bool) error

+ func (r *ImageRef) ExportHeif(params *HeifExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExportJpeg(params *JpegExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExportNative() ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExportPng(params *PngExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExportTiff(params *TiffExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExportWebp(params *WebpExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) Similarity(scale float64, angle float64, backgroundColor *ColorRGBA, idx float64, ...) error

+ func (r *ImageRef) SmartCrop(width int, height int, interesting Interesting) error

+ func (r *ImageRef) ToImage(params *ExportParams) (image.Image, error)

+ type JpegExportParams struct

+ Interlace bool

+ Quality int

+ StripMetadata bool

+ func NewJpegExportParams() *JpegExportParams

+ type PngExportParams struct

+ Compression int

+ Interlace bool

+ StripMetadata bool

+ func NewPngExportParams() *PngExportParams

+ type TiffCompression int

+ const TiffCompressionLzw

+ const TiffCompressionNone

+ type TiffExportParams struct

+ Compression TiffCompression

+ Quality int

+ StripMetadata bool

+ func NewTiffExportParams() *TiffExportParams

+ type WebpExportParams struct

+ Lossless bool

+ Quality int

+ ReductionEffort int

+ StripMetadata bool

+ func NewWebpExportParams() *WebpExportParams

v2.3.1

Dec 22, 2020

v2.3.0

Dec 21, 2020

Changes in this version

type ImageRef

+ func XYZ(width, height int) (*ImageRef, error)

+ func (r *ImageRef) Add(addend *ImageRef) error

+ func (r *ImageRef) Divide(denominator *ImageRef) error

+ func (r *ImageRef) Mapim(index *ImageRef) error

+ func (r *ImageRef) Multiply(multiplier *ImageRef) error

v2.2.0

Dec 13, 2020

Changes in this version

+ type ImageComposite struct

+ BlendMode BlendMode

+ Image *ImageRef

+ X int

+ Y int

type ImageRef

+ func (r *ImageRef) CompositeMulti(ins []*ImageComposite) error

+ func (r *ImageRef) Thumbnail(width, height int, crop Interesting) error

+ type Interesting int

+ const InterestingAll

+ const InterestingAttention

+ const InterestingCentre

+ const InterestingEntropy

+ const InterestingHigh

+ const InterestingLast

+ const InterestingLow

+ const InterestingNone

v2.1.0

Nov 16, 2020

Changes in this version

+ func LoggingSettings(handler LoggingHandlerFunction, verbosity LogLevel)

+ type LogLevel int

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelMessage

+ const LogLevelWarning

+ type LoggingHandlerFunction func(messageDomain string, messageLevel LogLevel, message string)

v2.0.2

Nov 2, 2020

v2.0.1

Oct 28, 2020

Changes in this version

type ExportParams

+ StripMetadata bool

v2.0.0

Oct 27, 2020

Changes in this version

+ const DefaultFont

+ const MajorVersion

+ const MicroVersion

+ const MinorVersion

+ const Version

+ var ErrUnsupportedImageFormat = errors.New("unsupported image format")

+ var ImageTypes = map[ImageType]string

+ func ClearCache()

+ func IsTypeSupported(imageType ImageType) bool

+ func PrintCache()

+ func PrintObjectReport(label string)

+ func ReadRuntimeStats(stats *RuntimeStats)

+ func ReadVipsMemStats(stats *MemoryStats)

+ func Shutdown()

+ func ShutdownThread()

+ func Startup(config *Config)

+ type Align int

+ const AlignCenter

+ const AlignHigh

+ const AlignLow

+ type Angle int

+ const Angle0

+ const Angle180

+ const Angle270

+ const Angle90

+ func GetRotationAngleFromExif(orientation int) (Angle, bool)

+ type Angle45 int

+ const Angle45_0

+ const Angle45_135

+ const Angle45_180

+ const Angle45_225

+ const Angle45_270

+ const Angle45_315

+ const Angle45_45

+ const Angle45_90

+ type BandFormat int

+ const BandFormatChar

+ const BandFormatComplex

+ const BandFormatDouble

+ const BandFormatDpComplex

+ const BandFormatFloat

+ const BandFormatInt

+ const BandFormatNotSet

+ const BandFormatShort

+ const BandFormatUchar

+ const BandFormatUint

+ const BandFormatUshort

+ type BlendMode int

+ const BlendModeAdd

+ const BlendModeAtop

+ const BlendModeClear

+ const BlendModeColorBurn

+ const BlendModeColorDodge

+ const BlendModeDarken

+ const BlendModeDest

+ const BlendModeDestAtop

+ const BlendModeDestIn

+ const BlendModeDestOut

+ const BlendModeDestOver

+ const BlendModeDifference

+ const BlendModeExclusion

+ const BlendModeHardLight

+ const BlendModeIn

+ const BlendModeLighten

+ const BlendModeMultiply

+ const BlendModeOut

+ const BlendModeOver

+ const BlendModeOverlay

+ const BlendModeSaturate

+ const BlendModeScreen

+ const BlendModeSoftLight

+ const BlendModeSource

+ const BlendModeXOR

+ type Coding int

+ const CodingError

+ const CodingLABQ

+ const CodingNone

+ const CodingRAD

+ type Color struct

+ B uint8

+ G uint8

+ R uint8

+ type Config struct

+ CacheTrace bool

+ CollectStats bool

+ ConcurrencyLevel int

+ MaxCacheFiles int

+ MaxCacheMem int

+ MaxCacheSize int

+ ReportLeaks bool

+ type Direction int

+ const DirectionHorizontal

+ const DirectionVertical

+ type ExportParams struct

+ Compression int

+ Effort int

+ Format ImageType

+ Interlaced bool

+ Lossless bool

+ Quality int

+ func NewDefaultExportParams() *ExportParams

+ func NewDefaultJPEGExportParams() *ExportParams

+ func NewDefaultPNGExportParams() *ExportParams

+ func NewDefaultWEBPExportParams() *ExportParams

+ type ExtendStrategy int

+ const ExtendBackground

+ const ExtendBlack

+ const ExtendCopy

+ const ExtendMirror

+ const ExtendRepeat

+ const ExtendWhite

+ type ImageMetadata struct

+ Colorspace Interpretation

+ Format ImageType

+ Height int

+ Orientation int

+ Width int

+ type ImageRef struct

+ func NewImageFromBuffer(buf []byte) (*ImageRef, error)

+ func NewImageFromFile(file string) (*ImageRef, error)

+ func NewImageFromReader(r io.Reader) (*ImageRef, error)

+ func (r *ImageRef) AddAlpha() error

+ func (r *ImageRef) AutoRotate() error

+ func (r *ImageRef) BandFormat() BandFormat

+ func (r *ImageRef) BandJoin(images ...*ImageRef) error

+ func (r *ImageRef) Bands() int

+ func (r *ImageRef) Close()

+ func (r *ImageRef) Coding() Coding

+ func (r *ImageRef) ColorSpace() Interpretation

+ func (r *ImageRef) Composite(overlay *ImageRef, mode BlendMode, x, y int) error

+ func (r *ImageRef) Copy() (*ImageRef, error)

+ func (r *ImageRef) Embed(left, top, width, height int, extend ExtendStrategy) error

+ func (r *ImageRef) Export(params *ExportParams) ([]byte, *ImageMetadata, error)

+ func (r *ImageRef) ExtractArea(left, top, width, height int) error

+ func (r *ImageRef) ExtractBand(band int, num int) error

+ func (r *ImageRef) Flatten(backgroundColor *Color) error

+ func (r *ImageRef) Flip(direction Direction) error

+ func (r *ImageRef) Format() ImageType

+ func (r *ImageRef) GaussianBlur(sigma float64) error

+ func (r *ImageRef) GetOrientation() int

+ func (r *ImageRef) HasAlpha() bool

+ func (r *ImageRef) HasICCProfile() bool

+ func (r *ImageRef) HasIPTC() bool

+ func (r *ImageRef) HasProfile() bool

+ func (r *ImageRef) Height() int

+ func (r *ImageRef) Interpretation() Interpretation

+ func (r *ImageRef) Invert() error

+ func (r *ImageRef) IsColorSpaceSupported() bool

+ func (r *ImageRef) Label(labelParams *LabelParams) error

+ func (r *ImageRef) Linear(a, b []float64) error

+ func (r *ImageRef) Linear1(a, b float64) error

+ func (r *ImageRef) Metadata() *ImageMetadata

+ func (r *ImageRef) Modulate(brightness, saturation, hue float64) error

+ func (r *ImageRef) ModulateHSV(brightness, saturation float64, hue int) error

+ func (r *ImageRef) OffsetX() int

+ func (r *ImageRef) OffsetY() int

+ func (r *ImageRef) OptimizeICCProfile() error

+ func (r *ImageRef) PremultiplyAlpha() error

+ func (r *ImageRef) RemoveICCProfile() error

+ func (r *ImageRef) RemoveMetadata() error

+ func (r *ImageRef) RemoveOrientation() error

+ func (r *ImageRef) ResX() float64

+ func (r *ImageRef) ResY() float64

+ func (r *ImageRef) Resize(scale float64, kernel Kernel) error

+ func (r *ImageRef) ResizeWithVScale(hScale, vScale float64, kernel Kernel) error

+ func (r *ImageRef) Rotate(angle Angle) error

+ func (r *ImageRef) SetOrientation(orientation int) error

+ func (r *ImageRef) Sharpen(sigma float64, x1 float64, m2 float64) error

+ func (r *ImageRef) ToBytes() ([]byte, error)

+ func (r *ImageRef) ToColorSpace(interpretation Interpretation) error

+ func (r *ImageRef) UnpremultiplyAlpha() error

+ func (r *ImageRef) Width() int

+ func (r *ImageRef) Zoom(xFactor int, yFactor int) error

+ type ImageType int

+ const ImageTypeBMP

+ const ImageTypeGIF

+ const ImageTypeHEIF

+ const ImageTypeJPEG

+ const ImageTypeMagick

+ const ImageTypePDF

+ const ImageTypePNG

+ const ImageTypeSVG

+ const ImageTypeTIFF

+ const ImageTypeUnknown

+ const ImageTypeWEBP

+ func DetermineImageType(buf []byte) ImageType

+ func (i ImageType) FileExt() string

+ type Interpretation int

+ const InterpretationBW

+ const InterpretationCMC

+ const InterpretationCMYK

+ const InterpretationError

+ const InterpretationFourier

+ const InterpretationGB16

+ const InterpretationGrey16

+ const InterpretationHSV

+ const InterpretationHistogram

+ const InterpretationLAB

+ const InterpretationLABQ

+ const InterpretationLABS

+ const InterpretationLCH

+ const InterpretationMatrix

+ const InterpretationMultiband

+ const InterpretationRGB

+ const InterpretationRGB16

+ const InterpretationSRGB

+ const InterpretationScRGB

+ const InterpretationXYZ

+ const InterpretationYXY

+ type Kernel int

+ const KernelAuto

+ const KernelCubic

+ const KernelLanczos2

+ const KernelLanczos3

+ const KernelLinear

+ const KernelMitchell

+ const KernelNearest

+ type LabelParams struct

+ Alignment Align

+ Color Color

+ Font string

+ Height Scalar

+ OffsetX Scalar

+ OffsetY Scalar

+ Opacity float32

+ Text string

+ Width Scalar

+ type MemoryStats struct

+ Allocs int64

+ Files int64

+ Mem int64

+ MemHigh int64

+ type PreMultiplicationState struct

+ type RuntimeStats struct

+ OperationCounts map[string]int64

+ type Scalar struct

+ Relative bool

+ Value float64

+ func ValueOf(value float64) Scalar

+ func (s *Scalar) Get(base int) float64

+ func (s *Scalar) GetRounded(base int) int

+ func (s *Scalar) IsZero() bool

+ func (s *Scalar) Set(value float64)

+ func (s *Scalar) SetInt(value int)

+ func (s *Scalar) SetScale(f float64)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL