# CategoryDlopenNotes

This header allows you to annotate your code so external tools know about
dynamic shared library dependencies.

If you determine that your toolchain doesn't support dlopen notes, you can
disable this feature by defining
[`SDL_DISABLE_DLOPEN_NOTES`](SDL_DISABLE_DLOPEN_NOTES). You can use this
CMake snippet to check for support:

```cmake
 set(CHECK_ELF_DLNOTES_SRC [==[
 #ifndef __ELF__
   ELF DL notes is only supported on ELF platforms
 #endif
 __attribute__ ((used,aligned(4),section(".note.dlopen"))) static const struct {
   struct { int a; int b; int c; } hdr; char name[4]; __attribute__((aligned(4))) char json[24];
 } dlnote = { { 4, 0x407c0c0aU, 16 }, "FDO", "[\\"a\\":{\\"a\\":\\"1\\",\\"b\\":\\"2\\"}]" };
 int main(int argc, char *argv[]) {
   return argc + dlnote.hdr.a;
 }
 ]==])
 check_c_source_compiles("${CHECK_ELF_DLNOTES_SRC}" COMPILER_SUPPORTS_ELFNOTES)
 if(NOT COMPILER_SUPPORTS_ELFNOTES)
   set(SDL_DISABLE_DLOPEN_NOTES TRUE)
 endif()
```

<!-- END CATEGORY DOCUMENTATION -->

## Functions

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryDlopenNotes, CategoryAPIFunction -->
- (none.)
<!-- END CATEGORY LIST -->

## Datatypes

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryDlopenNotes, CategoryAPIDatatype -->
- (none.)
<!-- END CATEGORY LIST -->

## Structs

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryDlopenNotes, CategoryAPIStruct -->
- (none.)
<!-- END CATEGORY LIST -->

## Enums

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryDlopenNotes, CategoryAPIEnum -->
- (none.)
<!-- END CATEGORY LIST -->

## Macros

<!-- DO NOT HAND-EDIT CATEGORY LISTS, THEY ARE AUTOGENERATED AND WILL BE OVERWRITTEN, BASED ON TAGS IN INDIVIDUAL PAGE FOOTERS. EDIT THOSE INSTEAD. -->
<!-- BEGIN CATEGORY LIST: CategoryDlopenNotes, CategoryAPIMacro -->
- [SDL_ELF_NOTE_DLOPEN](SDL_ELF_NOTE_DLOPEN)
- [SDL_ELF_NOTE_DLOPEN_PRIORITY_RECOMMENDED](SDL_ELF_NOTE_DLOPEN_PRIORITY_RECOMMENDED)
- [SDL_ELF_NOTE_DLOPEN_PRIORITY_REQUIRED](SDL_ELF_NOTE_DLOPEN_PRIORITY_REQUIRED)
- [SDL_ELF_NOTE_DLOPEN_PRIORITY_SUGGESTED](SDL_ELF_NOTE_DLOPEN_PRIORITY_SUGGESTED)
<!-- END CATEGORY LIST -->

----
[CategoryAPICategory](CategoryAPICategory)