summaryrefslogtreecommitdiff
path: root/support/dktools/hbimgdim.h
blob: b3341b11f0ae929be31aa9aa7f53a7602c8d8203 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*
Copyright (C) 2013-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: hbimgdim.ctr
*/

/**	@file hbimgdim.h Header file for the hbimgdim module.
*/

#ifndef HBIMGDIM_H_INCLUDED
/** Avoid multiple inclusions. */
#define HBIMGDIM_H_INCLUDED 1


#line 10 "hbimgdim.ctr"

#ifdef __cplusplus
extern "C" {
#endif

/**	Find image dimensions.
	@param	job	Job structure.
	@param	fn	Image file name.
	@param	w	Pointer to result variable for width.
	@param	h	Pointer to result variable for height.
	@param	save	Flag: Save result to cache.
	@return	1 on success, 0 on error.
*/
int
hbimgdim_find(
  hb_job_t	*job,
  dkChar const	*fn,
  unsigned long	*w,
  unsigned long	*h,
  int		 save
);

/**	Create image dimension cache entry, allocate memory.
	@param	fn	Image file name.
	@param	w	Image width.
	@param	h	Image height.
	@param	app	Application structure for diagnostics, may be NULL.
	@return	Pointer to new entry on success, NULL on error.
*/
hb_img_dim_t	*
hbimgdim_new(
  dkChar const	*fn,
  unsigned long	 w,
  unsigned long	 h,
  dk3_app_t	*app
);

/**	Delete image dimension cache entry, release memory.
	@param	ptr	Cache entry to delete.
*/
void
hbimgdim_delete(hb_img_dim_t *ptr);

/**	Compare two image dimension entries.
	@param	l	Left entry pointer.
	@param	r	Right entry pointer or file name pointer.
	@param	cr	Comparison criteria (0=entry/entry, 1=entry/name).
	@return	Comparison result.
*/
int
hbimgdim_compare(void const *l, void const *r, int cr);

#ifdef __cplusplus
}
#endif




#endif