Changeset 33005 in project


Ignore:
Timestamp:
12/19/15 02:49:47 (4 years ago)
Author:
John Croisant
Message:

sdl2: Added section about the sdl2-internals module.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/sdl2

    r33003 r33005  
    205205Setters that accept an enum symbol will also accept the corresponding integer value.
    206206Setters that accept a list of enum symbols will also accept an integer representing {{bitwise-ior}}'d integer flags or masks.
     207
     208
     209==== The sdl2-internals Module
     210
     211The sdl2 egg has two modules: the {{sdl2}} module, which defines the public interface for the library, and {{sdl2-internals}}, which defines the "under the hood" code.
     212Most users will only need to use the {{sdl2}} module, but for advanced use cases you may need or want to import specific parts of the {{sdl2-internals}} module into your program.
     213
     214The {{sdl2-internals}} module is not an official part of the public API, and does not have the same guarantees of API stability.
     215But, certain parts of the module are safe to use in your programs.
     216For more information, see this guide:
     217
     218* [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/using-sdl2-internals.md|Using sdl2-internals]]
    207219
    208220
Note: See TracChangeset for help on using the changeset viewer.