View Source Vix.Vips (vix v0.31.1)

Module for Vix.Vips.

Summary

Functions

Get the maximum number of operations we keep in cache.

Get the maximum number of tracked files we allow before we start dropping cached operations.

Get the maximum amount of tracked memory we allow before we start dropping cached operations.

Set the maximum number of operations we keep in cache.

Set the maximum number of tracked files we allow before we start dropping cached operations.

Set the maximum amount of tracked memory we allow before we start dropping cached operations.

Returns the number of worker threads that vips should use when running a VipsThreadPool.

Sets the number of worker threads that vips should use when running a VipsThreadPool.

Turn on or off vips leak checking

Returns the number of bytes currently allocated by libvips.

Returns the largest number of bytes simultaneously allocated via libvips.

Get installed vips version

Functions

@spec cache_get_max() :: integer()

Get the maximum number of operations we keep in cache.

@spec cache_get_max_files() :: integer()

Get the maximum number of tracked files we allow before we start dropping cached operations.

libvips only tracks file descriptors it allocates, it can't track ones allocated by external libraries.

@spec cache_get_max_mem() :: integer()

Get the maximum amount of tracked memory we allow before we start dropping cached operations.

@spec cache_set_max(integer()) :: :ok

Set the maximum number of operations we keep in cache.

Link to this function

cache_set_max_files(max_files)

View Source
@spec cache_set_max_files(integer()) :: :ok

Set the maximum number of tracked files we allow before we start dropping cached operations.

Link to this function

cache_set_max_mem(max_mem)

View Source
@spec cache_set_max_mem(integer()) :: :ok

Set the maximum amount of tracked memory we allow before we start dropping cached operations.

libvips only tracks file descriptors it allocates, it can't track ones allocated by external libraries.

@spec concurrency_get() :: integer()

Returns the number of worker threads that vips should use when running a VipsThreadPool.

The final value is clipped to the range 1 - 1024.

Link to this function

concurrency_set(concurrency)

View Source
@spec concurrency_set(integer()) :: :ok

Sets the number of worker threads that vips should use when running a VipsThreadPool.

The special value 0 means "default". In this case, the number of threads is set by the environment variable VIPS_CONCURRENCY, or if that is not set, the number of threads available on the host machine.

Link to this function

set_vips_leak_checking(bool)

View Source
@spec set_vips_leak_checking(boolean()) :: :ok

Turn on or off vips leak checking

@spec tracked_get_mem() :: integer()

Returns the number of bytes currently allocated by libvips.

Libvips uses this figure to decide when to start dropping cache.

Link to this function

tracked_get_mem_highwater()

View Source
@spec tracked_get_mem_highwater() :: integer()

Returns the largest number of bytes simultaneously allocated via libvips.

Handy for estimating max memory requirements for a program.

@spec version() :: String.t()

Get installed vips version