Skip to content

Commit d013806

Browse files
committed
Fix typo in AEGP_RegisterSuites5 (now 'AEGP_RegisterSuite5') (re #3)
1 parent 94e85b0 commit d013806

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/aegps/aegp-suites.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ As mentioned earlier, AEGPs do everything through suites. The following suites a
99
+---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
1010
| [Command Suite](#aegp_commandsuite1) | Manage your AEGP's menu items. Used in conjunction with the Register Suite. |
1111
+---------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
12-
| [Register Suite](#aegp_registersuites5) | Used in conjunction with the [Command Suite](#aegp_commandsuite1) to add functions to menu commands. |
12+
| [Register Suite](#aegp_registersuite5) | Used in conjunction with the [Command Suite](#aegp_commandsuite1) to add functions to menu commands. |
1313
| | |
1414
| | AEIOs and Artisans must use this suite's functions to indicate to After Effects that they want to receive the appropriate message streams. |
1515
| | |
@@ -160,14 +160,14 @@ And of course, unlock it when you're done.
160160

161161
Command Suites allow you to create and handle any menu events.
162162

163-
To add your own menu commands, you must also use [Register Suite](#aegp_registersuites5) to assign handlers to menu events.
163+
To add your own menu commands, you must also use [Register Suite](#aegp_registersuite5) to assign handlers to menu events.
164164

165165
### AEGP_CommandSuite1
166166

167167
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
168168
| Function | Purpose |
169169
+=============================+=============================================================================================================================================================================================================================================================================================================+
170-
| `AEGP_GetUniqueCommand` | Obtain a unique command identifier. Use the [Register Suite](#aegp_registersuites5) to register a handler for the command. |
170+
| `AEGP_GetUniqueCommand` | Obtain a unique command identifier. Use the [Register Suite](#aegp_registersuite5) to register a handler for the command. |
171171
| | |
172172
| | <pre lang="cpp">AEGP_GetUniqueCommand(<br/> AEGP_Command \*unique_commandP);</pre> |
173173
| | |
@@ -253,7 +253,7 @@ To add your own menu commands, you must also use [Register Suite](#aegp_register
253253

254254
Register functions for After Effects' use.
255255

256-
### AEGP_RegisterSuites5
256+
### AEGP_RegisterSuite5
257257

258258
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
259259
| Function | Purpose |

docs/aegps/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For effect plug-ins, all communication with After Effects occurs through a singl
1414

1515
While After Effects *does* call the entry point function designated in the AEGP's PiPL (which is still required), all subsequent communication between After Effects and AEGPs is handled by the hook functions the AEGP registers.
1616

17-
This registration must be performed from within the plug-in's entry function, using the [Register Suite](aegp-suites.md#aegp_registersuites5).
17+
This registration must be performed from within the plug-in's entry function, using the [Register Suite](aegp-suites.md#aegp_registersuite5).
1818

1919
---
2020

docs/aeios/aeios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This is also a good way to learn the calling sequence before beginning implement
4242

4343
## Registering Your AEIO
4444

45-
During your plug-in's entry point function, populate a AEIO_ModuleInfo describing the filetype(s) the AEIO supports, and an AEIO_FunctionBlock structure that points to your file handling functions. For some of these functions, you can rely on After Effects' default behavior by returning AEIO_Err_USE_DFLT_CALLBACK. However, you must still provide a function matching the required signature, that does so. Once you've filled out both these structures, call `AEGP_RegisterIO()` from [AEGP_RegisterSuites5](../aegps/aegp-suites.md#aegp_registersuites5).
45+
During your plug-in's entry point function, populate a AEIO_ModuleInfo describing the filetype(s) the AEIO supports, and an AEIO_FunctionBlock structure that points to your file handling functions. For some of these functions, you can rely on After Effects' default behavior by returning AEIO_Err_USE_DFLT_CALLBACK. However, you must still provide a function matching the required signature, that does so. Once you've filled out both these structures, call `AEGP_RegisterIO()` from [AEGP_RegisterSuite5](../aegps/aegp-suites.md#aegp_registersuite5).
4646

4747
In the AEIO_ModuleInfo that you pass in to the register call, you provide the file type and description information that After Effects uses in the Import dialog, for the "Files of type" drop-down on Windows, or the Enable drop-down on MacOS. As of CS6, file extensions cannot be more than three characters long, even though we have a few built-in importers with longer extensions.
4848

docs/aeios/calling-sequence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Calling Sequence
22

3-
As with all AEGPs, the entry point function exported in the plug-in's PiPL is called during launch. During this function, the AEIO must provide function pointers to required functions and describe their capabilities, then pass the appropriate structures to [AEGP_RegisterIO()](../aegps/aegp-suites.md#aegp_registersuites5).
3+
As with all AEGPs, the entry point function exported in the plug-in's PiPL is called during launch. During this function, the AEIO must provide function pointers to required functions and describe their capabilities, then pass the appropriate structures to [AEGP_RegisterIO()](../aegps/aegp-suites.md#aegp_registersuite5).
44

55
---
66

docs/artisans/artisan-data-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ After Effects is *not* a 3D modeling application. Users work in a responsive mod
4747

4848
## Registering An Artisan
4949

50-
An Artisan is an AEGP, and has a single entry point. Artisans must also register their own function entry points and have a special callback for this purpose. See `AEGP_RegisterArtisan()` from [AEGP_RegisterSuites5](../aegps/aegp-suites.md#aegp_registersuites5).
50+
An Artisan is an AEGP, and has a single entry point. Artisans must also register their own function entry points and have a special callback for this purpose. See `AEGP_RegisterArtisan()` from [AEGP_RegisterSuite5](../aegps/aegp-suites.md#aegp_registersuite5).
5151

5252
This tables shows the functions that Artisans can support as defined by `PR_ArtisanEntryPoints`: only `render_func` is required.
5353

0 commit comments

Comments
 (0)