libvips

VIPS_FREEF()

#define             VIPS_FREEF(F, S)

VIPS_FREE()

#define VIPS_FREE(S) VIPS_FREEF(g_free, (S));

VIPS_SETSTR()

#define             VIPS_SETSTR(S, V)

VIPS_MALLOC()

#define             VIPS_MALLOC(OBJ, S)

VIPS_NEW()

#define             VIPS_NEW(OBJ, T)

Allocate memory for a thing of type T . The memory is not cleared.

This macro cannot fail. See vips_tracked_malloc() if you are allocating large amounts of memory.

See also: vips_malloc().

VIPS_ARRAY()

#define             VIPS_ARRAY(OBJ, N, T)

Allocate memory for an array of objects of type T . The memory is not cleared.

This macro cannot fail. See vips_tracked_malloc() if you are allocating large amounts of memory.

See also: vips_malloc().

vips_malloc ()

void *
vips_malloc (VipsObject *object,
             size_t size);

g_malloc() local to object , that is, the memory will be automatically freed for you when the object is closed. If object is NULL, you need to free the memory explicitly with g_free().

This function cannot fail. See vips_tracked_malloc() if you are allocating large amounts of memory.

See also: vips_tracked_malloc().

vips_strdup ()

char *
vips_strdup (VipsObject *object,
             const char *str);

g_strdup() a string. When object is freed, the string will be freed for you. If object is NULL, you need to free the memory yourself with g_free().

This function cannot fail.

See also: vips_malloc().

vips_tracked_free ()

void
vips_tracked_free (void *s);

Only use it to free memory that was previously allocated with vips_tracked_malloc() with a NULL first argument.

See also: vips_tracked_malloc().

vips_tracked_aligned_free ()

void
vips_tracked_aligned_free (void *s);

Only use it to free memory that was previously allocated with vips_tracked_aligned_alloc() with a NULL first argument.

See also: vips_tracked_aligned_alloc().

vips_tracked_malloc ()

void *
vips_tracked_malloc (size_t size);

Allocate an area of memory that will be tracked by vips_tracked_get_mem() and friends.

If allocation fails, vips_tracked_malloc() returns NULL and sets an error message.

You must only free the memory returned with vips_tracked_free().

See also: vips_tracked_free(), vips_malloc().

vips_tracked_aligned_alloc ()

void *
vips_tracked_aligned_alloc (size_t size,
                            size_t align);

Allocate an area of memory aligned on a boundary specified by align that will be tracked by vips_tracked_get_mem() and friends.

If allocation fails, vips_tracked_aligned_alloc() returns NULL and sets an error message.

You must only free the memory returned with vips_tracked_aligned_free().

See also: vips_tracked_malloc(), vips_tracked_aligned_free(), vips_malloc().

vips_tracked_get_mem ()

size_t
vips_tracked_get_mem (void);

Returns the number of bytes currently allocated via vips_malloc() and friends. vips uses this figure to decide when to start dropping cache, see VipsOperation.

vips_tracked_get_mem_highwater ()

size_t
vips_tracked_get_mem_highwater (void);

Returns the largest number of bytes simultaneously allocated via vips_tracked_malloc(). Handy for estimating max memory requirements for a program.

vips_tracked_get_allocs ()

int
vips_tracked_get_allocs (void);

Returns the number of active allocations.

vips_tracked_open ()

int
vips_tracked_open (const char *pathname,
                   int flags,
                   int mode);

Exactly as open(2), but the number of files currently open via vips_tracked_open() is available via vips_tracked_get_files(). This is used by the vips operation cache to drop cache when the number of files available is low.

You must only close the file descriptor with vips_tracked_close().

pathname should be utf8.

See also: vips_tracked_close(), vips_tracked_get_files().

vips_tracked_close ()

int
vips_tracked_close (int fd);

Exactly as close(2), but update the number of files currently open via vips_tracked_get_files(). This is used by the vips operation cache to drop cache when the number of files available is low.

You must only close file descriptors opened with vips_tracked_open().

See also: vips_tracked_open(), vips_tracked_get_files().

vips_tracked_get_files ()

int
vips_tracked_get_files (void);

Returns the number of open files.