Changeset 32910 in project


Ignore:
Timestamp:
11/14/15 21:36:42 (4 years ago)
Author:
John Croisant
Message:

Summary: sdl2: Updated docs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/sdl2

    r32909 r32910  
    707707
    708708
    709 <procedure>(gl-get-attribute attr) → value</procedure>
    710 
    711 See [[https://wiki.libsdl.org/SDL_GL_GetAttribute|SDL_GL_GetAttribute]].
     709<procedure>(gl-attribute attr) → value</procedure>
     710<setter>(set! (gl-attribute attr) value) → fixnum</setter>
     711<setter>(gl-attribute-set! attr value) → fixnum</setter>
     712
     713See [[https://wiki.libsdl.org/SDL_GL_GetAttribute|SDL_GL_GetAttribute]]
     714and [[https://wiki.libsdl.org/SDL_GL_SetAttribute|SDL_GL_SetAttribute]].
    712715
    713716{{attr}} must be an [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-attributes|OpenGL attribute symbol]] or corresponding integer.
    714717
    715 The return type varies depending on {{attr}}:
    716 
    717 * If {{attr}} is {{'context-profile-mask}}, an [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-profiles|OpenGL profile symbol]] will be returned.
    718 
    719 * If {{attr}} is {{'context-flags}}, a list of zero or more [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-context-flags|OpenGL context flag symbols]] will be returned.
    720 
    721 * Otherwise, an integer will be returned.
    722 
    723 
    724 <procedure>(gl-set-attribute! attr value) → fixnum</procedure>
    725 
    726 See [[https://wiki.libsdl.org/SDL_GL_SetAttribute|SDL_GL_SetAttribute]].
    727 Returns zero if successful.
    728 
    729 {{attr}} must be an [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-attributes|OpenGL attribute symbol]] or corresponding integer.
    730 
    731 {{value}} must be one of these types, depending on what {{attr}} is:
    732 
    733 * If {{attr}} is {{'context-profile-mask}}, {{value}} must be an [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-profiles|OpenGL profile symbol]] or corresponding integer.
    734 
    735 * If {{attr}} is {{'context-flags}}, {{value}} must be a list of zero or more [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-context-flags|OpenGL context flag symbols]] or an integer bitfield.
    736 
    737 * Otherwise, {{value}} must be an integer.
     718The value's type depends on {{attr}}:
     719
     720* If {{attr}} is {{'context-profile-mask}}, the value will be an [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-profiles|OpenGL profile symbol]]. (The setter also accepts a corresponding integer.)
     721
     722* If {{attr}} is {{'context-flags}}, the value will be a list of zero or more [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#opengl-context-flags|OpenGL context flag symbols]] will be returned. (The setter also accepts an equivalent integer bitfield.)
     723
     724* Otherwise, the value is an integer.
     725
     726The setters return zero if successful.
    738727
    739728
     
    763752
    764753
    765 <procedure>(gl-get-swap-interval) → fixnum</procedure>
    766 
    767 See [[https://wiki.libsdl.org/SDL_GL_GetSwapInterval|SDL_GL_GetSwapInterval]].
    768 
    769 
    770 <procedure>(gl-set-swap-interval! interval) → fixnum</procedure>
    771 
    772 See [[https://wiki.libsdl.org/SDL_GL_SetSwapInterval|SDL_GL_SetSwapInterval]].
    773 
    774 Returns zero if successful
     754<procedure>(gl-swap-interval) → fixnum</procedure>
     755<setter>(set! (gl-swap-interval) interval) → fixnum</setter>
     756<setter>(gl-set-swap-interval! interval) → fixnum</setter>
     757
     758See [[https://wiki.libsdl.org/SDL_GL_GetSwapInterval|SDL_GL_GetSwapInterval]]
     759and [[https://wiki.libsdl.org/SDL_GL_SetSwapInterval|SDL_GL_SetSwapInterval]].
     760
     761The setters return zero if successful.
    775762
    776763
     
    15721559
    15731560
    1574 <procedure>(disable-screen-saver!)</procedure>
    1575 
    1576 See [[https://wiki.libsdl.org/SDL_DisableScreenSaver|SDL_DisableScreenSaver]].
    1577 
    1578 
    1579 <procedure>(enable-screen-saver!)</procedure>
    1580 
    1581 See [[https://wiki.libsdl.org/SDL_EnableScreenSaver|SDL_EnableScreenSaver]].
    1582 
    1583 
    15841561<procedure>(screen-saver-enabled?) → boolean</procedure>
    1585 
    1586 See [[https://wiki.libsdl.org/SDL_IsScreenSaverEnabled|SDL_IsScreenSaverEnabled]].
     1562<setter>(set! (screen-saver-enabled?) enabled?)</setter>
     1563<setter>(screen-saver-enabled-set! enabled?)</setter>
     1564
     1565See [[https://wiki.libsdl.org/SDL_IsScreenSaverEnabled|SDL_IsScreenSaverEnabled]],
     1566[[https://wiki.libsdl.org/SDL_EnableScreenSaver|SDL_EnableScreenSaver]],
     1567and [[https://wiki.libsdl.org/SDL_DisableScreenSaver|SDL_DisableScreenSaver]].
    15871568
    15881569
Note: See TracChangeset for help on using the changeset viewer.