← Back to branch summary

~siretart/ubuntu/utopic/blender/libav10

« back to all changes in this revision

Viewing changes to source/blender/blenkernel/BKE_idcode.h

  • Committer: Package Import Robot
  • Author(s): Matteo F. Vescovi
  • Date: 2012-07-23 08:54:18 UTC
  • mfrom: (14.2.16 sid)
  • mto: (14.2.19 sid)
  • mto: This revision was merged to the branch mainline in revision 42.
  • Revision ID: package-import@ubuntu.com-20120723085418-9foz30v6afaf5ffs
Tags: 2.63a-2
http://bugs.debian.org/658075
* debian/: Cycles support added (Closes: #658075)
  For now, this top feature has been enabled only
  on [any-amd64 any-i386] architectures because
  of OpenImageIO failing on all others
* debian/: scripts installation path changed
  from /usr/lib to /usr/share:
  + debian/patches/: patchset re-worked for path changing
  + debian/control: "Breaks" field added on yafaray-exporter

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/blender/blenkernel/BKE_idcode.h
 
1
/*
 
2
 * ***** BEGIN GPL LICENSE BLOCK *****
 
3
 *
 
4
 * This program is free software; you can redistribute it and/or
 
5
 * modify it under the terms of the GNU General Public License
 
6
 * as published by the Free Software Foundation; either version 2
 
7
 * of the License, or (at your option) any later version.
 
8
 *
 
9
 * This program is distributed in the hope that it will be useful,
 
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
 * GNU General Public License for more details.
 
13
 *
 
14
 * You should have received a copy of the GNU General Public License
 
15
 * along with this program; if not, write to the Free Software Foundation,
 
16
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
17
 *
 
18
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 
19
 * All rights reserved.
 
20
 *
 
21
 * The Original Code is: all of this file.
 
22
 *
 
23
 * Contributor(s): none yet.
 
24
 *
 
25
 * ***** END GPL LICENSE BLOCK *****
 
26
 */
 
27
 
 
28
#ifndef __BKE_IDCODE_H__
 
29
#define __BKE_IDCODE_H__
 
30
 
 
31
/** \file BKE_idcode.h
 
32
 *  \ingroup bke
 
33
 */
 
34
 
 
35
/**
 
36
 * Convert an idcode into a name.
 
37
 * 
 
38
 * \param code The code to convert.
 
39
 * \return A static string representing the name of
 
40
 * the code.
 
41
 */
 
42
const char *BKE_idcode_to_name(int code);
 
43
 
 
44
/**
 
45
 * Convert an idcode into a name (plural).
 
46
 * 
 
47
 * \param code The code to convert.
 
48
 * \return A static string representing the name of
 
49
 * the code.
 
50
 */
 
51
const char *BKE_idcode_to_name_plural(int code);
 
52
 
 
53
/**
 
54
 * Convert a name into an idcode (ie. ID_SCE)
 
55
 * 
 
56
 * \param name The name to convert.
 
57
 * \return The code for the name, or 0 if invalid.
 
58
 */
 
59
int BKE_idcode_from_name(const char *name);
 
60
 
 
61
/**
 
62
 * Return non-zero when an ID type is linkable.
 
63
 * 
 
64
 * \param code The code to check.
 
65
 * \return Boolean, 0 when non linkable.
 
66
 */
 
67
int BKE_idcode_is_linkable(int code);
 
68
 
 
69
/**
 
70
 * Return if the ID code is a valid ID code.
 
71
 * 
 
72
 * \param code The code to check.
 
73
 * \return Boolean, 0 when invalid.
 
74
 */
 
75
int BKE_idcode_is_valid(int code);
 
76
 
 
77
/**
 
78
 * Return an ID code and steps the index forward 1.
 
79
 *
 
80
 * \param index start as 0.
 
81
 * \return the code, 0 when all codes have been returned.
 
82
 */
 
83
int BKE_idcode_iter_step(int *index);
 
84
 
 
85
#endif