tmp
[blender.git] / extern / audaspace / bindings / C / AUD_Source.h
1 /*******************************************************************************
2 * Copyright 2009-2015 Juan Francisco Crespo Gal├ín
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *   http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16
17 #pragma once
18
19 #include "AUD_Types.h"
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 /**
26 * Creates a new Source object.
27 * \param azimuth The azimuth angle.
28 * \param elevation The elevation angle.
29 * \param elevation The distance value. [0,1]
30 * \return The new Source object.
31 */
32 extern AUD_API AUD_Source* AUD_Source_create(float azimuth, float elevation, float distance);
33
34 /**
35 * Deletes a Source object.
36 * \param source The Source object to be deleted.
37 */
38 extern AUD_API void AUD_Source_free(AUD_Source* source);
39
40 /**
41 * Retrieves the azimuth angle of a Source object.
42 * \param source The Source object.
43 * \return The azimuth angle.
44 */
45 extern AUD_API float AUD_Source_getAzimuth(AUD_Source* source);
46
47 /**
48 * Retrieves the elevation angle oa a Source object.
49 * \param source The Source object.
50 * \return The elevation angle.
51 */
52 extern AUD_API float AUD_Source_getElevation(AUD_Source* source);
53
54 /**
55 * Retrieves the distance of a Source object. [0,1]
56 * \param source The Source object.
57 * \return The distance.
58 */
59 extern AUD_API float AUD_Source_getDistance(AUD_Source* distance);
60
61 /**
62 * Changes the azimuth angle of a Source object.
63 * \param source The Source object.
64 * \param azimuth The azimuth angle.
65 */
66 extern AUD_API void AUD_Source_setAzimuth(AUD_Source* source, float azimuth);
67
68 /**
69 * Changes the elevation angle of a Source object.
70 * \param source The Source object.
71 * \param elevation The elevation angle.
72 */
73 extern AUD_API void AUD_Source_setElevation(AUD_Source* source, float elevation);
74
75 /**
76 * Changes the distance of a Source object. [0,1]
77 * \param source The Source object.
78 * \param distance The distance.
79 */
80 extern AUD_API void AUD_Source_setDistance(AUD_Source* source, float distance);
81
82 #ifdef __cplusplus
83 }
84 #endif