add a comment to SDL_InitSubSystem explaining its refcounting behavior
authorAlfred Reynolds <alfred@valvesoftware.com>
Thu, 03 Jul 2014 10:22:26 -0700
changeset 8970 c566c1634307
parent 8969 7fb90df60b99
child 8971 c30e826412d1
add a comment to SDL_InitSubSystem explaining its refcounting behavior
include/SDL.h
--- a/include/SDL.h	Thu Jul 03 10:22:12 2014 -0700
+++ b/include/SDL.h	Thu Jul 03 10:22:26 2014 -0700
@@ -130,6 +130,12 @@
 
 /**
  *  This function initializes specific SDL subsystems
+ *
+ *  Subsystem initialization is ref-counted, you must call
+ *  SDL_QuitSubSystem for each SDL_InitSubSystem to correctly
+ *  shutdown a subsystem manually (or call SDL_Quit to force shutdown).
+ *  If a subsystem is already loaded then this call will
+ *  increase the ref-count and return.
  */
 extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);