getSurface(Surface)
getPixelFormat(Surface)
getPalette(Surface)
getPixels(Surface, Size)
setVideoMode(W, H, Bpp, Type)
videoDriverName()
getVideoSurface()
videoModeOK(W, H, Bpp, Type)
listModes({formatp, Ref}, Flags)
displayFormat(Surface)
blitSurface(SSurf, SRect, DSurf, DRect)
fillRect(S, R, C)
updateRect(S, X, Y, W, H)
updateRects(S, R)
flip({surfacep, Ref})
setColors(S, Colors, FirstColor, Ncolors)
setColorKey(Surface, Flag, Key)
mapRGB(Surface, R, G, B)
createRGBsurface(Flags, W, H, D, RM, GM, BM, AM)
createRGBsurfaceFrom(Pixels, W, H, D, P, RM, GM, BM, AM)
freeSurface(Surface)
mustLock(Surface)
lockSurface(Surface)
unlockSurface(Surface)
loadBMP(File)
saveBMP(Surface, File)
setAlpha(Surface, Flag, Alpha)
setClipping(Surface, Top, Left, Botton, Right)
setGamma(Red,Green,Blue)
setGammaRamp(Red,Green,Blue)
getGammaRamp()
wm_setCaption(Title, IconTitle)
wm_getCaption()
wm_setIcon(Icon, Mask)
wm_iconifyWindow()
wm_toggleFullScreen(Surface)
wm_grabInput(GrabMode)
wm_getInfo()
wm_isMaximized()
wm_maximize()
wm_mac_file_dialog(Props)
gl_setAttribute(Attr, Val)
gl_getAttribute(Attr)
gl_swapBuffers()
mapRGBA(Surface, R, G, B, A)
getClipRect(Surface)
setClipRect(Surface, Rect)
displayFormatAlpha(Surface)
numJoysticks()
name(Index)
open(Index)
opened(Index)
index(Joystick)
numAxes(Joystick)
numBalls(Joystick)
numHats(Joystick)
numButtons(Joystick)
update()
getAxis(Joystick, Axis)
getHat(Joystick, Hat)
getButton(Joystick, Button)
getBall(Joystick, Ball)
close(Joystick)
alloc(Size0, Type)
getBin(#sdlmem{bin=Bin})
malloc(Size, Type)
free(_Ref)
read(#sdlmem{type=Type,bin=Bin}, Size)
write(#sdlmem{type=Type,size=Size,bin=Dest}, Data)
write(#sdlmem{type=Type,size=Size0,bin=Dest0}, Offset, Data)
term2bin(Bin, _, _)
tuplelist2bin(2,Type,List)
bin2list(undefined, Type, Bin)
copySdlImage2GLArray(Image, Mem, Bpp)
debug(L)
getKeyState()
enableUNICODE(Bool)
enableKeyRepeat(Delay, Interval)
getKeyName(Key)
getModState()
setModState(ModState)
getMouseState()
getRelativeMouseState()
warpMouse(X, Y)
createCursor(Data, Mask, W, H, HotX, HotY)
setCursor({cursorp,Ref})
getCursor()
freeCursor({cursorp,Ref})
showCursor(Bool)
linkedVersion()
byteSwappedUNICODE(Int)
init()
openFont(File, PointSize)
openFontIndex(File, PointSize, Index)
openFontRW()
openFontIndexRW()
getFontStyle(Font)
setFontStyle(Font, FontStyle)
fontHeight(Font)
fontAscent(Font)
fontDescent(Font)
fontLineSkip(Font)
fontFaces(Font)
fontFaceIsFixedWidth(Font)
fontFaceFamilyName(Font)
fontFaceStyleName(Font)
glyphMetrics(Font, Ch)
sizeText(Font, Text)
sizeUTF8(Font, Text)
sizeUNICODE(Font, Text)
renderTextSolid(Font, Text, FgColor)
renderUTF8Solid(Font, Text, FgColor)
renderUNICODESolid(Font, Text, FgColor)
renderGlyphSolid(Font, Glyph, FgColor)
renderTextShaded(Font, Text, FgColor, BgColor)
renderUTF8Shaded(Font, Text, FgColor, BgColor)
renderUNICODEShaded(Font, Text, FgColor, BgColor)
renderGlyphShaded(Font, Glyph, FgColor, BgColor)
renderTextBlended(Font, Text, FgColor)
renderUTF8Blended(Font, Text, FgColor)
renderUNICODEBlended(Font, Text, FgColor)
renderGlyphBlended(Font, Glyph, FgColor)
closeFont(Font)
quit()
wasInit()
setError(_Error)
getError()
ESDL is an api which invokes corresponding functions in the
Sdl and Opengl libraries.
Since most of the functions are 1 to 1 mapping to the original
libraries, the descriptions (if any) are brief. For detailed
descriptions and manual pages take a look at the
SDL and
Opengl sites which should
be able guide you to the documentation. I have tried to generate link
to the descriptions on net, but may have failed in some cases.
With some common sense you should be able to figure out the arguments
and return values to the functions. Arguments in the 'C' libraries that
are used as out parameters, are often returned as a tuple with values.
C functions that take pointer to an array as argument takes a list
as argument in erlang (and/or tuple).
The thing that differs are of course the memory handling and
memory references, check out the examples.
If you have complaints of non trivial (or errors) arguments or return values,
send me an email and I'll try to update the documentation or (the fast way)
check the source.
Init and Quit Functions
Opengl functions that uses pointers requires
that you use the memory functions in sdl_util
to handle the memory references.
init(Flags)
quit()
getError()
linkedVersion()
loadTypedRW()
load(File)
loadRW() Args: Surface Ref
Returns: sdl_surface record
Desc:
Copies data pointed to by Surface to sdl_surface record.
Args: PixelFormatRef
Returns: a sdl_pixelformat record
Desc:
Copies data pointed to by Surface to sdl_pixelformat record.
Args: SurfaceRef ref
Returns: a sdl_palette record
Desc:
Copies data pointed to by Surface to sdl_palette record.
Args: Surface Ref, Size (a sdl_rectangle record)
Returns: A binary containing all pixles, size varies with pixel format
Desc:
Copies pixels (specified by Size) of Surface to a binary
Returns: a surface ref or the atom 'error'
C-API: SDL_Surface *SDL_SetVideoMode(int width, int height, int bpp, Uint32 flags);
Returns: [Name] | []
C-API: char *SDL_VideoDriverName(char *namebuf, int maxlen);
Returns: surface ref to the current display
C-API: SDL_Surface * SDL_GetVideoSurface(void);
Args: See sdl documentation
Returns: true | false (see sdl doc)
C-API: int SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags);
Args: PixelFormat (either as sdl_pixelformat record or a PixelFormat Ref or null) VideoFlags
Returns: [AvailableDimensions (in sdl_rect)] | all
C-API: SDL_Rect ** SDL_ListModes(SDL_PixelFormat *format, Uint32 flags);
Args: Surface Ref
Returns: Surface Ref
C-API: SDL_Surface * SDL_DisplayFormat(SDL_Surface *surface);
Args: SrcSurfaceRef, SrcRect | null, DestSurfaceRef, DestRect | null
Returns: {ClippedSrcRect | null, ClippedDestRect | null} or {error, ErrorLevel} Where ErrorLevel = -1 | -2
C-API: int SDL_BlitSurface(SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect);
Args: SurfaceRef, sdl_rectangle|null, color
Returns: true | false (on failure)
C-API: int SDL_FillRect(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);
Args: SurfaceRef, X, Y, W, H
Returns: ok
C-API: void SDL_UpdateRect(SDL_Surface *screen, Sint32 x, Sint32 y, Uint32 w, Uint32 h);
Args: SurfaceRef, [sdl_rect]
Returns: ok
C-API: void SDL_UpdateRects(SDL_Surface *screen, int numrects, SDL_Rect *rects);
Args: Surface Ref
Returns: true | false (if error)
C-API: int SDL_Flip(SDL_Surface *screen);
Args: SurfaceRef, [ColorList], FirstColor, NoOfColors
Returns: true (when all colors where set) false (otherwise)
C-API: int SDL_SetColors(SDL_Surface *surface, SDL_Color *colors, int firstcolor, int ncolors);
Args: Surface Ref, Flag(int), Key(int)
Returns: true (on success) | false on failure
C-API: int SDL_SetColorKey(SDL_Surface *surface, Uint32 flag, Uint32 key);
Args: Surface Ref, Int32, Int32, Int32
Returns: Int32
C-API: Uint32 SDL_MapRGB(SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b);
Args: SurfaceFlags Width Height Depth Rmask:32 Gmask:32 Bmask:32 Amask:32
Returns: A surface ref
C-API: SDL_Surface *SDL_CreateRGBSurface(Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
Args: Pixels(Binary) Width Height Depth Pitch Rmask:32 Gmask:32 Bmask:32 Amask:32
Returns: A surface ref
C-API: SDL_Surface *SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask);
Args: Surface Ref
Returns: ok
C-API: void SDL_FreeSurface(SDL_Surface *surface);
Args: surfaceRef
Returns: Bool
C-API: Macro
Args: Surface Ref
Returns: true (if locked) false otherwise
C-API: int SDL_LockSurface(SDL_Surface *surface);
Args: Surface Ref
Returns: ok
C-API: void SDL_UnlockSurface(SDL_Surface *surface);
Args: Name of the BMP file (string)
Returns: a surface ref or null
C-API: SDL_Surface * SDL_LoadBMP(char * file);
Args: Name of the BMP file (string)
Returns: true or false (if it failed)
C-API: int SDL_SaveBMP(SDL_Surface *surface, char *file)
Args: SurfaceRef, Flag:32, Alpha:32
Returns: integer (undocumented in (my version of) SDL)
C-API: int SDL_SetAlpha(SDL_Surface *surface, Uint32 flag, Uint8 alpha);
Args: SurfaceRef, Top, Left, Botton, Right
Returns: ok
Desc:
Obsolete??
Args: red, green, blue
Returns: Bool
C-API: int SDL_SetGamma(float red, float green, float blue)
Args: redList, greenList, blueList (where each list contains 256 16 bits value)
Returns: Bool
C-API: int SDL_SetGammaRamp(Uint16 red[256], Uint16 green[256], Uint16 blue[256])
Args: none
Returns: {res, redList, greenList, blueList} (where each list contains 256 16 bits value)
C-API: int SDL_GetGammaRamp(Uint16 *red, Uint16 *green, Uint16 *blue])
Desc:
If res is == true, the lists contain valid information
Args: Title List, IconTitleList
Returns: ok
C-API: void SDL_WM_SetCaption(const char *title, const char *icon);
Returns: {TitleStr, IconTitleStr}
C-API: void SDL_WM_GetCaption(char **title, char **icon);
Args: Icon (sdl_surface), Mask (list of bytes) | null
Returns: ok
C-API: void SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask);
Returns: ok
C-API: int SDL_WM_IconifyWindow(void);
Args: SurfaceRef
Returns: true or false (on failure)
C-API: int SDL_WM_ToggleFullScreen(SDL_Surface *surface);
Args: GrabMode (?SDL_GRAB_QUERY | ?SDL_GRAB_OFF | ?SDL_GRAB_ON)
Returns: GrabMode (?SDL_GRAB_OFF | ?SDL_GRAB_ON)
C-API: SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode);
Returns: {SDLVersion = {Major, Minor, Patch}, OSSpecBinary}
Desc:
Only windows returns anything useful (window handle)
Returns: Boolean
Desc:
Only windows returns anything useful (window handle)
Returns: nothing
Desc:
Only works on windows
Returns: nothing
Desc:
Only works on Mac
Returns: ok
C-API: int SDL_GL_SetAttribute(SDL_GLattr attr, int value);
Returns: Attribute Value
C-API: int SDL_GL_GetAttribute(SDL_GLattr attr, int* value);
Returns: A timestamp generated with SDL_GetTicks
C-API: void SDL_GL_SwapBuffers(void);
Args: Surface Ref, Int32, Int32, Int32, Int32
Returns: Int32
C-API: Uint32 SDL_MapRGB(SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
Args: Surface Ref
Returns: Rect
C-API: void SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect);
Args: Surface Ref, Rect
Returns: ok
C-API: void SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect);
Args: Surface Ref
esdl-1.3.1/doc/sdl_joystick.html 0000664 0000701 0000012 00000013123 12200430005 015225 0 ustar dgud uucp
Returns: Surface Ref
C-API: SDL_Surface * SDL_DisplayFormatAlpha(SDL_Surface *surface);
Header File
The header file may include additional information sdl_joystick.hrl
Exports
Args: none
Returns: Number of joysticks
C-API: int SDL_NumJoysticks(void);
Desc:
Count the number of joysticks attached to the system
Args: JoystickIndex
Returns: Name (List)
C-API: char *SDL_JoystickName(int device_index);
Desc:
Get the implementation dependent name of a joystick. This can be called before any joysticks are opened. If no name can be found, this function returns NULL.
Args: JoystickIndex
Returns: Joystick or exits
C-API: SDL_Joystick *SDL_JoystickOpen(int device_index);
Desc:
Open a joystick for use - the index passed as an argument refers to the N'th joystick on the system. This index is the value which will identify this joystick in future joystick events. This function returns a joystick identifier, or NULL if an error occurred.
Args: JoystickIndex
Returns: true or false
C-API: int SDL_JoystickOpened(int device_index);
Desc:
Returns true if the joystick has been opened, or false if it has not.
Args: Joystick
Returns: index
C-API: int SDL_JoystickIndex(SDL_Joystick *joystick);
Desc:
Get the device index of an opened joystick.
Args: Joystick
Returns: no of axes
C-API: int SDL_JoystickNumAxes(SDL_Joystick *joystick);
Desc:
Get the number of general axis controls on a joystick
Args: Joystick
Returns: no of balls
C-API: int SDL_JoystickNumBalls(SDL_Joystick *joystick);
Desc:
Get the number of trackballs on a joystick Joystick trackballs have only relative motion events associated with them and their state cannot be polled.
Args: Joystick
Returns: no of Hats
C-API: int SDL_JoystickNumHats(SDL_Joystick *joystick);
Desc:
Get the number of POV hats on a joystick
Args: Joystick
Returns: no of Buttons
C-API: int SDL_JoystickNumButtons(SDL_Joystick *joystick);
Desc:
Get the number of buttons on a joystick
Args: none
Returns: none
C-API: void SDL_JoystickUpdate(void);
Desc:
Update the current state of the open joysticks. This is called automatically by the event loop if any joystick events are enabled.
Args: Joystick, Axis
Returns: State (Int range: -32768 to 32767)
C-API: Sint16 SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis);
Desc:
Get the current state of an axis control on a joystick The state is a value ranging from -32768 to 32767. The axis indices start at index 0.
Args: Joystick, Hat
Returns: HatState
C-API: Uint8 SDL_JoystickGetHat(SDL_Joystick *joystick, int hat);
Desc:
Get the current state of a POV hat on a joystick The return value is one of the following positions in sdl_joystick.hrl The hat indices start at index 0.
Args: Joystick, Button
Returns: State
C-API: Uint8 SDL_JoystickGetButton(SDL_Joystick *joystick, int button);
Desc:
Get the current state of a button on a joystick The button indices start at index 0.
Args: Joystick, Ball
Returns: {DX, DY} or badarg
C-API: int SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy);
Desc:
Get the ball axis change since the last poll This returns 0, or -1 if you passed it invalid parameters. The ball indices start at index 0.
Args: Joystick
esdl-1.3.1/doc/sdl_util.html 0000664 0000701 0000012 00000006153 12200430005 014350 0 ustar dgud uucp
Returns: none
C-API: void SDL_JoystickClose(SDL_Joystick *joystick);
Desc:
Close a joystick previously opened with SDL_JoystickOpen()
Header File
The header file may include additional information sdl_util.hrl
Exports
Args: Size and type (?SDL_UNSIGNED_INT, ...)
Returns: A reference to the memory area
Desc:
Allocates Size unit memory of Type, where Type is one of the opengl types described in gl.hrl. The memory will be garbage-collected away as any other Erlang term; thus there is no need to worry about freeing the memory.
Args: References to a memory area allocated by alloc/2.
Returns: The memory allocated as a binary.
Desc:
Returns all of an allocated memory area as a binary. Note that if you do any write operation to the memory, the contents of the returned binary will change. CAVEAT PROGRAMMOR.
Args: Size and type (?SDL_UNSIGNED_INT, ...)
Returns: A reference to the memory area
Desc:
Obsolete name. Use alloc/2 instead.
Args: Ref to memory
Desc:
Obsolete function. Does nothing as memory blocks allocated by alloc/2 are garbage-collected.
Args: MemoryRef, Size
Returns: A list/Binary of Size elements of type Type
Desc:
Read allocated memory
Args: MemoryRef, List|Binary
Returns: ok
Desc:
Write to data memory
Args: MemoryRef, Offset, List|Binary
Returns: ok
Desc:
Write to memory, starting Offset unit into it.
Args: ListOfNumbers (or tuple), MaxNo, Type
Returns: Deep list
Desc:
Converts the first MaxNo numbers of ListOfNumbers to a binary of the type Type. Where Type is SDL_TYPE existing in sdl.hrl (e.g. ?SDL_DOUBLE)
Args: [TupleSize,] Type, List
Returns: Binary
Desc:
Converts a tupleList [{X,Y,..}..] to binary.
Args: No, Type, Binary
Returns: ListOfNumbers
Desc:
Converts the first 'No' of numbers in the binary Binary to a list of numbers of type Type.
Args: SdlImageRef, malloced Mem, BytesPerPixel
Returns: ok or exits
Desc:
Converts sdl_surface data to a byte RGB(A) buffer. sdl_surfaces are BGR and upside/down.
Args: Level (0 is off)
esdl-1.3.1/doc/sdl_keyboard.html 0000664 0000701 0000012 00000003400 12200430005 015163 0 ustar dgud uucp
Returns: ok
Desc:
Set ESDL debug level
Header File
The header file may include additional information sdl_keyboard.hrl
Exports
Args: none
Returns: A tuple continaing the state of each key(i.e. state of each Key)
C-API: Uint8 * SDL_GetKeyState(int *numkeys);
Args: true | false
Returns: Previous Setting (true | False)
C-API: int SDL_EnableUNICODE(int enable);
Args: Delay Interval
Returns: true | false (if failure)
C-API: int SDL_EnableKeyRepeat(int delay, int interval);
Args: SDLKey
Returns: A string
C-API: char * SDL_GetKeyName(SDLKey key);
Args: none
Returns: KModState (see KMOD_* in sdl_keyboard.hrl)
C-API: SDLMod SDL_GetModState(void);
Args: KModState (see KMOD_* in sdl_keyboard.hrl)
esdl-1.3.1/doc/Makefile 0000775 0000701 0000012 00000000672 12200143736 013322 0 ustar dgud uucp
ESRC = ../src
ERLC = erlc
DOCG = makedoc.beam
DOC = sdl.html sdl_active.html \
sdl_audio.html sdl_events.html sdl_keyboard.html sdl_mouse.html sdl_joystick.html \
sdl_util.html sdl_video.html sdl_ttf.html sdl_img.html
target: $(DOCG) $(DOC)
%.beam: %.erl
$(ERLC) -W -bbeam $(ERL_FLAGS) $(ERL_COMPILE_FLAGS) $<
clean:
rm -f $(DOCG) $(DOC)
rm -f *~
%.html: $(ESRC)/%.erl $(DOCG)
erl -noshell -s makedoc start $< -s erlang halt
esdl-1.3.1/doc/sdl_mouse.html 0000664 0000701 0000012 00000004360 12200430005 014521 0 ustar dgud uucp
Returns: ok
C-API: void SDL_SetModState(SDLMod modstate);
Header File
The header file may include additional information sdl_mouse.hrl
Exports
Args: none
Returns: {MouseState, X, Y}
C-API: Uint8 SDL_GetMouseState(int *x, int *y);
Args: none
Returns: {MouseState, X, Y}
C-API: Uint8 SDL_GetRelativeMouseState(int *x, int *y);
Args: X, Y
Returns: ok
C-API: void SDL_WarpMouse(Uint16 x, Uint16 y);
Args: Data (Binary), Mask(Binary), W, H, HotX, HotY
Returns: CursorRef
C-API: SDL_Cursor *SDL_CreateCursor (Uint8 *data, Uint8 *mask, int w, int h, int hot_x, int hot_y);
Desc:
Data & Mask must be less than 32*32 bytes.
Args: CursorRef
Returns: ok
C-API: void SDL_SetCursor(SDL_Cursor *cursor);
Args: none
Returns: A cursorRef
C-API: void SDL_SetCursor(SDL_Cursor *cursor);
Args: CursorRef
Returns: ok
C-API: void SDL_FreeCursor(SDL_Cursor *cursor);
Args: true | false
esdl-1.3.1/doc/sdl_ttf.html 0000664 0000701 0000012 00000040145 12200430005 014167 0 ustar dgud uucp
Returns: true | false (if cursor was displayed before the call)
C-API: int SDL_ShowCursor(int toggle);
Header File
The header file may include additional information sdl_ttf.hrl
Exports
Args: -
Returns: {Major, Minor, Patch}
C-API: const SDL_version * TTF_Linked_Version(void);
Desc:
This function gets the version of the SDL_ttf library.
Args: Int
Returns: void
C-API: void TTF_ByteSwappedUNICODE(int swapped);
Desc:
This function tells the library whether UNICODE text is generally byteswapped. A UNICODE BOM character in a string will override this setting for the remainder of that string.
Args: -
Returns: Result
C-API: int TTF_Init(void);
Desc:
Initialize the TTF engine. Returns 0 on success, -1 on any error.
Args: File, PointSize
Returns: TTF_Font Ref
C-API: TTF_Font * TTF_OpenFont(const char *file, int ptsize);
Desc:
Open a font file and create a font of the specified point size.
Args: File, PointSize, Index
Returns: TTF_Font Ref
C-API: TTF_Font * TTF_OpenFontIndex(const char *file, int ptsize, long index);
Desc:
Open a font file and create a font of the specified point size. Some .fon fonts will have several sizes embedded in the file, so the point size becomes the index of choosing which size. If the value is too high, the last indexed size will be the default.
Args: N/A
Returns: N/A
C-API: TTF_Font * TTF_OpenFontRW(SDL_RWops *src, int freesrc, int ptsize);
Desc:
Not implemented.
Args: N/A
Returns: N/A
C-API: TTF_Font * TTF_OpenFontIndexRW(SDL_RWops *src, int freesrc, int ptsize, long index);
Desc:
Not implemented.
Args: TTF_Font Ref
Returns: FontStyle
C-API: int TTF_GetFontStyle(TTF_Font *font);
Desc:
Retrieve the font style. This font style is implemented by modifying the font glyphs, and doesn't reflect any inherent properties of the truetype font file.
Args: TTF_Font Ref, FontStyle
C-API: void TTF_SetFontStyle(TTF_Font *font, int style);
Desc:
Set the font style. This font style is implemented by modifying the font glyphs, and doesn't reflect any inherent properties of the truetype font file.
Args: TTF_Font Ref
Returns: FontHeight
C-API: int TTF_FontHeight(TTF_Font *font);
Desc:
Get the total height of the font - usually equal to point size
Args: TTF_Font Ref
Returns: FontAscent
C-API: int TTF_FontAscent(TTF_Font *font);
Desc:
Get the offset from the baseline to the top of the font This is a positive value, relative to the baseline.
Args: TTF_Font Ref
Returns: FontDescent
C-API: int TTF_FontDescent(TTF_Font *font);
Desc:
Get the offset from the baseline to the bottom of the font This is a negative value, relative to the baseline.
Args: TTF_Font Ref
Returns: FontLineSkip
C-API: int TTF_FontLineSkip(TTF_Font *font);
Desc:
Get the recommended spacing between lines of text for this font
Args: TTF_Font Ref
Returns: FontFaces
C-API: long TTF_FontFaces(TTF_Font *font);
Desc:
Get the number of faces of the font
Args: TTF_Font Ref
Returns: IsFixedWidth
C-API: int TTF_FontFaceIsFixedWidth(TTF_Font *font);
Desc:
Test if the current font face of the loaded font is a fixed width font. Fixed width fonts are monospace, meaning every character that exists in the font is the same width, thus you can assume that a rendered string's width is going to be the result of a simple calculation: glyph_width * string_length
Args: TTF_Font Ref
Returns: FaceFamilyName
C-API: char * TTF_FontFaceFamilyName(TTF_Font *font);
Desc:
Get the current font face family name from the loaded font. This function may return a NULL pointer, in which case the information is not available.
Args: TTF_Font Ref
Returns: FaceStyleName
C-API: char * TTF_FontFaceStyleName(TTF_Font *font);
Desc:
Get the current font face style name from the loaded font. This function may return a NULL pointer, in which case the information is not available.
Args: TTF_Font Ref, Ch
Returns: {MinX, MinY, MaxX, MaxY, Advance}
C-API: int TTF_GlyphMetrics(TTF_Font *font, Uint16 ch, int *minx, int *maxx, int *miny, int *maxy, int *advance);
Desc:
Get the metrics (dimensions) of a glyph.
Args: TTF_Font Ref, Text
Returns: {Width, Height}
C-API: int TTF_SizeText(TTF_Font *font, const char *text, int *w, int *h);
Desc:
Get the dimensions of a rendered string of text.
Args: TTF_Font Ref, Text
Returns: {Width, Height}
C-API: int TTF_SizeUTF8(TTF_Font *font, const char *text, int *w, int *h);
Desc:
Get the dimensions of a rendered string of text.
Args: TTF_Font Ref, Text
Returns: {Width, Height}
C-API: int TTF_SizeUNICODE(TTF_Font *font, const Uint16 *text, int *w, int *h);
Desc:
Get the dimensions of a rendered string of text.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderText_Solid(TTF_Font *font, const char *text, SDL_Color fg);
Desc:
Create an 8-bit palettized surface and render the given text at the fast quality with the given font and color. The palette has 0 as the colorkey, giving it a transparent background, with 1 as the text color.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUTF8_Solid(TTF_Font *font, const char *text, SDL_Color fg);
Desc:
Create an 8-bit palettized surface and render the given text at the fast quality with the given font and color. The palette has 0 as the colorkey, giving it a transparent background, with 1 as the text color.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUNICODE_Solid(TTF_Font *font, const Uint16 *text, SDL_Color fg);
Desc:
Create an 8-bit palettized surface and render the given text at the fast quality with the given font and color. The palette has 0 as the colorkey, giving it a transparent background, with 1 as the text color.
Args: TTF_Font Ref, Glyph, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderGlyph_Solid(TTF_Font *font, Uint16 ch, SDL_Color fg);
Desc:
Create an 8-bit palettized surface and render the given glyph at fast quality with the given font and color. The 0 pixel is the colorkey, giving a transparent background, and the 1 pixel is set to the text color. The glyph is rendered without any padding or centering in the X direction, and aligned normally in the Y direction.
Args: TTF_Font Ref, Text, FgColor, BgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderText_Shaded(TTF_Font *font, const char *text, SDL_Color fg, SDL_Color bg);
Desc:
Create an 8-bit palettized surface and render the given text at high quality with the given font and colors. The 0 pixel is background, while other pixels have varying degrees of the foreground color.
Args: TTF_Font Ref, Text, FgColor, BgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUTF8_Shaded(TTF_Font *font, const char *text, SDL_Color fg, SDL_Color bg);
Desc:
Create an 8-bit palettized surface and render the given text at high quality with the given font and colors. The 0 pixel is background, while other pixels have varying degrees of the foreground color.
Args: TTF_Font Ref, Text, FgColor, BgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUNICODE_Shaded(TTF_Font *font, const Uint16 *text, SDL_Color fg, SDL_Color bg);
Desc:
Create an 8-bit palettized surface and render the given text at high quality with the given font and colors. The 0 pixel is background, while other pixels have varying degrees of the foreground color.
Args: TTF_Font Ref, Glyph, FgColor, BgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderGlyph_Shaded(TTF_Font *font, Uint16 ch, SDL_Color fg, SDL_Color bg);
Desc:
Create an 8-bit palettized surface and render the given glyph at high quality with the given font and colors. The 0 pixel is background, while other pixels have varying degrees of the foreground color. The glyph is rendered without any padding or centering in the X direction, and aligned normally in the Y direction.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderText_Blended(TTF_Font *font, const char *text, SDL_Color fg);
Desc:
Create a 32-bit ARGB surface and render the given text at high quality, using alpha blending to dither the font with the given color.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUTF8_Blended(TTF_Font *font, const char *text, SDL_Color fg);
Desc:
Create a 32-bit ARGB surface and render the given text at high quality, using alpha blending to dither the font with the given color.
Args: TTF_Font Ref, Text, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderUNICODE_Blended(TTF_Font *font, const Uint16 *text, SDL_Color fg);
Desc:
Create a 32-bit ARGB surface and render the given text at high quality, using alpha blending to dither the font with the given color.
Args: TTF_Font Ref, Glyph, FgColor
Returns: SDL_Surface Ref
C-API: SDL_Surface * TTF_RenderGlyph_Blended(TTF_Font *font, Uint16 ch, SDL_Color fg);
Desc:
Create a 32-bit ARGB surface and render the given glyph at high quality, using alpha blending to dither the font with the given color. The glyph is rendered without any padding or centering in the X direction, and aligned normally in the Y direction.
Args: TTF_Font Ref
Returns: void
C-API: void TTF_CloseFont(TTF_Font *font);
Desc:
Close an opened font file.
Args: -
Returns: void
C-API: void TTF_Quit(void);
Desc:
De-initialize the TTF engine.
Args: -
Returns: Int
C-API: int TTF_WasInit(void);
Desc:
Check if the TTF engine is initialized.
Args: N/A
Returns: N/A
C-API: void TTF_SetError(const char *fmt, ...)
Desc:
Not implemented.
Args: -
esdl-1.3.1/doc/index.html 0000775 0000701 0000012 00000004645 12200143736 013663 0 ustar dgud uucp
Returns: Error
C-API: char * TTF_GetError()
Desc:
Returns a (string) containing a human readable version or the reason for the last error that occured.
ESDL Introduction
SDL commands
Video Functions
Audio Functions
General Event Functions
TTF Functions
Image Functions
OpenGL
GL Functions
GLU Functions
Additions
Memory and Utility functions
esdl-1.3.1/doc/sdl.html 0000664 0000701 0000012 00000001543 12200430005 013311 0 ustar dgud uucp Header File
The header file may include additional information sdl.hrl
Exports
Args: BitMask
Returns: WrapperRef
C-API: int SDL_Init(Uint32 flags);
Desc:
Initializes the SDL (including the erlang specific parts)
Args: none
Returns: Quits the wrapper
C-API: void SDL_Quit(void);
Args: none
esdl-1.3.1/doc/sdl_img.html 0000664 0000701 0000012 00000017036 12200430005 014151 0 ustar dgud uucp
Returns: DescString
C-API: char * SDL_GetError(void);
Header File
The header file may include additional information sdl_img.hrl
Exports
Args: -
Returns: {Major, Minor, Patch}
C-API: const SDL_version * IMG_Linked_Version(void);
Desc:
This function gets the version of the SDL_image library.
Args: N/A
Returns: N/A
C-API: SDL_Surface * IMG_LoadTyped_RW(SDL_RWops *src, int freesrc, char *type);
Desc:
Not implemented.
Args: File
Returns: Surface Ref
C-API: SDL_Surface * IMG_Load(const char *file);
Desc:
Load an image from an SDL data source.
Args: N/A
Returns: N/A
C-API: SDL_Surface * IMG_Load_RW(SDL_RWops *src, int freesrc);
Desc:
Not implemented.