Go to the source code of this file.
Classes | |
| class | AEModule |
| Module base class. More... | |
Typedefs | |
| typedef void(* | AEModuleProcessFunc )(__unsafe_unretained AEModule *_Nonnull self, const AERenderContext *_Nonnull context) |
| Processing function. | |
| typedef BOOL(* | AEModuleIsActiveFunc )(__unsafe_unretained AEModule *_Nonnull self) |
| Active test function. | |
Functions | |
| void | AEModuleProcess (__unsafe_unretained AEModule *_Nonnull module, const AERenderContext *_Nonnull context) |
| Invoke processing for a module. | |
| BOOL | AEModuleIsActive (__unsafe_unretained AEModule *_Nonnull module) |
| Determine whether module is active. | |
Typedef Documentation
| typedef void(* AEModuleProcessFunc)(__unsafe_unretained AEModule *_Nonnull self, const AERenderContext *_Nonnull context) |
Processing function.
All modules must provide a function of this type, and assign it to the processFunction property.
Within a processing a function, a module may add, modify or remove buffers within the stack.
- Parameters
-
self A pointer to the module context The rendering context
| typedef BOOL(* AEModuleIsActiveFunc)(__unsafe_unretained AEModule *_Nonnull self) |
Active test function.
Modules may set this property to the address of a function that returns whether or not the module is currently active. If it returns NO, the module is considered inactive and processing can be skipped by client code.
- Parameters
-
self A pointer to the module
- Returns
- YES if the module is active, NO otherwise
Function Documentation
| void AEModuleProcess | ( | __unsafe_unretained AEModule *_Nonnull | module, |
| const AERenderContext *_Nonnull | context | ||
| ) |
Invoke processing for a module.
- Parameters
-
module The module subclass context The rendering context
| BOOL AEModuleIsActive | ( | __unsafe_unretained AEModule *_Nonnull | module | ) |
Determine whether module is active.
If NO is returned by this method, processing may be skipped for this module, as it is idle.
- Parameters
-
module The module subclass
- Returns
- Whether the module is active