summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/interior.h
blob: a52c2254b218deae67308d4b8c99b9461fd809ee (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
/*************************************************************************
 * Copyright (C) 2010 Tavian Barnes <tavianator@tavianator.com>          *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library 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 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library 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, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Object interiors.
 */

/** An interior. */
typedef struct dmnsn_interior {
  double ior; /**< Refractive index. */

  dmnsn_free_fn *free_fn; /**< Destructor callback. */

  /** Generic pointer. */
  void *ptr;

  /** @internal Reference count. */
  dmnsn_refcount refcount;
} dmnsn_interior;

/**
 * Create an interior object.
 * @return The new interior.
 */
dmnsn_interior *dmnsn_new_interior(void);

/**
 * Delete an interior.
 * @param[in,out] interior  The interior to delete.
 */
void dmnsn_delete_interior(dmnsn_interior *interior);

/**
 * Fill missing interior properties from a default interior.
 * @param[in]     default_interior  The default interior.
 * @param[in,out] interiorp         A pointer to the interior to fill.
 */
void dmnsn_interior_cascade(dmnsn_interior *default_interior,
                            dmnsn_interior **interiorp);