AEModule.h
Go to the documentation of this file.
1 //
2 // AEModule.h
3 // TheAmazingAudioEngine
4 //
5 // Created by Michael Tyson on 23/03/2016.
6 // Copyright © 2016 A Tasty Pixel. All rights reserved.
7 //
8 // This software is provided 'as-is', without any express or implied
9 // warranty. In no event will the authors be held liable for any damages
10 // arising from the use of this software.
11 //
12 // Permission is granted to anyone to use this software for any purpose,
13 // including commercial applications, and to alter it and redistribute it
14 // freely, subject to the following restrictions:
15 //
16 // 1. The origin of this software must not be misrepresented; you must not
17 // claim that you wrote the original software. If you use this software
18 // in a product, an acknowledgment in the product documentation would be
19 // appreciated but is not required.
20 //
21 // 2. Altered source versions must be plainly marked as such, and must not be
22 // misrepresented as being the original software.
23 //
24 // 3. This notice may not be removed or altered from any source distribution.
25 //
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #import <Foundation/Foundation.h>
32 #import "AEBufferStack.h"
33 #import "AERenderer.h"
34 
35 @class AEModule;
36 
43 void AEModuleProcess(__unsafe_unretained AEModule * _Nonnull module, const AERenderContext * _Nonnull context);
44 
54 BOOL AEModuleIsActive(__unsafe_unretained AEModule * _Nonnull module);
55 
68 typedef void (*AEModuleProcessFunc)(__unsafe_unretained AEModule * _Nonnull self, const AERenderContext * _Nonnull context);
69 
81 typedef BOOL (*AEModuleIsActiveFunc)(__unsafe_unretained AEModule * _Nonnull self);
82 
89 @interface AEModule : NSObject
90 
96 - (instancetype _Nullable)initWithRenderer:(AERenderer * _Nullable)renderer NS_DESIGNATED_INITIALIZER;
97 
98 - (instancetype _Nonnull)init NS_UNAVAILABLE;
99 
106 
113 
120 @property (nonatomic) AEModuleProcessFunc _Nonnull processFunction;
121 
130 @property (nonatomic) AEModuleIsActiveFunc _Nullable isActiveFunction;
131 
138 @property (nonatomic, weak) AERenderer * _Nullable renderer;
139 
140 @end
141 
142 #ifdef __cplusplus
143 }
144 #endif