Add docs
This commit is contained in:
Joey Yakimowich-Payne
parent
6af0a38755
commit
5d757b3170
21 changed files with 91687 additions and 0 deletions
1961
docs/sdl2/dochack.js
Normal file
1961
docs/sdl2/dochack.js
Normal file
File diff suppressed because it is too large
Load diff
891
docs/sdl2/nimdoc.out.css
Normal file
891
docs/sdl2/nimdoc.out.css
Normal file
File diff suppressed because one or more lines are too long
26102
docs/sdl2/sdl2.html
Normal file
26102
docs/sdl2/sdl2.html
Normal file
File diff suppressed because it is too large
Load diff
2173
docs/sdl2/sdl2.idx
Normal file
2173
docs/sdl2/sdl2.idx
Normal file
File diff suppressed because it is too large
Load diff
1487
docs/sdl2/sdl2_gfx.html
Normal file
1487
docs/sdl2/sdl2_gfx.html
Normal file
File diff suppressed because it is too large
Load diff
118
docs/sdl2/sdl2_gfx.idx
Normal file
118
docs/sdl2/sdl2_gfx.idx
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
SDL2gfxPrimitivesStd sdl2/sdl2_gfx.html#SDL2gfxPrimitivesStd sdl2_gfx: SDL2gfxPrimitivesStd
|
||||
SDL2gfxPrimitivesGit sdl2/sdl2_gfx.html#SDL2gfxPrimitivesGit sdl2_gfx: SDL2gfxPrimitivesGit
|
||||
SDL2gfxPrimitivesDL sdl2/sdl2_gfx.html#SDL2gfxPrimitivesDL sdl2_gfx: SDL2gfxPrimitivesDL
|
||||
SDL2gfxPrimitivesStatic sdl2/sdl2_gfx.html#SDL2gfxPrimitivesStatic sdl2_gfx: SDL2gfxPrimitivesStatic
|
||||
SDL2gfxPrimitivesSetVer sdl2/sdl2_gfx.html#SDL2gfxPrimitivesSetVer sdl2_gfx: SDL2gfxPrimitivesSetVer
|
||||
SDL2gfxPrimitivesLPath sdl2/sdl2_gfx.html#SDL2gfxPrimitivesLPath sdl2_gfx: SDL2gfxPrimitivesLPath
|
||||
SDL2gfxPrimitivesPath sdl2/sdl2_gfx.html#SDL2gfxPrimitivesPath sdl2_gfx: SDL2gfxPrimitivesPath
|
||||
SDL2_GFXPRIMITIVES_MAJOR sdl2/sdl2_gfx.html#SDL2_GFXPRIMITIVES_MAJOR sdl2_gfx: SDL2_GFXPRIMITIVES_MAJOR
|
||||
SDL2_GFXPRIMITIVES_MINOR sdl2/sdl2_gfx.html#SDL2_GFXPRIMITIVES_MINOR sdl2_gfx: SDL2_GFXPRIMITIVES_MINOR
|
||||
SDL2_GFXPRIMITIVES_MICRO sdl2/sdl2_gfx.html#SDL2_GFXPRIMITIVES_MICRO sdl2_gfx: SDL2_GFXPRIMITIVES_MICRO
|
||||
pixelColor sdl2/sdl2_gfx.html#pixelColor,ptr.Renderer,Sint16,Sint16,Uint32 sdl2_gfx: pixelColor(renderer: ptr Renderer; x: Sint16; y: Sint16; color: Uint32): cint
|
||||
pixelRGBA sdl2/sdl2_gfx.html#pixelRGBA,ptr.Renderer,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: pixelRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; r: Uint8; g: Uint8; b: Uint8;\n a: Uint8): cint
|
||||
hlineColor sdl2/sdl2_gfx.html#hlineColor,ptr.Renderer,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: hlineColor(renderer: ptr Renderer; x1: Sint16; x2: Sint16; y: Sint16; color: Uint32): cint
|
||||
hlineRGBA sdl2/sdl2_gfx.html#hlineRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: hlineRGBA(renderer: ptr Renderer; x1: Sint16; x2: Sint16; y: Sint16; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
vlineColor sdl2/sdl2_gfx.html#vlineColor,ptr.Renderer,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: vlineColor(renderer: ptr Renderer; x: Sint16; y1: Sint16; y2: Sint16; color: Uint32): cint
|
||||
vlineRGBA sdl2/sdl2_gfx.html#vlineRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: vlineRGBA(renderer: ptr Renderer; x: Sint16; y1: Sint16; y2: Sint16; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
rectangleColor sdl2/sdl2_gfx.html#rectangleColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: rectangleColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n color: Uint32): cint
|
||||
rectangleRGBA sdl2/sdl2_gfx.html#rectangleRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: rectangleRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
roundedRectangleColor sdl2/sdl2_gfx.html#roundedRectangleColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: roundedRectangleColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16;\n y2: Sint16; rad: Sint16; color: Uint32): cint
|
||||
roundedRectangleRGBA sdl2/sdl2_gfx.html#roundedRectangleRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: roundedRectangleRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16;\n y2: Sint16; rad: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
boxColor sdl2/sdl2_gfx.html#boxColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: boxColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n color: Uint32): cint
|
||||
boxRGBA sdl2/sdl2_gfx.html#boxRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: boxRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
roundedBoxColor sdl2/sdl2_gfx.html#roundedBoxColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: roundedBoxColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n rad: Sint16; color: Uint32): cint
|
||||
roundedBoxRGBA sdl2/sdl2_gfx.html#roundedBoxRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: roundedBoxRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n rad: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
lineColor sdl2/sdl2_gfx.html#lineColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: lineColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n color: Uint32): cint
|
||||
lineRGBA sdl2/sdl2_gfx.html#lineRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: lineRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
aalineColor sdl2/sdl2_gfx.html#aalineColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: aalineColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n color: Uint32): cint
|
||||
aalineRGBA sdl2/sdl2_gfx.html#aalineRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: aalineRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
thickLineColor sdl2/sdl2_gfx.html#thickLineColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint32 sdl2_gfx: thickLineColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n width: Uint8; color: Uint32): cint
|
||||
thickLineRGBA sdl2/sdl2_gfx.html#thickLineRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: thickLineRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n width: Uint8; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
circleColor sdl2/sdl2_gfx.html#circleColor,ptr.Renderer,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: circleColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; color: Uint32): cint
|
||||
circleRGBA sdl2/sdl2_gfx.html#circleRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: circleRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
arcColor sdl2/sdl2_gfx.html#arcColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: arcColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; color: Uint32): cint
|
||||
arcRGBA sdl2/sdl2_gfx.html#arcRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: arcRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
aacircleColor sdl2/sdl2_gfx.html#aacircleColor,ptr.Renderer,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: aacircleColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; color: Uint32): cint
|
||||
aacircleRGBA sdl2/sdl2_gfx.html#aacircleRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: aacircleRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
filledCircleColor sdl2/sdl2_gfx.html#filledCircleColor,ptr.Renderer,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: filledCircleColor(renderer: ptr Renderer; x: Sint16; y: Sint16; r: Sint16; color: Uint32): cint
|
||||
filledCircleRGBA sdl2/sdl2_gfx.html#filledCircleRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: filledCircleRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
ellipseColor sdl2/sdl2_gfx.html#ellipseColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: ellipseColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16;\n color: Uint32): cint
|
||||
ellipseRGBA sdl2/sdl2_gfx.html#ellipseRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: ellipseRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
aaellipseColor sdl2/sdl2_gfx.html#aaellipseColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: aaellipseColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16;\n color: Uint32): cint
|
||||
aaellipseRGBA sdl2/sdl2_gfx.html#aaellipseRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: aaellipseRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
filledEllipseColor sdl2/sdl2_gfx.html#filledEllipseColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: filledEllipseColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16;\n color: Uint32): cint
|
||||
filledEllipseRGBA sdl2/sdl2_gfx.html#filledEllipseRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: filledEllipseRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rx: Sint16; ry: Sint16;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
pieColor sdl2/sdl2_gfx.html#pieColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: pieColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; color: Uint32): cint
|
||||
pieRGBA sdl2/sdl2_gfx.html#pieRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: pieRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
filledPieColor sdl2/sdl2_gfx.html#filledPieColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: filledPieColor(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; color: Uint32): cint
|
||||
filledPieRGBA sdl2/sdl2_gfx.html#filledPieRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: filledPieRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; rad: Sint16; start: Sint16;\n `end`: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
trigonColor sdl2/sdl2_gfx.html#trigonColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: trigonColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; color: Uint32): cint
|
||||
trigonRGBA sdl2/sdl2_gfx.html#trigonRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: trigonRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
aatrigonColor sdl2/sdl2_gfx.html#aatrigonColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: aatrigonColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; color: Uint32): cint
|
||||
aatrigonRGBA sdl2/sdl2_gfx.html#aatrigonRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: aatrigonRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
filledTrigonColor sdl2/sdl2_gfx.html#filledTrigonColor,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint32 sdl2_gfx: filledTrigonColor(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; color: Uint32): cint
|
||||
filledTrigonRGBA sdl2/sdl2_gfx.html#filledTrigonRGBA,ptr.Renderer,Sint16,Sint16,Sint16,Sint16,Sint16,Sint16,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: filledTrigonRGBA(renderer: ptr Renderer; x1: Sint16; y1: Sint16; x2: Sint16; y2: Sint16;\n x3: Sint16; y3: Sint16; r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
polygonColor sdl2/sdl2_gfx.html#polygonColor,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint32 sdl2_gfx: polygonColor(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint; color: Uint32): cint
|
||||
polygonRGBA sdl2/sdl2_gfx.html#polygonRGBA,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: polygonRGBA(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
aapolygonColor sdl2/sdl2_gfx.html#aapolygonColor,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint32 sdl2_gfx: aapolygonColor(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint;\n color: Uint32): cint
|
||||
aapolygonRGBA sdl2/sdl2_gfx.html#aapolygonRGBA,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: aapolygonRGBA(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint; r: Uint8;\n g: Uint8; b: Uint8; a: Uint8): cint
|
||||
filledPolygonColor sdl2/sdl2_gfx.html#filledPolygonColor,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint32 sdl2_gfx: filledPolygonColor(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint;\n color: Uint32): cint
|
||||
filledPolygonRGBA sdl2/sdl2_gfx.html#filledPolygonRGBA,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: filledPolygonRGBA(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
texturedPolygon sdl2/sdl2_gfx.html#texturedPolygon,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,ptr.Surface,cint,cint sdl2_gfx: texturedPolygon(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint;\n texture: ptr Surface; textureDx: cint; textureDy: cint): cint
|
||||
bezierColor sdl2/sdl2_gfx.html#bezierColor,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,cint,Uint32 sdl2_gfx: bezierColor(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint; s: cint;\n color: Uint32): cint
|
||||
bezierRGBA sdl2/sdl2_gfx.html#bezierRGBA,ptr.Renderer,ptr.Sint16,ptr.Sint16,cint,cint,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: bezierRGBA(renderer: ptr Renderer; vx: ptr Sint16; vy: ptr Sint16; n: cint; s: cint;\n r: Uint8; g: Uint8; b: Uint8; a: Uint8): cint
|
||||
gfxPrimitivesSetFont sdl2/sdl2_gfx.html#gfxPrimitivesSetFont,pointer,Uint32,Uint32 sdl2_gfx: gfxPrimitivesSetFont(fontdata: pointer; cw: Uint32; ch: Uint32)
|
||||
gfxPrimitivesSetFontRotation sdl2/sdl2_gfx.html#gfxPrimitivesSetFontRotation,Uint32 sdl2_gfx: gfxPrimitivesSetFontRotation(rotation: Uint32)
|
||||
characterColor sdl2/sdl2_gfx.html#characterColor,ptr.Renderer,Sint16,Sint16,cchar,Uint32 sdl2_gfx: characterColor(renderer: ptr Renderer; x: Sint16; y: Sint16; c: cchar; color: Uint32): cint
|
||||
characterRGBA sdl2/sdl2_gfx.html#characterRGBA,ptr.Renderer,Sint16,Sint16,cchar,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: characterRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; c: cchar; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
stringColor sdl2/sdl2_gfx.html#stringColor,ptr.Renderer,Sint16,Sint16,cstring,Uint32 sdl2_gfx: stringColor(renderer: ptr Renderer; x: Sint16; y: Sint16; s: cstring; color: Uint32): cint
|
||||
stringRGBA sdl2/sdl2_gfx.html#stringRGBA,ptr.Renderer,Sint16,Sint16,cstring,Uint8,Uint8,Uint8,Uint8 sdl2_gfx: stringRGBA(renderer: ptr Renderer; x: Sint16; y: Sint16; s: cstring; r: Uint8; g: Uint8;\n b: Uint8; a: Uint8): cint
|
||||
SMOOTHING_OFF sdl2/sdl2_gfx.html#SMOOTHING_OFF sdl2_gfx: SMOOTHING_OFF
|
||||
SMOOTHING_ON sdl2/sdl2_gfx.html#SMOOTHING_ON sdl2_gfx: SMOOTHING_ON
|
||||
rotozoomSurface sdl2/sdl2_gfx.html#rotozoomSurface,ptr.Surface,cdouble,cdouble,cint sdl2_gfx: rotozoomSurface(src: ptr Surface; angle: cdouble; zoom: cdouble; smooth: cint): ptr Surface
|
||||
rotozoomSurfaceXY sdl2/sdl2_gfx.html#rotozoomSurfaceXY,ptr.Surface,cdouble,cdouble,cdouble,cint sdl2_gfx: rotozoomSurfaceXY(src: ptr Surface; angle: cdouble; zoomx: cdouble; zoomy: cdouble;\n smooth: cint): ptr Surface
|
||||
rotozoomSurfaceSize sdl2/sdl2_gfx.html#rotozoomSurfaceSize,cint,cint,cdouble,cdouble,ptr.cint,ptr.cint sdl2_gfx: rotozoomSurfaceSize(width: cint; height: cint; angle: cdouble; zoom: cdouble;\n dstwidth: ptr cint; dstheight: ptr cint)
|
||||
rotozoomSurfaceSizeXY sdl2/sdl2_gfx.html#rotozoomSurfaceSizeXY,cint,cint,cdouble,cdouble,cdouble,ptr.cint,ptr.cint sdl2_gfx: rotozoomSurfaceSizeXY(width: cint; height: cint; angle: cdouble; zoomx: cdouble;\n zoomy: cdouble; dstwidth: ptr cint; dstheight: ptr cint)
|
||||
zoomSurface sdl2/sdl2_gfx.html#zoomSurface,ptr.Surface,cdouble,cdouble,cint sdl2_gfx: zoomSurface(src: ptr Surface; zoomx: cdouble; zoomy: cdouble; smooth: cint): ptr Surface
|
||||
zoomSurfaceSize sdl2/sdl2_gfx.html#zoomSurfaceSize,cint,cint,cdouble,cdouble,ptr.cint,ptr.cint sdl2_gfx: zoomSurfaceSize(width: cint; height: cint; zoomx: cdouble; zoomy: cdouble;\n dstwidth: ptr cint; dstheight: ptr cint)
|
||||
shrinkSurface sdl2/sdl2_gfx.html#shrinkSurface,ptr.Surface,cint,cint sdl2_gfx: shrinkSurface(src: ptr Surface; factorx: cint; factory: cint): ptr Surface
|
||||
rotateSurface90Degrees sdl2/sdl2_gfx.html#rotateSurface90Degrees,ptr.Surface,cint sdl2_gfx: rotateSurface90Degrees(src: ptr Surface; numClockwiseTurns: cint): ptr Surface
|
||||
FPS_UPPER_LIMIT sdl2/sdl2_gfx.html#FPS_UPPER_LIMIT sdl2_gfx: FPS_UPPER_LIMIT
|
||||
FPS_LOWER_LIMIT sdl2/sdl2_gfx.html#FPS_LOWER_LIMIT sdl2_gfx: FPS_LOWER_LIMIT
|
||||
FPS_DEFAULT sdl2/sdl2_gfx.html#FPS_DEFAULT sdl2_gfx: FPS_DEFAULT
|
||||
FPSmanager sdl2/sdl2_gfx.html#FPSmanager sdl2_gfx: FPSmanager
|
||||
initFramerate sdl2/sdl2_gfx.html#initFramerate,ptr.FPSmanager sdl2_gfx: initFramerate(manager: ptr FPSmanager)
|
||||
setFramerate sdl2/sdl2_gfx.html#setFramerate,ptr.FPSmanager,Uint32 sdl2_gfx: setFramerate(manager: ptr FPSmanager; rate: Uint32): cint
|
||||
getFramerate sdl2/sdl2_gfx.html#getFramerate,ptr.FPSmanager sdl2_gfx: getFramerate(manager: ptr FPSmanager): cint
|
||||
getFramecount sdl2/sdl2_gfx.html#getFramecount,ptr.FPSmanager sdl2_gfx: getFramecount(manager: ptr FPSmanager): cint
|
||||
framerateDelay sdl2/sdl2_gfx.html#framerateDelay,ptr.FPSmanager sdl2_gfx: framerateDelay(manager: ptr FPSmanager): Uint32
|
||||
imageFilterMMXdetect sdl2/sdl2_gfx.html#imageFilterMMXdetect sdl2_gfx: imageFilterMMXdetect(): cint
|
||||
imageFilterMMXoff sdl2/sdl2_gfx.html#imageFilterMMXoff sdl2_gfx: imageFilterMMXoff()
|
||||
imageFilterMMXon sdl2/sdl2_gfx.html#imageFilterMMXon sdl2_gfx: imageFilterMMXon()
|
||||
imageFilterAdd sdl2/sdl2_gfx.html#imageFilterAdd,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterAdd(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterMean sdl2/sdl2_gfx.html#imageFilterMean,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterMean(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterSub sdl2/sdl2_gfx.html#imageFilterSub,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterSub(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterAbsDiff sdl2/sdl2_gfx.html#imageFilterAbsDiff,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterAbsDiff(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterMult sdl2/sdl2_gfx.html#imageFilterMult,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterMult(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterMultNor sdl2/sdl2_gfx.html#imageFilterMultNor,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterMultNor(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterMultDivby2 sdl2/sdl2_gfx.html#imageFilterMultDivby2,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterMultDivby2(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterMultDivby4 sdl2/sdl2_gfx.html#imageFilterMultDivby4,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterMultDivby4(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterBitAnd sdl2/sdl2_gfx.html#imageFilterBitAnd,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterBitAnd(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterBitOr sdl2/sdl2_gfx.html#imageFilterBitOr,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterBitOr(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterDiv sdl2/sdl2_gfx.html#imageFilterDiv,ptr.cuchar,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterDiv(Src1: ptr cuchar; Src2: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterBitNegation sdl2/sdl2_gfx.html#imageFilterBitNegation,ptr.cuchar,ptr.cuchar,cuint sdl2_gfx: imageFilterBitNegation(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint): cint
|
||||
imageFilterAddByte sdl2/sdl2_gfx.html#imageFilterAddByte,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterAddByte(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuchar): cint
|
||||
imageFilterAddUint sdl2/sdl2_gfx.html#imageFilterAddUint,ptr.cuchar,ptr.cuchar,cuint,cuint sdl2_gfx: imageFilterAddUint(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuint): cint
|
||||
imageFilterAddByteToHalf sdl2/sdl2_gfx.html#imageFilterAddByteToHalf,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterAddByteToHalf(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuchar): cint
|
||||
imageFilterSubByte sdl2/sdl2_gfx.html#imageFilterSubByte,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterSubByte(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuchar): cint
|
||||
imageFilterSubUint sdl2/sdl2_gfx.html#imageFilterSubUint,ptr.cuchar,ptr.cuchar,cuint,cuint sdl2_gfx: imageFilterSubUint(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuint): cint
|
||||
imageFilterShiftRight sdl2/sdl2_gfx.html#imageFilterShiftRight,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterShiftRight(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; N: cuchar): cint
|
||||
imageFilterShiftRightUint sdl2/sdl2_gfx.html#imageFilterShiftRightUint,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterShiftRightUint(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; N: cuchar): cint
|
||||
imageFilterMultByByte sdl2/sdl2_gfx.html#imageFilterMultByByte,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterMultByByte(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; C: cuchar): cint
|
||||
imageFilterShiftRightAndMultByByte sdl2/sdl2_gfx.html#imageFilterShiftRightAndMultByByte,ptr.cuchar,ptr.cuchar,cuint,cuchar,cuchar sdl2_gfx: imageFilterShiftRightAndMultByByte(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint;\n N: cuchar; C: cuchar): cint
|
||||
imageFilterShiftLeftByte sdl2/sdl2_gfx.html#imageFilterShiftLeftByte,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterShiftLeftByte(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; N: cuchar): cint
|
||||
imageFilterShiftLeftUint sdl2/sdl2_gfx.html#imageFilterShiftLeftUint,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterShiftLeftUint(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; N: cuchar): cint
|
||||
imageFilterShiftLeft sdl2/sdl2_gfx.html#imageFilterShiftLeft,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterShiftLeft(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; N: cuchar): cint
|
||||
imageFilterBinarizeUsingThreshold sdl2/sdl2_gfx.html#imageFilterBinarizeUsingThreshold,ptr.cuchar,ptr.cuchar,cuint,cuchar sdl2_gfx: imageFilterBinarizeUsingThreshold(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint;\n T: cuchar): cint
|
||||
imageFilterClipToRange sdl2/sdl2_gfx.html#imageFilterClipToRange,ptr.cuchar,ptr.cuchar,cuint,cuchar,cuchar sdl2_gfx: imageFilterClipToRange(Src1: ptr cuchar; Dest: ptr cuchar; length: cuint; Tmin: cuchar;\n Tmax: cuchar): cint
|
||||
imageFilterNormalizeLinear sdl2/sdl2_gfx.html#imageFilterNormalizeLinear,ptr.cuchar,ptr.cuchar,cuint,cint,cint,cint,cint sdl2_gfx: imageFilterNormalizeLinear(Src: ptr cuchar; Dest: ptr cuchar; length: cuint; Cmin: cint;\n Cmax: cint; Nmin: cint; Nmax: cint): cint
|
||||
761
docs/sdl2/sdl2_image.html
Normal file
761
docs/sdl2/sdl2_image.html
Normal file
|
|
@ -0,0 +1,761 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<!-- This file is generated by Nim. -->
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
||||
|
||||
<!-- Google fonts -->
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
||||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<!-- CSS -->
|
||||
<title>sdl2/sdl2_image</title>
|
||||
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
|
||||
|
||||
<script type="text/javascript" src="dochack.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
function main() {
|
||||
var pragmaDots = document.getElementsByClassName("pragmadots");
|
||||
for (var i = 0; i < pragmaDots.length; i++) {
|
||||
pragmaDots[i].onclick = function(event) {
|
||||
// Hide tease
|
||||
event.target.parentNode.style.display = "none";
|
||||
// Show actual
|
||||
event.target.parentNode.nextElementSibling.style.display = "inline";
|
||||
}
|
||||
}
|
||||
|
||||
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
||||
function switchTheme(e) {
|
||||
if (e.target.checked) {
|
||||
document.documentElement.setAttribute('data-theme', 'dark');
|
||||
localStorage.setItem('theme', 'dark');
|
||||
} else {
|
||||
document.documentElement.setAttribute('data-theme', 'light');
|
||||
localStorage.setItem('theme', 'light');
|
||||
}
|
||||
}
|
||||
|
||||
toggleSwitch.addEventListener('change', switchTheme, false);
|
||||
|
||||
|
||||
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "dark");
|
||||
toggleSwitch.checked = true;
|
||||
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "light");
|
||||
toggleSwitch.checked = false;
|
||||
} else {
|
||||
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
|
||||
if (currentTheme) {
|
||||
document.documentElement.setAttribute('data-theme', currentTheme);
|
||||
|
||||
if (currentTheme === 'dark') {
|
||||
toggleSwitch.checked = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
</head>
|
||||
<body onload="main()">
|
||||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">sdl2/sdl2_image</h1>
|
||||
<div class="row">
|
||||
<div class="three columns">
|
||||
<div class="theme-switch-wrapper">
|
||||
<label class="theme-switch" for="checkbox">
|
||||
<input type="checkbox" id="checkbox" />
|
||||
<div class="slider round"></div>
|
||||
</label>
|
||||
<em>Dark Mode</em>
|
||||
</div>
|
||||
<div id="global-links">
|
||||
<ul class="simple">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchInputDiv">
|
||||
Search: <input type="text" id="searchInput"
|
||||
onkeyup="search()" />
|
||||
</div>
|
||||
<div>
|
||||
Group by:
|
||||
<select onchange="groupBy(this.value)">
|
||||
<option value="section">Section</option>
|
||||
<option value="type">Type</option>
|
||||
</select>
|
||||
</div>
|
||||
<ul class="simple simple-toc" id="toc-list">
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#InitFlags"
|
||||
title="InitFlags = distinct cint"><wbr />Init<wbr />Flags<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#SDLimageStd"
|
||||
title="SDLimageStd = false"><wbr />SDLimage<wbr />Std<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimageGit"
|
||||
title="SDLimageGit = false"><wbr />SDLimage<wbr />Git<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimageDL"
|
||||
title="SDLimageDL = true"><wbr />SDLimage<wbr />DL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimageStatic"
|
||||
title="SDLimageStatic = true"><wbr />SDLimage<wbr />Static<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimageSetVer"
|
||||
title="SDLimageSetVer = """><wbr />SDLimage<wbr />Set<wbr />Ver<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimageLPath"
|
||||
title="SDLimageLPath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_image/.libs/libSDL2_image.a""><wbr />SDLimage<wbr />LPath<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLimagePath"
|
||||
title="SDLimagePath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_image/SDL_image.h""><wbr />SDLimage<wbr />Path<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SetError"
|
||||
title="SetError = """><wbr />Set<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#GetError"
|
||||
title="GetError = """><wbr />Get<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#ClearError"
|
||||
title="ClearError = """><wbr />Clear<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#IMAGE_MAJOR_VERSION"
|
||||
title="IMAGE_MAJOR_VERSION = 2"><wbr />IMAGE_<wbr />MAJOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#IMAGE_MINOR_VERSION"
|
||||
title="IMAGE_MINOR_VERSION = 0"><wbr />IMAGE_<wbr />MINOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#IMAGE_PATCHLEVEL"
|
||||
title="IMAGE_PATCHLEVEL = 5"><wbr />IMAGE_<wbr />PATCHLEVEL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INIT_JPG"
|
||||
title="INIT_JPG = 1'i32"><wbr />INIT_<wbr />JPG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INIT_PNG"
|
||||
title="INIT_PNG = 2'i32"><wbr />INIT_<wbr />PNG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INIT_TIF"
|
||||
title="INIT_TIF = 4'i32"><wbr />INIT_<wbr />TIF<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INIT_WEBP"
|
||||
title="INIT_WEBP = 8'i32"><wbr />INIT_<wbr />WEBP<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#linked_Version"
|
||||
title="linked_Version(): ptr Version"><wbr />linked_<wbr />Version<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#init%2Ccint"
|
||||
title="init(flags: cint): cint"><wbr />init<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#quit"
|
||||
title="quit()"><wbr />quit<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTyped_RW%2Cptr.RWops%2Ccint%2Ccstring"
|
||||
title="loadTyped_RW(src: ptr RWops; freesrc: cint; kind: cstring): ptr Surface"><wbr />load<wbr />Typed_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#load%2Ccstring"
|
||||
title="load(file: cstring): ptr Surface"><wbr />load<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#load_RW%2Cptr.RWops%2Ccint"
|
||||
title="load_RW(src: ptr RWops; freesrc: cint): ptr Surface"><wbr />load_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTexture%2Cptr.Renderer%2Ccstring"
|
||||
title="loadTexture(renderer: ptr Renderer; file: cstring): ptr Texture"><wbr />load<wbr />Texture<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTexture_RW%2Cptr.Renderer%2Cptr.RWops%2Ccint"
|
||||
title="loadTexture_RW(renderer: ptr Renderer; src: ptr RWops; freesrc: cint): ptr Texture"><wbr />load<wbr />Texture_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTextureTyped_RW%2Cptr.Renderer%2Cptr.RWops%2Ccint%2Ccstring"
|
||||
title="loadTextureTyped_RW(renderer: ptr Renderer; src: ptr RWops; freesrc: cint; kind: cstring): ptr Texture"><wbr />load<wbr />Texture<wbr />Typed_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isICO%2Cptr.RWops"
|
||||
title="isICO(src: ptr RWops): cint"><wbr />is<wbr />ICO<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isCUR%2Cptr.RWops"
|
||||
title="isCUR(src: ptr RWops): cint"><wbr />is<wbr />CUR<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isBMP%2Cptr.RWops"
|
||||
title="isBMP(src: ptr RWops): cint"><wbr />is<wbr />BMP<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isGIF%2Cptr.RWops"
|
||||
title="isGIF(src: ptr RWops): cint"><wbr />is<wbr />GIF<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isJPG%2Cptr.RWops"
|
||||
title="isJPG(src: ptr RWops): cint"><wbr />is<wbr />JPG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isLBM%2Cptr.RWops"
|
||||
title="isLBM(src: ptr RWops): cint"><wbr />is<wbr />LBM<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isPCX%2Cptr.RWops"
|
||||
title="isPCX(src: ptr RWops): cint"><wbr />is<wbr />PCX<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isPNG%2Cptr.RWops"
|
||||
title="isPNG(src: ptr RWops): cint"><wbr />is<wbr />PNG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isPNM%2Cptr.RWops"
|
||||
title="isPNM(src: ptr RWops): cint"><wbr />is<wbr />PNM<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isSVG%2Cptr.RWops"
|
||||
title="isSVG(src: ptr RWops): cint"><wbr />is<wbr />SVG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isTIF%2Cptr.RWops"
|
||||
title="isTIF(src: ptr RWops): cint"><wbr />is<wbr />TIF<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isXCF%2Cptr.RWops"
|
||||
title="isXCF(src: ptr RWops): cint"><wbr />is<wbr />XCF<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isXPM%2Cptr.RWops"
|
||||
title="isXPM(src: ptr RWops): cint"><wbr />is<wbr />XPM<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isXV%2Cptr.RWops"
|
||||
title="isXV(src: ptr RWops): cint"><wbr />is<wbr />XV<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#isWEBP%2Cptr.RWops"
|
||||
title="isWEBP(src: ptr RWops): cint"><wbr />is<wbr />WEBP<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadICO_RW%2Cptr.RWops"
|
||||
title="loadICO_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />ICO_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadCUR_RW%2Cptr.RWops"
|
||||
title="loadCUR_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />CUR_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadBMP_RW%2Cptr.RWops"
|
||||
title="loadBMP_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />BMP_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadGIF_RW%2Cptr.RWops"
|
||||
title="loadGIF_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />GIF_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadJPG_RW%2Cptr.RWops"
|
||||
title="loadJPG_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />JPG_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadLBM_RW%2Cptr.RWops"
|
||||
title="loadLBM_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />LBM_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadPCX_RW%2Cptr.RWops"
|
||||
title="loadPCX_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />PCX_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadPNG_RW%2Cptr.RWops"
|
||||
title="loadPNG_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />PNG_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadPNM_RW%2Cptr.RWops"
|
||||
title="loadPNM_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />PNM_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadSVG_RW%2Cptr.RWops"
|
||||
title="loadSVG_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />SVG_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTGA_RW%2Cptr.RWops"
|
||||
title="loadTGA_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />TGA_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadTIF_RW%2Cptr.RWops"
|
||||
title="loadTIF_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />TIF_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadXCF_RW%2Cptr.RWops"
|
||||
title="loadXCF_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />XCF_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadXPM_RW%2Cptr.RWops"
|
||||
title="loadXPM_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />XPM_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadXV_RW%2Cptr.RWops"
|
||||
title="loadXV_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />XV_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#loadWEBP_RW%2Cptr.RWops"
|
||||
title="loadWEBP_RW(src: ptr RWops): ptr Surface"><wbr />load<wbr />WEBP_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#readXPMFromArray%2Cptr.cstring"
|
||||
title="readXPMFromArray(xpm: ptr cstring): ptr Surface"><wbr />read<wbr />XPMFrom<wbr />Array<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#savePNG%2Cptr.Surface%2Ccstring"
|
||||
title="savePNG(surface: ptr Surface; file: cstring): cint"><wbr />save<wbr />PNG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#savePNG_RW%2Cptr.Surface%2Cptr.RWops%2Ccint"
|
||||
title="savePNG_RW(surface: ptr Surface; dst: ptr RWops; freedst: cint): cint"><wbr />save<wbr />PNG_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#saveJPG%2Cptr.Surface%2Ccstring%2Ccint"
|
||||
title="saveJPG(surface: ptr Surface; file: cstring; quality: cint): cint"><wbr />save<wbr />JPG<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#saveJPG_RW%2Cptr.Surface%2Cptr.RWops%2Ccint%2Ccint"
|
||||
title="saveJPG_RW(surface: ptr Surface; dst: ptr RWops; freedst: cint; quality: cint): cint"><wbr />save<wbr />JPG_<wbr />RW<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div class="nine columns" id="content">
|
||||
<div id="tocRoot"></div>
|
||||
|
||||
<p class="module-desc"></p>
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="sdl2.html">sdl2</a>
|
||||
</dl></div>
|
||||
<div class="section" id="7">
|
||||
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
||||
<dl class="item">
|
||||
<a id="InitFlags"></a>
|
||||
<dt><pre><a href="sdl2_image.html#InitFlags"><span class="Identifier">InitFlags</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">cint</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="10">
|
||||
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
||||
<dl class="item">
|
||||
<a id="SDLimageStd"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageStd"><span class="Identifier">SDLimageStd</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimageGit"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageGit"><span class="Identifier">SDLimageGit</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimageDL"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageDL"><span class="Identifier">SDLimageDL</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimageStatic"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageStatic"><span class="Identifier">SDLimageStatic</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimageSetVer"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageSetVer"><span class="Identifier">SDLimageSetVer</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimageLPath"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimageLPath"><span class="Identifier">SDLimageLPath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_image/.libs/libSDL2_image.a"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLimagePath"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SDLimagePath"><span class="Identifier">SDLimagePath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_image/SDL_image.h"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SetError"></a>
|
||||
<dt><pre><a href="sdl2_image.html#SetError"><span class="Identifier">SetError</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="GetError"></a>
|
||||
<dt><pre><a href="sdl2_image.html#GetError"><span class="Identifier">GetError</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="ClearError"></a>
|
||||
<dt><pre><a href="sdl2_image.html#ClearError"><span class="Identifier">ClearError</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="IMAGE_MAJOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_image.html#IMAGE_MAJOR_VERSION"><span class="Identifier">IMAGE_MAJOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="IMAGE_MINOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_image.html#IMAGE_MINOR_VERSION"><span class="Identifier">IMAGE_MINOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="IMAGE_PATCHLEVEL"></a>
|
||||
<dt><pre><a href="sdl2_image.html#IMAGE_PATCHLEVEL"><span class="Identifier">IMAGE_PATCHLEVEL</span></a> <span class="Other">=</span> <span class="DecNumber">5</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INIT_JPG"></a>
|
||||
<dt><pre><a href="sdl2_image.html#INIT_JPG"><span class="Identifier">INIT_JPG</span></a> <span class="Other">=</span> <span class="DecNumber">1'i32</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INIT_PNG"></a>
|
||||
<dt><pre><a href="sdl2_image.html#INIT_PNG"><span class="Identifier">INIT_PNG</span></a> <span class="Other">=</span> <span class="DecNumber">2'i32</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INIT_TIF"></a>
|
||||
<dt><pre><a href="sdl2_image.html#INIT_TIF"><span class="Identifier">INIT_TIF</span></a> <span class="Other">=</span> <span class="DecNumber">4'i32</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INIT_WEBP"></a>
|
||||
<dt><pre><a href="sdl2_image.html#INIT_WEBP"><span class="Identifier">INIT_WEBP</span></a> <span class="Other">=</span> <span class="DecNumber">8'i32</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<a id="linked_Version"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#linked_Version"><span class="Identifier">linked_Version</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Version"><span class="Identifier">Version</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_Linked_Version"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>This function gets the version of the dynamically linked SDL_image library.
|
||||
it should NOT be used to fill a version structure, instead you should
|
||||
use the SDL_IMAGE_VERSION() macro.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="init,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ccint"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">flags</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_Init"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Loads dynamic libraries and prepares them for use. Flags should be
|
||||
one or more flags from IMG_InitFlags OR'd together.
|
||||
It returns the flags successfully initialized, or 0 on failure.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="quit"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#quit"><span class="Identifier">quit</span></a><span class="Other">(</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_Quit"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Unloads libraries loaded with IMG_Init</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTyped_RW,ptr.RWops,cint,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTyped_RW%2Cptr.RWops%2Ccint%2Ccstring"><span class="Identifier">loadTyped_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">kind</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTyped_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Load an image from an SDL data source.
|
||||
The 'type' may be one of: "BMP", "GIF", "PNG", etc.
|
||||
If the image format supports a transparent pixel, SDL will set the
|
||||
colorkey for the surface. You can enable RLE acceleration on the
|
||||
surface afterwards by calling:
|
||||
SDL_SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="load,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#load%2Ccstring"><span class="Identifier">load</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_Load"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Convenience functions</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="load_RW,ptr.RWops,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#load_RW%2Cptr.RWops%2Ccint"><span class="Identifier">load_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_Load_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTexture,ptr.Renderer,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTexture%2Cptr.Renderer%2Ccstring"><span class="Identifier">loadTexture</span></a><span class="Other">(</span><span class="Identifier">renderer</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Renderer"><span class="Identifier">Renderer</span></a><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Texture"><span class="Identifier">Texture</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTexture"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Load an image directly into a render texture.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTexture_RW,ptr.Renderer,ptr.RWops,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTexture_RW%2Cptr.Renderer%2Cptr.RWops%2Ccint"><span class="Identifier">loadTexture_RW</span></a><span class="Other">(</span><span class="Identifier">renderer</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Renderer"><span class="Identifier">Renderer</span></a><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Texture"><span class="Identifier">Texture</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTexture_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTextureTyped_RW,ptr.Renderer,ptr.RWops,cint,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTextureTyped_RW%2Cptr.Renderer%2Cptr.RWops%2Ccint%2Ccstring"><span class="Identifier">loadTextureTyped_RW</span></a><span class="Other">(</span><span class="Identifier">renderer</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Renderer"><span class="Identifier">Renderer</span></a><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span>
|
||||
<span class="Identifier">kind</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Texture"><span class="Identifier">Texture</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTextureTyped_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isICO,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isICO%2Cptr.RWops"><span class="Identifier">isICO</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isICO"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Functions to detect a file type, given a seekable source</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isCUR,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isCUR%2Cptr.RWops"><span class="Identifier">isCUR</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isCUR"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isBMP,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isBMP%2Cptr.RWops"><span class="Identifier">isBMP</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isBMP"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isGIF,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isGIF%2Cptr.RWops"><span class="Identifier">isGIF</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isGIF"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isJPG,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isJPG%2Cptr.RWops"><span class="Identifier">isJPG</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isJPG"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isLBM,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isLBM%2Cptr.RWops"><span class="Identifier">isLBM</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isLBM"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isPCX,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isPCX%2Cptr.RWops"><span class="Identifier">isPCX</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isPCX"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isPNG,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isPNG%2Cptr.RWops"><span class="Identifier">isPNG</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isPNG"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isPNM,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isPNM%2Cptr.RWops"><span class="Identifier">isPNM</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isPNM"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isSVG,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isSVG%2Cptr.RWops"><span class="Identifier">isSVG</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isSVG"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isTIF,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isTIF%2Cptr.RWops"><span class="Identifier">isTIF</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isTIF"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isXCF,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isXCF%2Cptr.RWops"><span class="Identifier">isXCF</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isXCF"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isXPM,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isXPM%2Cptr.RWops"><span class="Identifier">isXPM</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isXPM"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isXV,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isXV%2Cptr.RWops"><span class="Identifier">isXV</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isXV"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="isWEBP,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#isWEBP%2Cptr.RWops"><span class="Identifier">isWEBP</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_isWEBP"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadICO_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadICO_RW%2Cptr.RWops"><span class="Identifier">loadICO_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadICO_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Individual loading functions</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadCUR_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadCUR_RW%2Cptr.RWops"><span class="Identifier">loadCUR_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadCUR_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadBMP_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadBMP_RW%2Cptr.RWops"><span class="Identifier">loadBMP_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadBMP_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadGIF_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadGIF_RW%2Cptr.RWops"><span class="Identifier">loadGIF_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadGIF_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadJPG_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadJPG_RW%2Cptr.RWops"><span class="Identifier">loadJPG_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadJPG_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadLBM_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadLBM_RW%2Cptr.RWops"><span class="Identifier">loadLBM_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadLBM_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadPCX_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadPCX_RW%2Cptr.RWops"><span class="Identifier">loadPCX_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadPCX_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadPNG_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadPNG_RW%2Cptr.RWops"><span class="Identifier">loadPNG_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadPNG_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadPNM_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadPNM_RW%2Cptr.RWops"><span class="Identifier">loadPNM_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadPNM_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadSVG_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadSVG_RW%2Cptr.RWops"><span class="Identifier">loadSVG_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadSVG_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTGA_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTGA_RW%2Cptr.RWops"><span class="Identifier">loadTGA_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTGA_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadTIF_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadTIF_RW%2Cptr.RWops"><span class="Identifier">loadTIF_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadTIF_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadXCF_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadXCF_RW%2Cptr.RWops"><span class="Identifier">loadXCF_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadXCF_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadXPM_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadXPM_RW%2Cptr.RWops"><span class="Identifier">loadXPM_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadXPM_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadXV_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadXV_RW%2Cptr.RWops"><span class="Identifier">loadXV_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadXV_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="loadWEBP_RW,ptr.RWops"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#loadWEBP_RW%2Cptr.RWops"><span class="Identifier">loadWEBP_RW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_LoadWEBP_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="readXPMFromArray,ptr.cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#readXPMFromArray%2Cptr.cstring"><span class="Identifier">readXPMFromArray</span></a><span class="Other">(</span><span class="Identifier">xpm</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_ReadXPMFromArray"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="savePNG,ptr.Surface,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#savePNG%2Cptr.Surface%2Ccstring"><span class="Identifier">savePNG</span></a><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_SavePNG"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Individual saving functions</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="savePNG_RW,ptr.Surface,ptr.RWops,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#savePNG_RW%2Cptr.Surface%2Cptr.RWops%2Ccint"><span class="Identifier">savePNG_RW</span></a><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a><span class="Other">;</span> <span class="Identifier">dst</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freedst</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_SavePNG_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="saveJPG,ptr.Surface,cstring,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#saveJPG%2Cptr.Surface%2Ccstring%2Ccint"><span class="Identifier">saveJPG</span></a><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">quality</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_SaveJPG"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="saveJPG_RW,ptr.Surface,ptr.RWops,cint,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#saveJPG_RW%2Cptr.Surface%2Cptr.RWops%2Ccint%2Ccint"><span class="Identifier">saveJPG_RW</span></a><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a><span class="Other">;</span> <span class="Identifier">dst</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freedst</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">quality</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"IMG_SaveJPG_RW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2020-04-26 21:10:29 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
63
docs/sdl2/sdl2_image.idx
Normal file
63
docs/sdl2/sdl2_image.idx
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
SDLimageStd sdl2/sdl2_image.html#SDLimageStd sdl2_image: SDLimageStd
|
||||
SDLimageGit sdl2/sdl2_image.html#SDLimageGit sdl2_image: SDLimageGit
|
||||
SDLimageDL sdl2/sdl2_image.html#SDLimageDL sdl2_image: SDLimageDL
|
||||
SDLimageStatic sdl2/sdl2_image.html#SDLimageStatic sdl2_image: SDLimageStatic
|
||||
SDLimageSetVer sdl2/sdl2_image.html#SDLimageSetVer sdl2_image: SDLimageSetVer
|
||||
SDLimageLPath sdl2/sdl2_image.html#SDLimageLPath sdl2_image: SDLimageLPath
|
||||
SDLimagePath sdl2/sdl2_image.html#SDLimagePath sdl2_image: SDLimagePath
|
||||
InitFlags sdl2/sdl2_image.html#InitFlags sdl2_image: InitFlags
|
||||
SetError sdl2/sdl2_image.html#SetError sdl2_image: SetError
|
||||
GetError sdl2/sdl2_image.html#GetError sdl2_image: GetError
|
||||
ClearError sdl2/sdl2_image.html#ClearError sdl2_image: ClearError
|
||||
IMAGE_MAJOR_VERSION sdl2/sdl2_image.html#IMAGE_MAJOR_VERSION sdl2_image: IMAGE_MAJOR_VERSION
|
||||
IMAGE_MINOR_VERSION sdl2/sdl2_image.html#IMAGE_MINOR_VERSION sdl2_image: IMAGE_MINOR_VERSION
|
||||
IMAGE_PATCHLEVEL sdl2/sdl2_image.html#IMAGE_PATCHLEVEL sdl2_image: IMAGE_PATCHLEVEL
|
||||
INIT_JPG sdl2/sdl2_image.html#INIT_JPG sdl2_image: INIT_JPG
|
||||
INIT_PNG sdl2/sdl2_image.html#INIT_PNG sdl2_image: INIT_PNG
|
||||
INIT_TIF sdl2/sdl2_image.html#INIT_TIF sdl2_image: INIT_TIF
|
||||
INIT_WEBP sdl2/sdl2_image.html#INIT_WEBP sdl2_image: INIT_WEBP
|
||||
linked_Version sdl2/sdl2_image.html#linked_Version sdl2_image: linked_Version(): ptr Version
|
||||
init sdl2/sdl2_image.html#init,cint sdl2_image: init(flags: cint): cint
|
||||
quit sdl2/sdl2_image.html#quit sdl2_image: quit()
|
||||
loadTyped_RW sdl2/sdl2_image.html#loadTyped_RW,ptr.RWops,cint,cstring sdl2_image: loadTyped_RW(src: ptr RWops; freesrc: cint; kind: cstring): ptr Surface
|
||||
load sdl2/sdl2_image.html#load,cstring sdl2_image: load(file: cstring): ptr Surface
|
||||
load_RW sdl2/sdl2_image.html#load_RW,ptr.RWops,cint sdl2_image: load_RW(src: ptr RWops; freesrc: cint): ptr Surface
|
||||
loadTexture sdl2/sdl2_image.html#loadTexture,ptr.Renderer,cstring sdl2_image: loadTexture(renderer: ptr Renderer; file: cstring): ptr Texture
|
||||
loadTexture_RW sdl2/sdl2_image.html#loadTexture_RW,ptr.Renderer,ptr.RWops,cint sdl2_image: loadTexture_RW(renderer: ptr Renderer; src: ptr RWops; freesrc: cint): ptr Texture
|
||||
loadTextureTyped_RW sdl2/sdl2_image.html#loadTextureTyped_RW,ptr.Renderer,ptr.RWops,cint,cstring sdl2_image: loadTextureTyped_RW(renderer: ptr Renderer; src: ptr RWops; freesrc: cint; kind: cstring): ptr Texture
|
||||
isICO sdl2/sdl2_image.html#isICO,ptr.RWops sdl2_image: isICO(src: ptr RWops): cint
|
||||
isCUR sdl2/sdl2_image.html#isCUR,ptr.RWops sdl2_image: isCUR(src: ptr RWops): cint
|
||||
isBMP sdl2/sdl2_image.html#isBMP,ptr.RWops sdl2_image: isBMP(src: ptr RWops): cint
|
||||
isGIF sdl2/sdl2_image.html#isGIF,ptr.RWops sdl2_image: isGIF(src: ptr RWops): cint
|
||||
isJPG sdl2/sdl2_image.html#isJPG,ptr.RWops sdl2_image: isJPG(src: ptr RWops): cint
|
||||
isLBM sdl2/sdl2_image.html#isLBM,ptr.RWops sdl2_image: isLBM(src: ptr RWops): cint
|
||||
isPCX sdl2/sdl2_image.html#isPCX,ptr.RWops sdl2_image: isPCX(src: ptr RWops): cint
|
||||
isPNG sdl2/sdl2_image.html#isPNG,ptr.RWops sdl2_image: isPNG(src: ptr RWops): cint
|
||||
isPNM sdl2/sdl2_image.html#isPNM,ptr.RWops sdl2_image: isPNM(src: ptr RWops): cint
|
||||
isSVG sdl2/sdl2_image.html#isSVG,ptr.RWops sdl2_image: isSVG(src: ptr RWops): cint
|
||||
isTIF sdl2/sdl2_image.html#isTIF,ptr.RWops sdl2_image: isTIF(src: ptr RWops): cint
|
||||
isXCF sdl2/sdl2_image.html#isXCF,ptr.RWops sdl2_image: isXCF(src: ptr RWops): cint
|
||||
isXPM sdl2/sdl2_image.html#isXPM,ptr.RWops sdl2_image: isXPM(src: ptr RWops): cint
|
||||
isXV sdl2/sdl2_image.html#isXV,ptr.RWops sdl2_image: isXV(src: ptr RWops): cint
|
||||
isWEBP sdl2/sdl2_image.html#isWEBP,ptr.RWops sdl2_image: isWEBP(src: ptr RWops): cint
|
||||
loadICO_RW sdl2/sdl2_image.html#loadICO_RW,ptr.RWops sdl2_image: loadICO_RW(src: ptr RWops): ptr Surface
|
||||
loadCUR_RW sdl2/sdl2_image.html#loadCUR_RW,ptr.RWops sdl2_image: loadCUR_RW(src: ptr RWops): ptr Surface
|
||||
loadBMP_RW sdl2/sdl2_image.html#loadBMP_RW,ptr.RWops sdl2_image: loadBMP_RW(src: ptr RWops): ptr Surface
|
||||
loadGIF_RW sdl2/sdl2_image.html#loadGIF_RW,ptr.RWops sdl2_image: loadGIF_RW(src: ptr RWops): ptr Surface
|
||||
loadJPG_RW sdl2/sdl2_image.html#loadJPG_RW,ptr.RWops sdl2_image: loadJPG_RW(src: ptr RWops): ptr Surface
|
||||
loadLBM_RW sdl2/sdl2_image.html#loadLBM_RW,ptr.RWops sdl2_image: loadLBM_RW(src: ptr RWops): ptr Surface
|
||||
loadPCX_RW sdl2/sdl2_image.html#loadPCX_RW,ptr.RWops sdl2_image: loadPCX_RW(src: ptr RWops): ptr Surface
|
||||
loadPNG_RW sdl2/sdl2_image.html#loadPNG_RW,ptr.RWops sdl2_image: loadPNG_RW(src: ptr RWops): ptr Surface
|
||||
loadPNM_RW sdl2/sdl2_image.html#loadPNM_RW,ptr.RWops sdl2_image: loadPNM_RW(src: ptr RWops): ptr Surface
|
||||
loadSVG_RW sdl2/sdl2_image.html#loadSVG_RW,ptr.RWops sdl2_image: loadSVG_RW(src: ptr RWops): ptr Surface
|
||||
loadTGA_RW sdl2/sdl2_image.html#loadTGA_RW,ptr.RWops sdl2_image: loadTGA_RW(src: ptr RWops): ptr Surface
|
||||
loadTIF_RW sdl2/sdl2_image.html#loadTIF_RW,ptr.RWops sdl2_image: loadTIF_RW(src: ptr RWops): ptr Surface
|
||||
loadXCF_RW sdl2/sdl2_image.html#loadXCF_RW,ptr.RWops sdl2_image: loadXCF_RW(src: ptr RWops): ptr Surface
|
||||
loadXPM_RW sdl2/sdl2_image.html#loadXPM_RW,ptr.RWops sdl2_image: loadXPM_RW(src: ptr RWops): ptr Surface
|
||||
loadXV_RW sdl2/sdl2_image.html#loadXV_RW,ptr.RWops sdl2_image: loadXV_RW(src: ptr RWops): ptr Surface
|
||||
loadWEBP_RW sdl2/sdl2_image.html#loadWEBP_RW,ptr.RWops sdl2_image: loadWEBP_RW(src: ptr RWops): ptr Surface
|
||||
readXPMFromArray sdl2/sdl2_image.html#readXPMFromArray,ptr.cstring sdl2_image: readXPMFromArray(xpm: ptr cstring): ptr Surface
|
||||
savePNG sdl2/sdl2_image.html#savePNG,ptr.Surface,cstring sdl2_image: savePNG(surface: ptr Surface; file: cstring): cint
|
||||
savePNG_RW sdl2/sdl2_image.html#savePNG_RW,ptr.Surface,ptr.RWops,cint sdl2_image: savePNG_RW(surface: ptr Surface; dst: ptr RWops; freedst: cint): cint
|
||||
saveJPG sdl2/sdl2_image.html#saveJPG,ptr.Surface,cstring,cint sdl2_image: saveJPG(surface: ptr Surface; file: cstring; quality: cint): cint
|
||||
saveJPG_RW sdl2/sdl2_image.html#saveJPG_RW,ptr.Surface,ptr.RWops,cint,cint sdl2_image: saveJPG_RW(surface: ptr Surface; dst: ptr RWops; freedst: cint; quality: cint): cint
|
||||
1601
docs/sdl2/sdl2_mixer.html
Normal file
1601
docs/sdl2/sdl2_mixer.html
Normal file
File diff suppressed because it is too large
Load diff
124
docs/sdl2/sdl2_mixer.idx
Normal file
124
docs/sdl2/sdl2_mixer.idx
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
SDLmixerStd sdl2/sdl2_mixer.html#SDLmixerStd sdl2_mixer: SDLmixerStd
|
||||
SDLmixerGit sdl2/sdl2_mixer.html#SDLmixerGit sdl2_mixer: SDLmixerGit
|
||||
SDLmixerDL sdl2/sdl2_mixer.html#SDLmixerDL sdl2_mixer: SDLmixerDL
|
||||
SDLmixerStatic sdl2/sdl2_mixer.html#SDLmixerStatic sdl2_mixer: SDLmixerStatic
|
||||
SDLmixerSetVer sdl2/sdl2_mixer.html#SDLmixerSetVer sdl2_mixer: SDLmixerSetVer
|
||||
SDLmixerLPath sdl2/sdl2_mixer.html#SDLmixerLPath sdl2_mixer: SDLmixerLPath
|
||||
SDLmixerPath sdl2/sdl2_mixer.html#SDLmixerPath sdl2_mixer: SDLmixerPath
|
||||
MIX_InitFlags sdl2/sdl2_mixer.html#MIX_InitFlags sdl2_mixer: MIX_InitFlags
|
||||
Fading sdl2/sdl2_mixer.html#Fading sdl2_mixer: Fading
|
||||
MusicType sdl2/sdl2_mixer.html#MusicType sdl2_mixer: MusicType
|
||||
SetError sdl2/sdl2_mixer.html#SetError sdl2_mixer: SetError
|
||||
GetError sdl2/sdl2_mixer.html#GetError sdl2_mixer: GetError
|
||||
ClearError sdl2/sdl2_mixer.html#ClearError sdl2_mixer: ClearError
|
||||
MIXER_MAJOR_VERSION sdl2/sdl2_mixer.html#MIXER_MAJOR_VERSION sdl2_mixer: MIXER_MAJOR_VERSION
|
||||
MIXER_MINOR_VERSION sdl2/sdl2_mixer.html#MIXER_MINOR_VERSION sdl2_mixer: MIXER_MINOR_VERSION
|
||||
MIXER_PATCHLEVEL sdl2/sdl2_mixer.html#MIXER_PATCHLEVEL sdl2_mixer: MIXER_PATCHLEVEL
|
||||
MIX_MAJOR_VERSION sdl2/sdl2_mixer.html#MIX_MAJOR_VERSION sdl2_mixer: MIX_MAJOR_VERSION
|
||||
MIX_MINOR_VERSION sdl2/sdl2_mixer.html#MIX_MINOR_VERSION sdl2_mixer: MIX_MINOR_VERSION
|
||||
MIX_PATCHLEVEL sdl2/sdl2_mixer.html#MIX_PATCHLEVEL sdl2_mixer: MIX_PATCHLEVEL
|
||||
MIX_INIT_FLAC sdl2/sdl2_mixer.html#MIX_INIT_FLAC sdl2_mixer: MIX_INIT_FLAC
|
||||
MIX_INIT_MOD sdl2/sdl2_mixer.html#MIX_INIT_MOD sdl2_mixer: MIX_INIT_MOD
|
||||
MIX_INIT_MP3 sdl2/sdl2_mixer.html#MIX_INIT_MP3 sdl2_mixer: MIX_INIT_MP3
|
||||
MIX_INIT_OGG sdl2/sdl2_mixer.html#MIX_INIT_OGG sdl2_mixer: MIX_INIT_OGG
|
||||
MIX_INIT_MID sdl2/sdl2_mixer.html#MIX_INIT_MID sdl2_mixer: MIX_INIT_MID
|
||||
MIX_INIT_OPUS sdl2/sdl2_mixer.html#MIX_INIT_OPUS sdl2_mixer: MIX_INIT_OPUS
|
||||
MIX_CHANNELS sdl2/sdl2_mixer.html#MIX_CHANNELS sdl2_mixer: MIX_CHANNELS
|
||||
MIX_DEFAULT_FREQUENCY sdl2/sdl2_mixer.html#MIX_DEFAULT_FREQUENCY sdl2_mixer: MIX_DEFAULT_FREQUENCY
|
||||
MIX_DEFAULT_CHANNELS sdl2/sdl2_mixer.html#MIX_DEFAULT_CHANNELS sdl2_mixer: MIX_DEFAULT_CHANNELS
|
||||
MIX_NO_FADING sdl2/sdl2_mixer.html#MIX_NO_FADING sdl2_mixer: MIX_NO_FADING
|
||||
MIX_FADING_OUT sdl2/sdl2_mixer.html#MIX_FADING_OUT sdl2_mixer: MIX_FADING_OUT
|
||||
MIX_FADING_IN sdl2/sdl2_mixer.html#MIX_FADING_IN sdl2_mixer: MIX_FADING_IN
|
||||
MUS_NONE sdl2/sdl2_mixer.html#MUS_NONE sdl2_mixer: MUS_NONE
|
||||
MUS_CMD sdl2/sdl2_mixer.html#MUS_CMD sdl2_mixer: MUS_CMD
|
||||
MUS_WAV sdl2/sdl2_mixer.html#MUS_WAV sdl2_mixer: MUS_WAV
|
||||
MUS_MOD sdl2/sdl2_mixer.html#MUS_MOD sdl2_mixer: MUS_MOD
|
||||
MUS_MID sdl2/sdl2_mixer.html#MUS_MID sdl2_mixer: MUS_MID
|
||||
MUS_OGG sdl2/sdl2_mixer.html#MUS_OGG sdl2_mixer: MUS_OGG
|
||||
MUS_MP3 sdl2/sdl2_mixer.html#MUS_MP3 sdl2_mixer: MUS_MP3
|
||||
MUS_MP3_MAD_UNUSED sdl2/sdl2_mixer.html#MUS_MP3_MAD_UNUSED sdl2_mixer: MUS_MP3_MAD_UNUSED
|
||||
MUS_FLAC sdl2/sdl2_mixer.html#MUS_FLAC sdl2_mixer: MUS_FLAC
|
||||
MUS_MODPLUG_UNUSED sdl2/sdl2_mixer.html#MUS_MODPLUG_UNUSED sdl2_mixer: MUS_MODPLUG_UNUSED
|
||||
MUS_OPUS sdl2/sdl2_mixer.html#MUS_OPUS sdl2_mixer: MUS_OPUS
|
||||
MIX_CHANNEL_POST sdl2/sdl2_mixer.html#MIX_CHANNEL_POST sdl2_mixer: MIX_CHANNEL_POST
|
||||
MIX_EFFECTSMAXSPEED sdl2/sdl2_mixer.html#MIX_EFFECTSMAXSPEED sdl2_mixer: MIX_EFFECTSMAXSPEED
|
||||
Chunk sdl2/sdl2_mixer.html#Chunk sdl2_mixer: Chunk
|
||||
Music sdl2/sdl2_mixer.html#Music sdl2_mixer: Music
|
||||
EffectFunc_t sdl2/sdl2_mixer.html#EffectFunc_t sdl2_mixer: EffectFunc_t
|
||||
EffectDone_t sdl2/sdl2_mixer.html#EffectDone_t sdl2_mixer: EffectDone_t
|
||||
linked_Version sdl2/sdl2_mixer.html#linked_Version sdl2_mixer: linked_Version(): ptr Version
|
||||
init sdl2/sdl2_mixer.html#init,cint sdl2_mixer: init(flags: cint): cint
|
||||
quit sdl2/sdl2_mixer.html#quit sdl2_mixer: quit()
|
||||
openAudio sdl2/sdl2_mixer.html#openAudio,cint,Uint16,cint,cint sdl2_mixer: openAudio(frequency: cint; format: Uint16; channels: cint; chunksize: cint): cint
|
||||
openAudioDevice sdl2/sdl2_mixer.html#openAudioDevice,cint,Uint16,cint,cint,cstring,cint sdl2_mixer: openAudioDevice(frequency: cint; format: Uint16; channels: cint; chunksize: cint;\n device: cstring; allowedChanges: cint): cint
|
||||
allocateChannels sdl2/sdl2_mixer.html#allocateChannels,cint sdl2_mixer: allocateChannels(numchans: cint): cint
|
||||
querySpec sdl2/sdl2_mixer.html#querySpec,ptr.cint,ptr.Uint16,ptr.cint sdl2_mixer: querySpec(frequency: ptr cint; format: ptr Uint16; channels: ptr cint): cint
|
||||
loadWAV_RW sdl2/sdl2_mixer.html#loadWAV_RW,ptr.RWops,cint sdl2_mixer: loadWAV_RW(src: ptr RWops; freesrc: cint): ptr Chunk
|
||||
loadMUS sdl2/sdl2_mixer.html#loadMUS,cstring sdl2_mixer: loadMUS(file: cstring): ptr Music
|
||||
loadMUS_RW sdl2/sdl2_mixer.html#loadMUS_RW,ptr.RWops,cint sdl2_mixer: loadMUS_RW(src: ptr RWops; freesrc: cint): ptr Music
|
||||
loadMUSType_RW sdl2/sdl2_mixer.html#loadMUSType_RW,ptr.RWops,MusicType,cint sdl2_mixer: loadMUSType_RW(src: ptr RWops; kind: MusicType; freesrc: cint): ptr Music
|
||||
quickLoad_WAV sdl2/sdl2_mixer.html#quickLoad_WAV,ptr.Uint8 sdl2_mixer: quickLoad_WAV(mem: ptr Uint8): ptr Chunk
|
||||
quickLoad_RAW sdl2/sdl2_mixer.html#quickLoad_RAW,ptr.Uint8,Uint32 sdl2_mixer: quickLoad_RAW(mem: ptr Uint8; len: Uint32): ptr Chunk
|
||||
freeChunk sdl2/sdl2_mixer.html#freeChunk,ptr.Chunk sdl2_mixer: freeChunk(chunk: ptr Chunk)
|
||||
freeMusic sdl2/sdl2_mixer.html#freeMusic,ptr.Music sdl2_mixer: freeMusic(music: ptr Music)
|
||||
getNumChunkDecoders sdl2/sdl2_mixer.html#getNumChunkDecoders sdl2_mixer: getNumChunkDecoders(): cint
|
||||
getChunkDecoder sdl2/sdl2_mixer.html#getChunkDecoder,cint sdl2_mixer: getChunkDecoder(index: cint): cstring
|
||||
hasChunkDecoder sdl2/sdl2_mixer.html#hasChunkDecoder,cstring sdl2_mixer: hasChunkDecoder(name: cstring): bool
|
||||
getNumMusicDecoders sdl2/sdl2_mixer.html#getNumMusicDecoders sdl2_mixer: getNumMusicDecoders(): cint
|
||||
getMusicDecoder sdl2/sdl2_mixer.html#getMusicDecoder,cint sdl2_mixer: getMusicDecoder(index: cint): cstring
|
||||
hasMusicDecoder sdl2/sdl2_mixer.html#hasMusicDecoder,cstring sdl2_mixer: hasMusicDecoder(name: cstring): bool
|
||||
getMusicType sdl2/sdl2_mixer.html#getMusicType,ptr.Music sdl2_mixer: getMusicType(music: ptr Music): MusicType
|
||||
setPostMix sdl2/sdl2_mixer.html#setPostMix,proc(pointer,ptr.Uint8,cint),pointer sdl2_mixer: setPostMix(mixFunc: proc (udata: pointer; stream: ptr Uint8; len: cint) {.cdecl.};\n arg: pointer)
|
||||
hookMusic sdl2/sdl2_mixer.html#hookMusic,proc(pointer,ptr.Uint8,cint),pointer sdl2_mixer: hookMusic(mixFunc: proc (udata: pointer; stream: ptr Uint8; len: cint) {.cdecl.};\n arg: pointer)
|
||||
hookMusicFinished sdl2/sdl2_mixer.html#hookMusicFinished,proc) sdl2_mixer: hookMusicFinished(musicFinished: proc () {.cdecl.})
|
||||
getMusicHookData sdl2/sdl2_mixer.html#getMusicHookData sdl2_mixer: getMusicHookData(): pointer
|
||||
channelFinished sdl2/sdl2_mixer.html#channelFinished,proc(cint) sdl2_mixer: channelFinished(channelFinished: proc (channel: cint) {.cdecl.})
|
||||
registerEffect sdl2/sdl2_mixer.html#registerEffect,cint,EffectFunc_t,EffectDone_t,pointer sdl2_mixer: registerEffect(chan: cint; f: EffectFunc_t; d: EffectDone_t; arg: pointer): cint
|
||||
unregisterEffect sdl2/sdl2_mixer.html#unregisterEffect,cint,EffectFunc_t sdl2_mixer: unregisterEffect(channel: cint; f: EffectFunc_t): cint
|
||||
unregisterAllEffects sdl2/sdl2_mixer.html#unregisterAllEffects,cint sdl2_mixer: unregisterAllEffects(channel: cint): cint
|
||||
setPanning sdl2/sdl2_mixer.html#setPanning,cint,Uint8,Uint8 sdl2_mixer: setPanning(channel: cint; left: Uint8; right: Uint8): cint
|
||||
setPosition sdl2/sdl2_mixer.html#setPosition,cint,Sint16,Uint8 sdl2_mixer: setPosition(channel: cint; angle: Sint16; distance: Uint8): cint
|
||||
setDistance sdl2/sdl2_mixer.html#setDistance,cint,Uint8 sdl2_mixer: setDistance(channel: cint; distance: Uint8): cint
|
||||
setReverseStereo sdl2/sdl2_mixer.html#setReverseStereo,cint,cint sdl2_mixer: setReverseStereo(channel: cint; flip: cint): cint
|
||||
reserveChannels sdl2/sdl2_mixer.html#reserveChannels,cint sdl2_mixer: reserveChannels(num: cint): cint
|
||||
groupChannel sdl2/sdl2_mixer.html#groupChannel,cint,cint sdl2_mixer: groupChannel(which: cint; tag: cint): cint
|
||||
groupChannels sdl2/sdl2_mixer.html#groupChannels,cint,cint,cint sdl2_mixer: groupChannels(`from`: cint; to: cint; tag: cint): cint
|
||||
groupAvailable sdl2/sdl2_mixer.html#groupAvailable,cint sdl2_mixer: groupAvailable(tag: cint): cint
|
||||
groupCount sdl2/sdl2_mixer.html#groupCount,cint sdl2_mixer: groupCount(tag: cint): cint
|
||||
groupOldest sdl2/sdl2_mixer.html#groupOldest,cint sdl2_mixer: groupOldest(tag: cint): cint
|
||||
groupNewer sdl2/sdl2_mixer.html#groupNewer,cint sdl2_mixer: groupNewer(tag: cint): cint
|
||||
playChannelTimed sdl2/sdl2_mixer.html#playChannelTimed,cint,ptr.Chunk,cint,cint sdl2_mixer: playChannelTimed(channel: cint; chunk: ptr Chunk; loops: cint; ticks: cint): cint
|
||||
playMusic sdl2/sdl2_mixer.html#playMusic,ptr.Music,cint sdl2_mixer: playMusic(music: ptr Music; loops: cint): cint
|
||||
fadeInMusic sdl2/sdl2_mixer.html#fadeInMusic,ptr.Music,cint,cint sdl2_mixer: fadeInMusic(music: ptr Music; loops: cint; ms: cint): cint
|
||||
fadeInMusicPos sdl2/sdl2_mixer.html#fadeInMusicPos,ptr.Music,cint,cint,cdouble sdl2_mixer: fadeInMusicPos(music: ptr Music; loops: cint; ms: cint; position: cdouble): cint
|
||||
fadeInChannelTimed sdl2/sdl2_mixer.html#fadeInChannelTimed,cint,ptr.Chunk,cint,cint,cint sdl2_mixer: fadeInChannelTimed(channel: cint; chunk: ptr Chunk; loops: cint; ms: cint; ticks: cint): cint
|
||||
volume sdl2/sdl2_mixer.html#volume,cint,cint sdl2_mixer: volume(channel: cint; volume: cint): cint
|
||||
volumeChunk sdl2/sdl2_mixer.html#volumeChunk,ptr.Chunk,cint sdl2_mixer: volumeChunk(chunk: ptr Chunk; volume: cint): cint
|
||||
volumeMusic sdl2/sdl2_mixer.html#volumeMusic,cint sdl2_mixer: volumeMusic(volume: cint): cint
|
||||
haltChannel sdl2/sdl2_mixer.html#haltChannel,cint sdl2_mixer: haltChannel(channel: cint): cint
|
||||
haltGroup sdl2/sdl2_mixer.html#haltGroup,cint sdl2_mixer: haltGroup(tag: cint): cint
|
||||
haltMusic sdl2/sdl2_mixer.html#haltMusic sdl2_mixer: haltMusic(): cint
|
||||
expireChannel sdl2/sdl2_mixer.html#expireChannel,cint,cint sdl2_mixer: expireChannel(channel: cint; ticks: cint): cint
|
||||
fadeOutChannel sdl2/sdl2_mixer.html#fadeOutChannel,cint,cint sdl2_mixer: fadeOutChannel(which: cint; ms: cint): cint
|
||||
fadeOutGroup sdl2/sdl2_mixer.html#fadeOutGroup,cint,cint sdl2_mixer: fadeOutGroup(tag: cint; ms: cint): cint
|
||||
fadeOutMusic sdl2/sdl2_mixer.html#fadeOutMusic,cint sdl2_mixer: fadeOutMusic(ms: cint): cint
|
||||
fadingMusic sdl2/sdl2_mixer.html#fadingMusic sdl2_mixer: fadingMusic(): Fading
|
||||
fadingChannel sdl2/sdl2_mixer.html#fadingChannel,cint sdl2_mixer: fadingChannel(which: cint): Fading
|
||||
pause sdl2/sdl2_mixer.html#pause,cint sdl2_mixer: pause(channel: cint)
|
||||
resume sdl2/sdl2_mixer.html#resume,cint sdl2_mixer: resume(channel: cint)
|
||||
paused sdl2/sdl2_mixer.html#paused,cint sdl2_mixer: paused(channel: cint): cint
|
||||
pauseMusic sdl2/sdl2_mixer.html#pauseMusic sdl2_mixer: pauseMusic()
|
||||
resumeMusic sdl2/sdl2_mixer.html#resumeMusic sdl2_mixer: resumeMusic()
|
||||
rewindMusic sdl2/sdl2_mixer.html#rewindMusic sdl2_mixer: rewindMusic()
|
||||
pausedMusic sdl2/sdl2_mixer.html#pausedMusic sdl2_mixer: pausedMusic(): cint
|
||||
setMusicPosition sdl2/sdl2_mixer.html#setMusicPosition,cdouble sdl2_mixer: setMusicPosition(position: cdouble): cint
|
||||
playing sdl2/sdl2_mixer.html#playing,cint sdl2_mixer: playing(channel: cint): cint
|
||||
playingMusic sdl2/sdl2_mixer.html#playingMusic sdl2_mixer: playingMusic(): cint
|
||||
setMusicCMD sdl2/sdl2_mixer.html#setMusicCMD,cstring sdl2_mixer: setMusicCMD(command: cstring): cint
|
||||
setSynchroValue sdl2/sdl2_mixer.html#setSynchroValue,cint sdl2_mixer: setSynchroValue(value: cint): cint
|
||||
getSynchroValue sdl2/sdl2_mixer.html#getSynchroValue sdl2_mixer: getSynchroValue(): cint
|
||||
setSoundFonts sdl2/sdl2_mixer.html#setSoundFonts,cstring sdl2_mixer: setSoundFonts(paths: cstring): cint
|
||||
getSoundFonts sdl2/sdl2_mixer.html#getSoundFonts sdl2_mixer: getSoundFonts(): cstring
|
||||
eachSoundFont sdl2/sdl2_mixer.html#eachSoundFont,proc(cstring,pointer),pointer sdl2_mixer: eachSoundFont(function: proc (a1: cstring; a2: pointer): cint {.cdecl.}; data: pointer): cint
|
||||
getChunk sdl2/sdl2_mixer.html#getChunk,cint sdl2_mixer: getChunk(channel: cint): ptr Chunk
|
||||
closeAudio sdl2/sdl2_mixer.html#closeAudio sdl2_mixer: closeAudio()
|
||||
892
docs/sdl2/sdl2_net.html
Normal file
892
docs/sdl2/sdl2_net.html
Normal file
|
|
@ -0,0 +1,892 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<!-- This file is generated by Nim. -->
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
||||
|
||||
<!-- Google fonts -->
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
||||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<!-- CSS -->
|
||||
<title>sdl2/sdl2_net</title>
|
||||
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
|
||||
|
||||
<script type="text/javascript" src="dochack.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
function main() {
|
||||
var pragmaDots = document.getElementsByClassName("pragmadots");
|
||||
for (var i = 0; i < pragmaDots.length; i++) {
|
||||
pragmaDots[i].onclick = function(event) {
|
||||
// Hide tease
|
||||
event.target.parentNode.style.display = "none";
|
||||
// Show actual
|
||||
event.target.parentNode.nextElementSibling.style.display = "inline";
|
||||
}
|
||||
}
|
||||
|
||||
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
||||
function switchTheme(e) {
|
||||
if (e.target.checked) {
|
||||
document.documentElement.setAttribute('data-theme', 'dark');
|
||||
localStorage.setItem('theme', 'dark');
|
||||
} else {
|
||||
document.documentElement.setAttribute('data-theme', 'light');
|
||||
localStorage.setItem('theme', 'light');
|
||||
}
|
||||
}
|
||||
|
||||
toggleSwitch.addEventListener('change', switchTheme, false);
|
||||
|
||||
|
||||
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "dark");
|
||||
toggleSwitch.checked = true;
|
||||
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "light");
|
||||
toggleSwitch.checked = false;
|
||||
} else {
|
||||
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
|
||||
if (currentTheme) {
|
||||
document.documentElement.setAttribute('data-theme', currentTheme);
|
||||
|
||||
if (currentTheme === 'dark') {
|
||||
toggleSwitch.checked = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
</head>
|
||||
<body onload="main()">
|
||||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">sdl2/sdl2_net</h1>
|
||||
<div class="row">
|
||||
<div class="three columns">
|
||||
<div class="theme-switch-wrapper">
|
||||
<label class="theme-switch" for="checkbox">
|
||||
<input type="checkbox" id="checkbox" />
|
||||
<div class="slider round"></div>
|
||||
</label>
|
||||
<em>Dark Mode</em>
|
||||
</div>
|
||||
<div id="global-links">
|
||||
<ul class="simple">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchInputDiv">
|
||||
Search: <input type="text" id="searchInput"
|
||||
onkeyup="search()" />
|
||||
</div>
|
||||
<div>
|
||||
Group by:
|
||||
<select onchange="groupBy(this.value)">
|
||||
<option value="section">Section</option>
|
||||
<option value="type">Type</option>
|
||||
</select>
|
||||
</div>
|
||||
<ul class="simple simple-toc" id="toc-list">
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#Version"
|
||||
title="Version = sdl2.Version"><wbr />Version<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#IPaddress"
|
||||
title="IPaddress {.bycopy.} = object
|
||||
host*: Uint32 ## ::
|
||||
## 32-bit IPv4 host address
|
||||
port*: Uint16 ## ::
|
||||
## 16-bit protocol port"><wbr />IPaddress<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#TCPsocket"
|
||||
title="TCPsocket {.incompleteStruct.} = object"><wbr />TCPsocket<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#UDPsocket"
|
||||
title="UDPsocket {.incompleteStruct.} = object"><wbr />UDPsocket<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#UDPpacket"
|
||||
title="UDPpacket {.bycopy.} = object
|
||||
channel*: cint ## ::
|
||||
## The src/dst channel of the packet
|
||||
data*: ptr Uint8 ## ::
|
||||
## The packet data
|
||||
len*: cint ## ::
|
||||
## The length of the packet data
|
||||
maxlen*: cint ## ::
|
||||
## The size of the data buffer
|
||||
status*: cint ## ::
|
||||
## packet status after sending
|
||||
address*: IPaddress ## ::
|
||||
## The source/dest address of an incoming/outgoing packet"><wbr />UDPpacket<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SocketSet"
|
||||
title="SocketSet {.incompleteStruct.} = object"><wbr />Socket<wbr />Set<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#GenericSocket"
|
||||
title="GenericSocket {.bycopy.} = object
|
||||
ready*: cint"><wbr />Generic<wbr />Socket<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#SDLnetStd"
|
||||
title="SDLnetStd = false"><wbr />SDLnet<wbr />Std<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetGit"
|
||||
title="SDLnetGit = false"><wbr />SDLnet<wbr />Git<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetDL"
|
||||
title="SDLnetDL = true"><wbr />SDLnet<wbr />DL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetStatic"
|
||||
title="SDLnetStatic = true"><wbr />SDLnet<wbr />Static<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetSetVer"
|
||||
title="SDLnetSetVer = """><wbr />SDLnet<wbr />Set<wbr />Ver<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetLPath"
|
||||
title="SDLnetLPath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_net/.libs/libSDL2_net.a""><wbr />SDLnet<wbr />LPath<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLnetPath"
|
||||
title="SDLnetPath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_net/SDL_net.h""><wbr />SDLnet<wbr />Path<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#NET_MAJOR_VERSION"
|
||||
title="NET_MAJOR_VERSION = 2"><wbr />NET_<wbr />MAJOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#NET_MINOR_VERSION"
|
||||
title="NET_MINOR_VERSION = 0"><wbr />NET_<wbr />MINOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#NET_PATCHLEVEL"
|
||||
title="NET_PATCHLEVEL = 1"><wbr />NET_<wbr />PATCHLEVEL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INADDR_ANY"
|
||||
title="INADDR_ANY = 0x00000000"><wbr />INADDR_<wbr />ANY<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INADDR_NONE"
|
||||
title="INADDR_NONE = 0x00000000FFFFFFFF'i64"><wbr />INADDR_<wbr />NONE<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INADDR_LOOPBACK"
|
||||
title="INADDR_LOOPBACK = 0x7F000001"><wbr />INADDR_<wbr />LOOPBACK<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INADDR_BROADCAST"
|
||||
title="INADDR_BROADCAST = 0x00000000FFFFFFFF'i64"><wbr />INADDR_<wbr />BROADCAST<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLNET_MAX_UDPCHANNELS"
|
||||
title="SDLNET_MAX_UDPCHANNELS = 32"><wbr />SDLNET_<wbr />MAX_<wbr />UDPCHANNELS<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLNET_MAX_UDPADDRESSES"
|
||||
title="SDLNET_MAX_UDPADDRESSES = 4"><wbr />SDLNET_<wbr />MAX_<wbr />UDPADDRESSES<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#DATA_ALIGNED"
|
||||
title="DATA_ALIGNED = 0"><wbr />DATA_<wbr />ALIGNED<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#INVALID_SOCKET"
|
||||
title="INVALID_SOCKET = -1"><wbr />INVALID_<wbr />SOCKET<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SOCKET_ERROR"
|
||||
title="SOCKET_ERROR = -1"><wbr />SOCKET_<wbr />ERROR<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#linked_Version"
|
||||
title="linked_Version(): ptr Version"><wbr />linked_<wbr />Version<span class="attachedType">Version</span></a></li>
|
||||
<li><a class="reference" href="#init"
|
||||
title="init(): cint"><wbr />init<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#quit"
|
||||
title="quit()"><wbr />quit<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#resolveHost%2Cptr.IPaddress%2Ccstring%2CUint16"
|
||||
title="resolveHost(address: ptr IPaddress; host: cstring; port: Uint16): cint"><wbr />resolve<wbr />Host<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#resolveIP%2Cptr.IPaddress"
|
||||
title="resolveIP(ip: ptr IPaddress): cstring"><wbr />resolve<wbr />IP<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getLocalAddresses%2Cptr.IPaddress%2Ccint"
|
||||
title="getLocalAddresses(addresses: ptr IPaddress; maxcount: cint): cint"><wbr />get<wbr />Local<wbr />Addresses<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_Open%2Cptr.IPaddress"
|
||||
title="tCP_Open(ip: ptr IPaddress): TCPsocket"><wbr />t<wbr />CP_<wbr />Open<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_Accept%2CTCPsocket"
|
||||
title="tCP_Accept(server: TCPsocket): TCPsocket"><wbr />t<wbr />CP_<wbr />Accept<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_GetPeerAddress%2CTCPsocket"
|
||||
title="tCP_GetPeerAddress(sock: TCPsocket): ptr IPaddress"><wbr />t<wbr />CP_<wbr />Get<wbr />Peer<wbr />Address<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_Send%2CTCPsocket%2Cpointer%2Ccint"
|
||||
title="tCP_Send(sock: TCPsocket; data: pointer; len: cint): cint"><wbr />t<wbr />CP_<wbr />Send<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_Recv%2CTCPsocket%2Cpointer%2Ccint"
|
||||
title="tCP_Recv(sock: TCPsocket; data: pointer; maxlen: cint): cint"><wbr />t<wbr />CP_<wbr />Recv<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#tCP_Close%2CTCPsocket"
|
||||
title="tCP_Close(sock: TCPsocket)"><wbr />t<wbr />CP_<wbr />Close<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#allocPacket%2Ccint"
|
||||
title="allocPacket(size: cint): ptr UDPpacket"><wbr />alloc<wbr />Packet<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#resizePacket%2Cptr.UDPpacket%2Ccint"
|
||||
title="resizePacket(packet: ptr UDPpacket; newsize: cint): cint"><wbr />resize<wbr />Packet<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#freePacket%2Cptr.UDPpacket"
|
||||
title="freePacket(packet: ptr UDPpacket)"><wbr />free<wbr />Packet<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#allocPacketV%2Ccint%2Ccint"
|
||||
title="allocPacketV(howmany: cint; size: cint): ptr ptr UDPpacket"><wbr />alloc<wbr />Packet<wbr />V<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#freePacketV%2Cptr.ptr.UDPpacket"
|
||||
title="freePacketV(packetV: ptr ptr UDPpacket)"><wbr />free<wbr />Packet<wbr />V<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Open%2CUint16"
|
||||
title="uDP_Open(port: Uint16): UDPsocket"><wbr />u<wbr />DP_<wbr />Open<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_SetPacketLoss%2CUDPsocket%2Ccint"
|
||||
title="uDP_SetPacketLoss(sock: UDPsocket; percent: cint)"><wbr />u<wbr />DP_<wbr />Set<wbr />Packet<wbr />Loss<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Bind%2CUDPsocket%2Ccint%2Cptr.IPaddress"
|
||||
title="uDP_Bind(sock: UDPsocket; channel: cint; address: ptr IPaddress): cint"><wbr />u<wbr />DP_<wbr />Bind<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Unbind%2CUDPsocket%2Ccint"
|
||||
title="uDP_Unbind(sock: UDPsocket; channel: cint)"><wbr />u<wbr />DP_<wbr />Unbind<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_GetPeerAddress%2CUDPsocket%2Ccint"
|
||||
title="uDP_GetPeerAddress(sock: UDPsocket; channel: cint): ptr IPaddress"><wbr />u<wbr />DP_<wbr />Get<wbr />Peer<wbr />Address<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_SendV%2CUDPsocket%2Cptr.ptr.UDPpacket%2Ccint"
|
||||
title="uDP_SendV(sock: UDPsocket; packets: ptr ptr UDPpacket; npackets: cint): cint"><wbr />u<wbr />DP_<wbr />Send<wbr />V<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Send%2CUDPsocket%2Ccint%2Cptr.UDPpacket"
|
||||
title="uDP_Send(sock: UDPsocket; channel: cint; packet: ptr UDPpacket): cint"><wbr />u<wbr />DP_<wbr />Send<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_RecvV%2CUDPsocket%2Cptr.ptr.UDPpacket"
|
||||
title="uDP_RecvV(sock: UDPsocket; packets: ptr ptr UDPpacket): cint"><wbr />u<wbr />DP_<wbr />Recv<wbr />V<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Recv%2CUDPsocket%2Cptr.UDPpacket"
|
||||
title="uDP_Recv(sock: UDPsocket; packet: ptr UDPpacket): cint"><wbr />u<wbr />DP_<wbr />Recv<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#uDP_Close%2CUDPsocket"
|
||||
title="uDP_Close(sock: UDPsocket)"><wbr />u<wbr />DP_<wbr />Close<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#allocSocketSet%2Ccint"
|
||||
title="allocSocketSet(maxsockets: cint): SocketSet"><wbr />alloc<wbr />Socket<wbr />Set<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#addSocket%2CSocketSet%2CGenericSocket"
|
||||
title="addSocket(set: SocketSet; sock: GenericSocket): cint"><wbr />add<wbr />Socket<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#delSocket%2CSocketSet%2CGenericSocket"
|
||||
title="delSocket(set: SocketSet; sock: GenericSocket): cint"><wbr />del<wbr />Socket<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#checkSockets%2CSocketSet%2CUint32"
|
||||
title="checkSockets(set: SocketSet; timeout: Uint32): cint"><wbr />check<wbr />Sockets<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#freeSocketSet%2CSocketSet"
|
||||
title="freeSocketSet(set: SocketSet)"><wbr />free<wbr />Socket<wbr />Set<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setError%2Ccstring"
|
||||
title="setError(fmt: cstring)"><wbr />set<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getError"
|
||||
title="getError(): cstring"><wbr />get<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getLastError"
|
||||
title="getLastError(): cint"><wbr />get<wbr />Last<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setLastError%2Ccint"
|
||||
title="setLastError(err: cint)"><wbr />set<wbr />Last<wbr />Error<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div class="nine columns" id="content">
|
||||
<div id="tocRoot"></div>
|
||||
|
||||
<p class="module-desc"></p>
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="sdl2.html">sdl2</a>
|
||||
</dl></div>
|
||||
<div class="section" id="7">
|
||||
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
||||
<dl class="item">
|
||||
<a id="Version"></a>
|
||||
<dt><pre><a href="sdl2_net.html#Version"><span class="Identifier">Version</span></a> <span class="Other">=</span> <span class="Identifier">sdl2</span><span class="Other">.</span><span class="Identifier">Version</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="IPaddress"></a>
|
||||
<dt><pre><a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">bycopy</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span>
|
||||
<span class="Identifier">host</span><span class="Operator">*</span><span class="Other">:</span> <a href="sdl2.html#Uint32"><span class="Identifier">Uint32</span></a> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## 32-bit IPv4 host address</span>
|
||||
<span class="Identifier">port</span><span class="Operator">*</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## 16-bit protocol port</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>
|
||||
IPv4 hostname resolution API</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="TCPsocket"></a>
|
||||
<dt><pre><a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">incompleteStruct</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="UDPsocket"></a>
|
||||
<dt><pre><a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">incompleteStruct</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="UDPpacket"></a>
|
||||
<dt><pre><a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">bycopy</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span>
|
||||
<span class="Identifier">channel</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## The src/dst channel of the packet</span>
|
||||
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint8"><span class="Identifier">Uint8</span></a> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## The packet data</span>
|
||||
<span class="Identifier">len</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## The length of the packet data</span>
|
||||
<span class="Identifier">maxlen</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## The size of the data buffer</span>
|
||||
<span class="Identifier">status</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## packet status after sending</span>
|
||||
<span class="Identifier">address</span><span class="Operator">*</span><span class="Other">:</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a> <span class="Comment">## ::</span>
|
||||
<span class="Comment">## The source/dest address of an incoming/outgoing packet</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SocketSet"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">incompleteStruct</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="GenericSocket"></a>
|
||||
<dt><pre><a href="sdl2_net.html#GenericSocket"><span class="Identifier">GenericSocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">bycopy</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span>
|
||||
<span class="Identifier">ready</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">cint</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Any network socket can be safely cast to this socket type</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="10">
|
||||
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
||||
<dl class="item">
|
||||
<a id="SDLnetStd"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetStd"><span class="Identifier">SDLnetStd</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetGit"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetGit"><span class="Identifier">SDLnetGit</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetDL"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetDL"><span class="Identifier">SDLnetDL</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetStatic"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetStatic"><span class="Identifier">SDLnetStatic</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetSetVer"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetSetVer"><span class="Identifier">SDLnetSetVer</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetLPath"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetLPath"><span class="Identifier">SDLnetLPath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_net/.libs/libSDL2_net.a"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLnetPath"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLnetPath"><span class="Identifier">SDLnetPath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_net/SDL_net.h"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="NET_MAJOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_net.html#NET_MAJOR_VERSION"><span class="Identifier">NET_MAJOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="NET_MINOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_net.html#NET_MINOR_VERSION"><span class="Identifier">NET_MINOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="NET_PATCHLEVEL"></a>
|
||||
<dt><pre><a href="sdl2_net.html#NET_PATCHLEVEL"><span class="Identifier">NET_PATCHLEVEL</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INADDR_ANY"></a>
|
||||
<dt><pre><a href="sdl2_net.html#INADDR_ANY"><span class="Identifier">INADDR_ANY</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000000</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INADDR_NONE"></a>
|
||||
<dt><pre><a href="sdl2_net.html#INADDR_NONE"><span class="Identifier">INADDR_NONE</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000000FFFFFFFF'i64</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INADDR_LOOPBACK"></a>
|
||||
<dt><pre><a href="sdl2_net.html#INADDR_LOOPBACK"><span class="Identifier">INADDR_LOOPBACK</span></a> <span class="Other">=</span> <span class="DecNumber">0x7F000001</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INADDR_BROADCAST"></a>
|
||||
<dt><pre><a href="sdl2_net.html#INADDR_BROADCAST"><span class="Identifier">INADDR_BROADCAST</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000000FFFFFFFF'i64</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLNET_MAX_UDPCHANNELS"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLNET_MAX_UDPCHANNELS"><span class="Identifier">SDLNET_MAX_UDPCHANNELS</span></a> <span class="Other">=</span> <span class="DecNumber">32</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLNET_MAX_UDPADDRESSES"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SDLNET_MAX_UDPADDRESSES"><span class="Identifier">SDLNET_MAX_UDPADDRESSES</span></a> <span class="Other">=</span> <span class="DecNumber">4</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="DATA_ALIGNED"></a>
|
||||
<dt><pre><a href="sdl2_net.html#DATA_ALIGNED"><span class="Identifier">DATA_ALIGNED</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="INVALID_SOCKET"></a>
|
||||
<dt><pre><a href="sdl2_net.html#INVALID_SOCKET"><span class="Identifier">INVALID_SOCKET</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SOCKET_ERROR"></a>
|
||||
<dt><pre><a href="sdl2_net.html#SOCKET_ERROR"><span class="Identifier">SOCKET_ERROR</span></a> <span class="Other">=</span> <span class="DecNumber">-1</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<a id="linked_Version"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#linked_Version"><span class="Identifier">linked_Version</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#Version"><span class="Identifier">Version</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_Linked_Version"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>This function gets the version of the dynamically linked SDL_net library.
|
||||
it should NOT be used to fill a version structure, instead you should
|
||||
use the SDL_NET_VERSION() macro.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="init"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#init"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_Init"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Initialize/Cleanup the network API
|
||||
SDL must be initialized before calls to functions in this library,
|
||||
because this library uses utility functions from the SDL library.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="quit"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#quit"><span class="Identifier">quit</span></a><span class="Other">(</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_Quit"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="resolveHost,ptr.IPaddress,cstring,Uint16"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#resolveHost%2Cptr.IPaddress%2Ccstring%2CUint16"><span class="Identifier">resolveHost</span></a><span class="Other">(</span><span class="Identifier">address</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a><span class="Other">;</span> <span class="Identifier">host</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_ResolveHost"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="resolveIP,ptr.IPaddress"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#resolveIP%2Cptr.IPaddress"><span class="Identifier">resolveIP</span></a><span class="Other">(</span><span class="Identifier">ip</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_ResolveIP"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Resolve an ip address to a host name in canonical form.
|
||||
If the ip couldn't be resolved, this function returns NULL,
|
||||
otherwise a pointer to a static buffer containing the hostname
|
||||
is returned. Note that this function is not thread-safe.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getLocalAddresses,ptr.IPaddress,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getLocalAddresses%2Cptr.IPaddress%2Ccint"><span class="Identifier">getLocalAddresses</span></a><span class="Other">(</span><span class="Identifier">addresses</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a><span class="Other">;</span> <span class="Identifier">maxcount</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_GetLocalAddresses"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the addresses of network interfaces on this system.
|
||||
This returns the number of addresses saved in 'addresses'</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_Open,ptr.IPaddress"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_Open%2Cptr.IPaddress"><span class="Identifier">tCP_Open</span></a><span class="Other">(</span><span class="Identifier">ip</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_Open"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Open a TCP network socket
|
||||
If ip.host is INADDR_NONE or INADDR_ANY, this creates a local server
|
||||
socket on the given port, otherwise a TCP connection to the remote
|
||||
host and port is attempted. The address passed in should already be
|
||||
swapped to network byte order (addresses returned from
|
||||
SDLNet_ResolveHost() are already in the correct form).
|
||||
The newly created socket is returned, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_Accept,TCPsocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_Accept%2CTCPsocket"><span class="Identifier">tCP_Accept</span></a><span class="Other">(</span><span class="Identifier">server</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_Accept"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Accept an incoming connection on the given server socket.
|
||||
The newly created socket is returned, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_GetPeerAddress,TCPsocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_GetPeerAddress%2CTCPsocket"><span class="Identifier">tCP_GetPeerAddress</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_GetPeerAddress"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the IP address of the remote system associated with the socket.
|
||||
If the socket is a server socket, this function returns NULL.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_Send,TCPsocket,pointer,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_Send%2CTCPsocket%2Cpointer%2Ccint"><span class="Identifier">tCP_Send</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">len</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_Send"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Send 'len' bytes of 'data' over the non-server socket 'sock'
|
||||
This function returns the actual amount of data sent. If the return value
|
||||
is less than the amount of data sent, then either the remote connection was
|
||||
closed, or an unknown socket error occurred.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_Recv,TCPsocket,pointer,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_Recv%2CTCPsocket%2Cpointer%2Ccint"><span class="Identifier">tCP_Recv</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">maxlen</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_Recv"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Receive up to 'maxlen' bytes of data over the non-server socket 'sock',
|
||||
and store them in the buffer pointed to by 'data'.
|
||||
This function returns the actual amount of data received. If the return
|
||||
value is less than or equal to zero, then either the remote connection was
|
||||
closed, or an unknown socket error occurred.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="tCP_Close,TCPsocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#tCP_Close%2CTCPsocket"><span class="Identifier">tCP_Close</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#TCPsocket"><span class="Identifier">TCPsocket</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_TCP_Close"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Close a TCP network socket</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="allocPacket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#allocPacket%2Ccint"><span class="Identifier">allocPacket</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_AllocPacket"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Allocate/resize/free a single UDP packet 'size' bytes long.
|
||||
The new packet is returned, or NULL if the function ran out of memory.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="resizePacket,ptr.UDPpacket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#resizePacket%2Cptr.UDPpacket%2Ccint"><span class="Identifier">resizePacket</span></a><span class="Other">(</span><span class="Identifier">packet</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">;</span> <span class="Identifier">newsize</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_ResizePacket"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="freePacket,ptr.UDPpacket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#freePacket%2Cptr.UDPpacket"><span class="Identifier">freePacket</span></a><span class="Other">(</span><span class="Identifier">packet</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_FreePacket"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="allocPacketV,cint,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#allocPacketV%2Ccint%2Ccint"><span class="Identifier">allocPacketV</span></a><span class="Other">(</span><span class="Identifier">howmany</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_AllocPacketV"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Allocate/Free a UDP packet vector (array of packets) of 'howmany' packets,
|
||||
each 'size' bytes long.
|
||||
A pointer to the first packet in the array is returned, or NULL if the
|
||||
function ran out of memory.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="freePacketV,ptr.ptr.UDPpacket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#freePacketV%2Cptr.ptr.UDPpacket"><span class="Identifier">freePacketV</span></a><span class="Other">(</span><span class="Identifier">packetV</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_FreePacketV"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Open,Uint16"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Open%2CUint16"><span class="Identifier">uDP_Open</span></a><span class="Other">(</span><span class="Identifier">port</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Open"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Open a UDP network socket
|
||||
If 'port' is non-zero, the UDP socket is bound to a local port.
|
||||
The 'port' should be given in native byte order, but is used
|
||||
internally in network (big endian) byte order, in addresses, etc.
|
||||
This allows other systems to send to this socket via a known port.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_SetPacketLoss,UDPsocket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_SetPacketLoss%2CUDPsocket%2Ccint"><span class="Identifier">uDP_SetPacketLoss</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">percent</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_SetPacketLoss"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Set the percentage of simulated packet loss for packets sent on the socket.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Bind,UDPsocket,cint,ptr.IPaddress"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Bind%2CUDPsocket%2Ccint%2Cptr.IPaddress"><span class="Identifier">uDP_Bind</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">channel</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Bind"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Bind the address 'address' to the requested channel on the UDP socket.
|
||||
If the channel is -1, then the first unbound channel that has not yet
|
||||
been bound to the maximum number of addresses will be bound with
|
||||
the given address as it's primary address.
|
||||
If the channel is already bound, this new address will be added to the
|
||||
list of valid source addresses for packets arriving on the channel.
|
||||
If the channel is not already bound, then the address becomes the primary
|
||||
address, to which all outbound packets on the channel are sent.
|
||||
This function returns the channel which was bound, or -1 on error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Unbind,UDPsocket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Unbind%2CUDPsocket%2Ccint"><span class="Identifier">uDP_Unbind</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">channel</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Unbind"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Unbind all addresses from the given channel</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_GetPeerAddress,UDPsocket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_GetPeerAddress%2CUDPsocket%2Ccint"><span class="Identifier">uDP_GetPeerAddress</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">channel</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#IPaddress"><span class="Identifier">IPaddress</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_GetPeerAddress"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the primary IP address of the remote system associated with the
|
||||
socket and channel. If the channel is -1, then the primary IP port
|
||||
of the UDP socket is returned -- this is only meaningful for sockets
|
||||
opened with a specific port.
|
||||
If the channel is not bound and not -1, this function returns NULL.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_SendV,UDPsocket,ptr.ptr.UDPpacket,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_SendV%2CUDPsocket%2Cptr.ptr.UDPpacket%2Ccint"><span class="Identifier">uDP_SendV</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">packets</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">;</span> <span class="Identifier">npackets</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_SendV"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Send a vector of packets to the the channels specified within the packet.
|
||||
If the channel specified in the packet is -1, the packet will be sent to
|
||||
the address in the 'src' member of the packet.
|
||||
Each packet will be updated with the status of the packet after it has
|
||||
been sent, -1 if the packet send failed.
|
||||
This function returns the number of packets sent.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Send,UDPsocket,cint,ptr.UDPpacket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Send%2CUDPsocket%2Ccint%2Cptr.UDPpacket"><span class="Identifier">uDP_Send</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">channel</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">packet</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Send"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Send a single packet to the specified channel.
|
||||
If the channel specified in the packet is -1, the packet will be sent to
|
||||
the address in the 'src' member of the packet.
|
||||
The packet will be updated with the status of the packet after it has
|
||||
been sent.
|
||||
This function returns 1 if the packet was sent, or 0 on error.
|
||||
NOTE:
|
||||
The maximum size of the packet is limited by the MTU (Maximum Transfer Unit)
|
||||
of the transport medium. It can be as low as 250 bytes for some PPP links,
|
||||
and as high as 1500 bytes for ethernet.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_RecvV,UDPsocket,ptr.ptr.UDPpacket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_RecvV%2CUDPsocket%2Cptr.ptr.UDPpacket"><span class="Identifier">uDP_RecvV</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">packets</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_RecvV"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Receive a vector of pending packets from the UDP socket.
|
||||
The returned packets contain the source address and the channel they arrived
|
||||
on. If they did not arrive on a bound channel, the the channel will be set
|
||||
to -1.
|
||||
The channels are checked in highest to lowest order, so if an address is
|
||||
bound to multiple channels, the highest channel with the source address
|
||||
bound will be returned.
|
||||
This function returns the number of packets read from the network, or -1
|
||||
on error. This function does not block, so can return 0 packets pending.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Recv,UDPsocket,ptr.UDPpacket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Recv%2CUDPsocket%2Cptr.UDPpacket"><span class="Identifier">uDP_Recv</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">;</span> <span class="Identifier">packet</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_net.html#UDPpacket"><span class="Identifier">UDPpacket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Recv"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Receive a single packet from the UDP socket.
|
||||
The returned packet contains the source address and the channel it arrived
|
||||
on. If it did not arrive on a bound channel, the the channel will be set
|
||||
to -1.
|
||||
The channels are checked in highest to lowest order, so if an address is
|
||||
bound to multiple channels, the highest channel with the source address
|
||||
bound will be returned.
|
||||
This function returns the number of packets read from the network, or -1
|
||||
on error. This function does not block, so can return 0 packets pending.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="uDP_Close,UDPsocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#uDP_Close%2CUDPsocket"><span class="Identifier">uDP_Close</span></a><span class="Other">(</span><span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#UDPsocket"><span class="Identifier">UDPsocket</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_UDP_Close"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Close a UDP network socket</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="allocSocketSet,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#allocSocketSet%2Ccint"><span class="Identifier">allocSocketSet</span></a><span class="Other">(</span><span class="Identifier">maxsockets</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_AllocSocketSet"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Allocate a socket set for use with SDLNet_CheckSockets()
|
||||
This returns a socket set for up to 'maxsockets' sockets, or NULL if
|
||||
the function ran out of memory.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="addSocket,SocketSet,GenericSocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#addSocket%2CSocketSet%2CGenericSocket"><span class="Identifier">addSocket</span></a><span class="Other">(</span><span class="Identifier">set</span><span class="Other">:</span> <a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a><span class="Other">;</span> <span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#GenericSocket"><span class="Identifier">GenericSocket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_AddSocket"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Add a socket to a set of sockets to be checked for available data</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="delSocket,SocketSet,GenericSocket"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#delSocket%2CSocketSet%2CGenericSocket"><span class="Identifier">delSocket</span></a><span class="Other">(</span><span class="Identifier">set</span><span class="Other">:</span> <a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a><span class="Other">;</span> <span class="Identifier">sock</span><span class="Other">:</span> <a href="sdl2_net.html#GenericSocket"><span class="Identifier">GenericSocket</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_DelSocket"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Remove a socket from a set of sockets to be checked for available data</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="checkSockets,SocketSet,Uint32"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#checkSockets%2CSocketSet%2CUint32"><span class="Identifier">checkSockets</span></a><span class="Other">(</span><span class="Identifier">set</span><span class="Other">:</span> <a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <a href="sdl2.html#Uint32"><span class="Identifier">Uint32</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_CheckSockets"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>This function checks to see if data is available for reading on the
|
||||
given set of sockets. If 'timeout' is 0, it performs a quick poll,
|
||||
otherwise the function returns when either data is available for
|
||||
reading, or the timeout in milliseconds has elapsed, which ever occurs
|
||||
first. This function returns the number of sockets ready for reading,
|
||||
or -1 if there was an error with the select() system call.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="freeSocketSet,SocketSet"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#freeSocketSet%2CSocketSet"><span class="Identifier">freeSocketSet</span></a><span class="Other">(</span><span class="Identifier">set</span><span class="Other">:</span> <a href="sdl2_net.html#SocketSet"><span class="Identifier">SocketSet</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_FreeSocketSet"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Free a set of sockets allocated by SDL_NetAllocSocketSet()</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setError,cstring"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setError%2Ccstring"><span class="Identifier">setError</span></a><span class="Other">(</span><span class="Identifier">fmt</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_SetError"</span><span class="Other">,</span> <span class="Identifier">cdecl</span><span class="Other">,</span> <span class="Identifier">varargs</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>
|
||||
Error reporting functions</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getError"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getError"><span class="Identifier">getError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_GetError"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getLastError"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getLastError"><span class="Identifier">getLastError</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_GetLastError"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setLastError,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setLastError%2Ccint"><span class="Identifier">setLastError</span></a><span class="Other">(</span><span class="Identifier">err</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"SDLNet_SetLastError"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2020-04-26 21:10:29 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
62
docs/sdl2/sdl2_net.idx
Normal file
62
docs/sdl2/sdl2_net.idx
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
SDLnetStd sdl2/sdl2_net.html#SDLnetStd sdl2_net: SDLnetStd
|
||||
SDLnetGit sdl2/sdl2_net.html#SDLnetGit sdl2_net: SDLnetGit
|
||||
SDLnetDL sdl2/sdl2_net.html#SDLnetDL sdl2_net: SDLnetDL
|
||||
SDLnetStatic sdl2/sdl2_net.html#SDLnetStatic sdl2_net: SDLnetStatic
|
||||
SDLnetSetVer sdl2/sdl2_net.html#SDLnetSetVer sdl2_net: SDLnetSetVer
|
||||
SDLnetLPath sdl2/sdl2_net.html#SDLnetLPath sdl2_net: SDLnetLPath
|
||||
SDLnetPath sdl2/sdl2_net.html#SDLnetPath sdl2_net: SDLnetPath
|
||||
NET_MAJOR_VERSION sdl2/sdl2_net.html#NET_MAJOR_VERSION sdl2_net: NET_MAJOR_VERSION
|
||||
NET_MINOR_VERSION sdl2/sdl2_net.html#NET_MINOR_VERSION sdl2_net: NET_MINOR_VERSION
|
||||
NET_PATCHLEVEL sdl2/sdl2_net.html#NET_PATCHLEVEL sdl2_net: NET_PATCHLEVEL
|
||||
INADDR_ANY sdl2/sdl2_net.html#INADDR_ANY sdl2_net: INADDR_ANY
|
||||
INADDR_NONE sdl2/sdl2_net.html#INADDR_NONE sdl2_net: INADDR_NONE
|
||||
INADDR_LOOPBACK sdl2/sdl2_net.html#INADDR_LOOPBACK sdl2_net: INADDR_LOOPBACK
|
||||
INADDR_BROADCAST sdl2/sdl2_net.html#INADDR_BROADCAST sdl2_net: INADDR_BROADCAST
|
||||
SDLNET_MAX_UDPCHANNELS sdl2/sdl2_net.html#SDLNET_MAX_UDPCHANNELS sdl2_net: SDLNET_MAX_UDPCHANNELS
|
||||
SDLNET_MAX_UDPADDRESSES sdl2/sdl2_net.html#SDLNET_MAX_UDPADDRESSES sdl2_net: SDLNET_MAX_UDPADDRESSES
|
||||
DATA_ALIGNED sdl2/sdl2_net.html#DATA_ALIGNED sdl2_net: DATA_ALIGNED
|
||||
Version sdl2/sdl2_net.html#Version sdl2_net: Version
|
||||
IPaddress sdl2/sdl2_net.html#IPaddress sdl2_net: IPaddress
|
||||
TCPsocket sdl2/sdl2_net.html#TCPsocket sdl2_net: TCPsocket
|
||||
UDPsocket sdl2/sdl2_net.html#UDPsocket sdl2_net: UDPsocket
|
||||
UDPpacket sdl2/sdl2_net.html#UDPpacket sdl2_net: UDPpacket
|
||||
SocketSet sdl2/sdl2_net.html#SocketSet sdl2_net: SocketSet
|
||||
GenericSocket sdl2/sdl2_net.html#GenericSocket sdl2_net: GenericSocket
|
||||
linked_Version sdl2/sdl2_net.html#linked_Version sdl2_net: linked_Version(): ptr Version
|
||||
init sdl2/sdl2_net.html#init sdl2_net: init(): cint
|
||||
quit sdl2/sdl2_net.html#quit sdl2_net: quit()
|
||||
resolveHost sdl2/sdl2_net.html#resolveHost,ptr.IPaddress,cstring,Uint16 sdl2_net: resolveHost(address: ptr IPaddress; host: cstring; port: Uint16): cint
|
||||
resolveIP sdl2/sdl2_net.html#resolveIP,ptr.IPaddress sdl2_net: resolveIP(ip: ptr IPaddress): cstring
|
||||
getLocalAddresses sdl2/sdl2_net.html#getLocalAddresses,ptr.IPaddress,cint sdl2_net: getLocalAddresses(addresses: ptr IPaddress; maxcount: cint): cint
|
||||
tCP_Open sdl2/sdl2_net.html#tCP_Open,ptr.IPaddress sdl2_net: tCP_Open(ip: ptr IPaddress): TCPsocket
|
||||
tCP_Accept sdl2/sdl2_net.html#tCP_Accept,TCPsocket sdl2_net: tCP_Accept(server: TCPsocket): TCPsocket
|
||||
tCP_GetPeerAddress sdl2/sdl2_net.html#tCP_GetPeerAddress,TCPsocket sdl2_net: tCP_GetPeerAddress(sock: TCPsocket): ptr IPaddress
|
||||
tCP_Send sdl2/sdl2_net.html#tCP_Send,TCPsocket,pointer,cint sdl2_net: tCP_Send(sock: TCPsocket; data: pointer; len: cint): cint
|
||||
tCP_Recv sdl2/sdl2_net.html#tCP_Recv,TCPsocket,pointer,cint sdl2_net: tCP_Recv(sock: TCPsocket; data: pointer; maxlen: cint): cint
|
||||
tCP_Close sdl2/sdl2_net.html#tCP_Close,TCPsocket sdl2_net: tCP_Close(sock: TCPsocket)
|
||||
allocPacket sdl2/sdl2_net.html#allocPacket,cint sdl2_net: allocPacket(size: cint): ptr UDPpacket
|
||||
resizePacket sdl2/sdl2_net.html#resizePacket,ptr.UDPpacket,cint sdl2_net: resizePacket(packet: ptr UDPpacket; newsize: cint): cint
|
||||
freePacket sdl2/sdl2_net.html#freePacket,ptr.UDPpacket sdl2_net: freePacket(packet: ptr UDPpacket)
|
||||
allocPacketV sdl2/sdl2_net.html#allocPacketV,cint,cint sdl2_net: allocPacketV(howmany: cint; size: cint): ptr ptr UDPpacket
|
||||
freePacketV sdl2/sdl2_net.html#freePacketV,ptr.ptr.UDPpacket sdl2_net: freePacketV(packetV: ptr ptr UDPpacket)
|
||||
uDP_Open sdl2/sdl2_net.html#uDP_Open,Uint16 sdl2_net: uDP_Open(port: Uint16): UDPsocket
|
||||
uDP_SetPacketLoss sdl2/sdl2_net.html#uDP_SetPacketLoss,UDPsocket,cint sdl2_net: uDP_SetPacketLoss(sock: UDPsocket; percent: cint)
|
||||
uDP_Bind sdl2/sdl2_net.html#uDP_Bind,UDPsocket,cint,ptr.IPaddress sdl2_net: uDP_Bind(sock: UDPsocket; channel: cint; address: ptr IPaddress): cint
|
||||
uDP_Unbind sdl2/sdl2_net.html#uDP_Unbind,UDPsocket,cint sdl2_net: uDP_Unbind(sock: UDPsocket; channel: cint)
|
||||
uDP_GetPeerAddress sdl2/sdl2_net.html#uDP_GetPeerAddress,UDPsocket,cint sdl2_net: uDP_GetPeerAddress(sock: UDPsocket; channel: cint): ptr IPaddress
|
||||
uDP_SendV sdl2/sdl2_net.html#uDP_SendV,UDPsocket,ptr.ptr.UDPpacket,cint sdl2_net: uDP_SendV(sock: UDPsocket; packets: ptr ptr UDPpacket; npackets: cint): cint
|
||||
uDP_Send sdl2/sdl2_net.html#uDP_Send,UDPsocket,cint,ptr.UDPpacket sdl2_net: uDP_Send(sock: UDPsocket; channel: cint; packet: ptr UDPpacket): cint
|
||||
uDP_RecvV sdl2/sdl2_net.html#uDP_RecvV,UDPsocket,ptr.ptr.UDPpacket sdl2_net: uDP_RecvV(sock: UDPsocket; packets: ptr ptr UDPpacket): cint
|
||||
uDP_Recv sdl2/sdl2_net.html#uDP_Recv,UDPsocket,ptr.UDPpacket sdl2_net: uDP_Recv(sock: UDPsocket; packet: ptr UDPpacket): cint
|
||||
uDP_Close sdl2/sdl2_net.html#uDP_Close,UDPsocket sdl2_net: uDP_Close(sock: UDPsocket)
|
||||
allocSocketSet sdl2/sdl2_net.html#allocSocketSet,cint sdl2_net: allocSocketSet(maxsockets: cint): SocketSet
|
||||
addSocket sdl2/sdl2_net.html#addSocket,SocketSet,GenericSocket sdl2_net: addSocket(set: SocketSet; sock: GenericSocket): cint
|
||||
delSocket sdl2/sdl2_net.html#delSocket,SocketSet,GenericSocket sdl2_net: delSocket(set: SocketSet; sock: GenericSocket): cint
|
||||
checkSockets sdl2/sdl2_net.html#checkSockets,SocketSet,Uint32 sdl2_net: checkSockets(set: SocketSet; timeout: Uint32): cint
|
||||
freeSocketSet sdl2/sdl2_net.html#freeSocketSet,SocketSet sdl2_net: freeSocketSet(set: SocketSet)
|
||||
setError sdl2/sdl2_net.html#setError,cstring sdl2_net: setError(fmt: cstring)
|
||||
getError sdl2/sdl2_net.html#getError sdl2_net: getError(): cstring
|
||||
INVALID_SOCKET sdl2/sdl2_net.html#INVALID_SOCKET sdl2_net: INVALID_SOCKET
|
||||
SOCKET_ERROR sdl2/sdl2_net.html#SOCKET_ERROR sdl2_net: SOCKET_ERROR
|
||||
getLastError sdl2/sdl2_net.html#getLastError sdl2_net: getLastError(): cint
|
||||
setLastError sdl2/sdl2_net.html#setLastError,cint sdl2_net: setLastError(err: cint)
|
||||
922
docs/sdl2/sdl2_ttf.html
Normal file
922
docs/sdl2/sdl2_ttf.html
Normal file
|
|
@ -0,0 +1,922 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<!-- This file is generated by Nim. -->
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
||||
|
||||
<!-- Google fonts -->
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
||||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<!-- CSS -->
|
||||
<title>sdl2/sdl2_ttf</title>
|
||||
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
|
||||
|
||||
<script type="text/javascript" src="dochack.js"></script>
|
||||
|
||||
<script type="text/javascript">
|
||||
function main() {
|
||||
var pragmaDots = document.getElementsByClassName("pragmadots");
|
||||
for (var i = 0; i < pragmaDots.length; i++) {
|
||||
pragmaDots[i].onclick = function(event) {
|
||||
// Hide tease
|
||||
event.target.parentNode.style.display = "none";
|
||||
// Show actual
|
||||
event.target.parentNode.nextElementSibling.style.display = "inline";
|
||||
}
|
||||
}
|
||||
|
||||
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
||||
function switchTheme(e) {
|
||||
if (e.target.checked) {
|
||||
document.documentElement.setAttribute('data-theme', 'dark');
|
||||
localStorage.setItem('theme', 'dark');
|
||||
} else {
|
||||
document.documentElement.setAttribute('data-theme', 'light');
|
||||
localStorage.setItem('theme', 'light');
|
||||
}
|
||||
}
|
||||
|
||||
toggleSwitch.addEventListener('change', switchTheme, false);
|
||||
|
||||
|
||||
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "dark");
|
||||
toggleSwitch.checked = true;
|
||||
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
|
||||
document.documentElement.setAttribute('data-theme', "light");
|
||||
toggleSwitch.checked = false;
|
||||
} else {
|
||||
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
|
||||
if (currentTheme) {
|
||||
document.documentElement.setAttribute('data-theme', currentTheme);
|
||||
|
||||
if (currentTheme === 'dark') {
|
||||
toggleSwitch.checked = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
</head>
|
||||
<body onload="main()">
|
||||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">sdl2/sdl2_ttf</h1>
|
||||
<div class="row">
|
||||
<div class="three columns">
|
||||
<div class="theme-switch-wrapper">
|
||||
<label class="theme-switch" for="checkbox">
|
||||
<input type="checkbox" id="checkbox" />
|
||||
<div class="slider round"></div>
|
||||
</label>
|
||||
<em>Dark Mode</em>
|
||||
</div>
|
||||
<div id="global-links">
|
||||
<ul class="simple">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchInputDiv">
|
||||
Search: <input type="text" id="searchInput"
|
||||
onkeyup="search()" />
|
||||
</div>
|
||||
<div>
|
||||
Group by:
|
||||
<select onchange="groupBy(this.value)">
|
||||
<option value="section">Section</option>
|
||||
<option value="type">Type</option>
|
||||
</select>
|
||||
</div>
|
||||
<ul class="simple simple-toc" id="toc-list">
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#Font"
|
||||
title="Font {.incompleteStruct.} = object"><wbr />Font<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#SDLttfStd"
|
||||
title="SDLttfStd = false"><wbr />SDLttf<wbr />Std<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfGit"
|
||||
title="SDLttfGit = false"><wbr />SDLttf<wbr />Git<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfDL"
|
||||
title="SDLttfDL = true"><wbr />SDLttf<wbr />DL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfStatic"
|
||||
title="SDLttfStatic = true"><wbr />SDLttf<wbr />Static<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfSetVer"
|
||||
title="SDLttfSetVer = """><wbr />SDLttf<wbr />Set<wbr />Ver<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfLPath"
|
||||
title="SDLttfLPath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_ttf/buildcache/libSDL2_ttf.a""><wbr />SDLttf<wbr />LPath<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SDLttfPath"
|
||||
title="SDLttfPath = "/Users/joey/Projects/nim-sdl2/src/build/sdl2_ttf/SDL_ttf.h""><wbr />SDLttf<wbr />Path<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#SetError"
|
||||
title="SetError = """><wbr />Set<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#GetError"
|
||||
title="GetError = """><wbr />Get<wbr />Error<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#MAJOR_VERSION"
|
||||
title="MAJOR_VERSION = 2"><wbr />MAJOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#MINOR_VERSION"
|
||||
title="MINOR_VERSION = 0"><wbr />MINOR_<wbr />VERSION<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#PATCHLEVEL"
|
||||
title="PATCHLEVEL = 15"><wbr />PATCHLEVEL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#UNICODE_BOM_NATIVE"
|
||||
title="UNICODE_BOM_NATIVE = 0x0000FEFF"><wbr />UNICODE_<wbr />BOM_<wbr />NATIVE<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#UNICODE_BOM_SWAPPED"
|
||||
title="UNICODE_BOM_SWAPPED = 0x0000FFFE"><wbr />UNICODE_<wbr />BOM_<wbr />SWAPPED<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#STYLE_NORMAL"
|
||||
title="STYLE_NORMAL = 0x00000000"><wbr />STYLE_<wbr />NORMAL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#STYLE_BOLD"
|
||||
title="STYLE_BOLD = 0x00000001"><wbr />STYLE_<wbr />BOLD<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#STYLE_ITALIC"
|
||||
title="STYLE_ITALIC = 0x00000002"><wbr />STYLE_<wbr />ITALIC<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#STYLE_UNDERLINE"
|
||||
title="STYLE_UNDERLINE = 0x00000004"><wbr />STYLE_<wbr />UNDERLINE<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#STYLE_STRIKETHROUGH"
|
||||
title="STYLE_STRIKETHROUGH = 0x00000008"><wbr />STYLE_<wbr />STRIKETHROUGH<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#HINTING_NORMAL"
|
||||
title="HINTING_NORMAL = 0"><wbr />HINTING_<wbr />NORMAL<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#HINTING_LIGHT"
|
||||
title="HINTING_LIGHT = 1"><wbr />HINTING_<wbr />LIGHT<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#HINTING_MONO"
|
||||
title="HINTING_MONO = 2"><wbr />HINTING_<wbr />MONO<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#HINTING_NONE"
|
||||
title="HINTING_NONE = 3"><wbr />HINTING_<wbr />NONE<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#linked_Version"
|
||||
title="linked_Version(): ptr Version"><wbr />linked_<wbr />Version<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#byteSwappedUNICODE%2Ccint"
|
||||
title="byteSwappedUNICODE(swapped: cint)"><wbr />byte<wbr />Swapped<wbr />UNICODE<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#init"
|
||||
title="init(): cint"><wbr />init<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#openFont%2Ccstring%2Ccint"
|
||||
title="openFont(file: cstring; ptsize: cint): ptr Font"><wbr />open<wbr />Font<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#openFontIndex%2Ccstring%2Ccint%2Cclong"
|
||||
title="openFontIndex(file: cstring; ptsize: cint; index: clong): ptr Font"><wbr />open<wbr />Font<wbr />Index<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#openFontRW%2Cptr.RWops%2Ccint%2Ccint"
|
||||
title="openFontRW(src: ptr RWops; freesrc: cint; ptsize: cint): ptr Font"><wbr />open<wbr />Font<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#openFontIndexRW%2Cptr.RWops%2Ccint%2Ccint%2Cclong"
|
||||
title="openFontIndexRW(src: ptr RWops; freesrc: cint; ptsize: cint; index: clong): ptr Font"><wbr />open<wbr />Font<wbr />Index<wbr />RW<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontStyle%2Cptr.Font"
|
||||
title="getFontStyle(font: ptr Font): cint"><wbr />get<wbr />Font<wbr />Style<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setFontStyle%2Cptr.Font%2Ccint"
|
||||
title="setFontStyle(font: ptr Font; style: cint)"><wbr />set<wbr />Font<wbr />Style<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontOutline%2Cptr.Font"
|
||||
title="getFontOutline(font: ptr Font): cint"><wbr />get<wbr />Font<wbr />Outline<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setFontOutline%2Cptr.Font%2Ccint"
|
||||
title="setFontOutline(font: ptr Font; outline: cint)"><wbr />set<wbr />Font<wbr />Outline<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontHinting%2Cptr.Font"
|
||||
title="getFontHinting(font: ptr Font): cint"><wbr />get<wbr />Font<wbr />Hinting<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setFontHinting%2Cptr.Font%2Ccint"
|
||||
title="setFontHinting(font: ptr Font; hinting: cint)"><wbr />set<wbr />Font<wbr />Hinting<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontHeight%2Cptr.Font"
|
||||
title="fontHeight(font: ptr Font): cint"><wbr />font<wbr />Height<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontAscent%2Cptr.Font"
|
||||
title="fontAscent(font: ptr Font): cint"><wbr />font<wbr />Ascent<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontDescent%2Cptr.Font"
|
||||
title="fontDescent(font: ptr Font): cint"><wbr />font<wbr />Descent<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontLineSkip%2Cptr.Font"
|
||||
title="fontLineSkip(font: ptr Font): cint"><wbr />font<wbr />Line<wbr />Skip<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontKerning%2Cptr.Font"
|
||||
title="getFontKerning(font: ptr Font): cint"><wbr />get<wbr />Font<wbr />Kerning<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#setFontKerning%2Cptr.Font%2Ccint"
|
||||
title="setFontKerning(font: ptr Font; allowed: cint)"><wbr />set<wbr />Font<wbr />Kerning<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontFaces%2Cptr.Font"
|
||||
title="fontFaces(font: ptr Font): clong"><wbr />font<wbr />Faces<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontFaceIsFixedWidth%2Cptr.Font"
|
||||
title="fontFaceIsFixedWidth(font: ptr Font): cint"><wbr />font<wbr />Face<wbr />Is<wbr />Fixed<wbr />Width<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontFaceFamilyName%2Cptr.Font"
|
||||
title="fontFaceFamilyName(font: ptr Font): cstring"><wbr />font<wbr />Face<wbr />Family<wbr />Name<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#fontFaceStyleName%2Cptr.Font"
|
||||
title="fontFaceStyleName(font: ptr Font): cstring"><wbr />font<wbr />Face<wbr />Style<wbr />Name<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#glyphIsProvided%2Cptr.Font%2CUint16"
|
||||
title="glyphIsProvided(font: ptr Font; ch: Uint16): cint"><wbr />glyph<wbr />Is<wbr />Provided<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#glyphMetrics%2Cptr.Font%2CUint16%2Cptr.cint%2Cptr.cint%2Cptr.cint%2Cptr.cint%2Cptr.cint"
|
||||
title="glyphMetrics(font: ptr Font; ch: Uint16; minx: ptr cint; maxx: ptr cint; miny: ptr cint;
|
||||
maxy: ptr cint; advance: ptr cint): cint"><wbr />glyph<wbr />Metrics<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#sizeText%2Cptr.Font%2Ccstring%2Cptr.cint%2Cptr.cint"
|
||||
title="sizeText(font: ptr Font; text: cstring; w: ptr cint; h: ptr cint): cint"><wbr />size<wbr />Text<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#sizeUTF8%2Cptr.Font%2Ccstring%2Cptr.cint%2Cptr.cint"
|
||||
title="sizeUTF8(font: ptr Font; text: cstring; w: ptr cint; h: ptr cint): cint"><wbr />size<wbr />UTF8<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#sizeUNICODE%2Cptr.Font%2Cptr.Uint16%2Cptr.cint%2Cptr.cint"
|
||||
title="sizeUNICODE(font: ptr Font; text: ptr Uint16; w: ptr cint; h: ptr cint): cint"><wbr />size<wbr />UNICODE<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderText_Solid%2Cptr.Font%2Ccstring%2CColor"
|
||||
title="renderText_Solid(font: ptr Font; text: cstring; fg: Color): ptr Surface"><wbr />render<wbr />Text_<wbr />Solid<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUTF8_Solid%2Cptr.Font%2Ccstring%2CColor"
|
||||
title="renderUTF8_Solid(font: ptr Font; text: cstring; fg: Color): ptr Surface"><wbr />render<wbr />UTF8_<wbr />Solid<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUNICODE_Solid%2Cptr.Font%2Cptr.Uint16%2CColor"
|
||||
title="renderUNICODE_Solid(font: ptr Font; text: ptr Uint16; fg: Color): ptr Surface"><wbr />render<wbr />UNICODE_<wbr />Solid<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderGlyph_Solid%2Cptr.Font%2CUint16%2CColor"
|
||||
title="renderGlyph_Solid(font: ptr Font; ch: Uint16; fg: Color): ptr Surface"><wbr />render<wbr />Glyph_<wbr />Solid<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderText_Shaded%2Cptr.Font%2Ccstring%2CColor%2CColor"
|
||||
title="renderText_Shaded(font: ptr Font; text: cstring; fg: Color; bg: Color): ptr Surface"><wbr />render<wbr />Text_<wbr />Shaded<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUTF8_Shaded%2Cptr.Font%2Ccstring%2CColor%2CColor"
|
||||
title="renderUTF8_Shaded(font: ptr Font; text: cstring; fg: Color; bg: Color): ptr Surface"><wbr />render<wbr />UTF8_<wbr />Shaded<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUNICODE_Shaded%2Cptr.Font%2Cptr.Uint16%2CColor%2CColor"
|
||||
title="renderUNICODE_Shaded(font: ptr Font; text: ptr Uint16; fg: Color; bg: Color): ptr Surface"><wbr />render<wbr />UNICODE_<wbr />Shaded<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderGlyph_Shaded%2Cptr.Font%2CUint16%2CColor%2CColor"
|
||||
title="renderGlyph_Shaded(font: ptr Font; ch: Uint16; fg: Color; bg: Color): ptr Surface"><wbr />render<wbr />Glyph_<wbr />Shaded<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderText_Blended%2Cptr.Font%2Ccstring%2CColor"
|
||||
title="renderText_Blended(font: ptr Font; text: cstring; fg: Color): ptr Surface"><wbr />render<wbr />Text_<wbr />Blended<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUTF8_Blended%2Cptr.Font%2Ccstring%2CColor"
|
||||
title="renderUTF8_Blended(font: ptr Font; text: cstring; fg: Color): ptr Surface"><wbr />render<wbr />UTF8_<wbr />Blended<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUNICODE_Blended%2Cptr.Font%2Cptr.Uint16%2CColor"
|
||||
title="renderUNICODE_Blended(font: ptr Font; text: ptr Uint16; fg: Color): ptr Surface"><wbr />render<wbr />UNICODE_<wbr />Blended<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderText_Blended_Wrapped%2Cptr.Font%2Ccstring%2CColor%2CUint32"
|
||||
title="renderText_Blended_Wrapped(font: ptr Font; text: cstring; fg: Color; wrapLength: Uint32): ptr Surface"><wbr />render<wbr />Text_<wbr />Blended_<wbr />Wrapped<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUTF8_Blended_Wrapped%2Cptr.Font%2Ccstring%2CColor%2CUint32"
|
||||
title="renderUTF8_Blended_Wrapped(font: ptr Font; text: cstring; fg: Color; wrapLength: Uint32): ptr Surface"><wbr />render<wbr />UTF8_<wbr />Blended_<wbr />Wrapped<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderUNICODE_Blended_Wrapped%2Cptr.Font%2Cptr.Uint16%2CColor%2CUint32"
|
||||
title="renderUNICODE_Blended_Wrapped(font: ptr Font; text: ptr Uint16; fg: Color;
|
||||
wrapLength: Uint32): ptr Surface"><wbr />render<wbr />UNICODE_<wbr />Blended_<wbr />Wrapped<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#renderGlyph_Blended%2Cptr.Font%2CUint16%2CColor"
|
||||
title="renderGlyph_Blended(font: ptr Font; ch: Uint16; fg: Color): ptr Surface"><wbr />render<wbr />Glyph_<wbr />Blended<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#closeFont%2Cptr.Font"
|
||||
title="closeFont(font: ptr Font)"><wbr />close<wbr />Font<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#quit"
|
||||
title="quit()"><wbr />quit<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#wasInit"
|
||||
title="wasInit(): cint"><wbr />was<wbr />Init<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontKerningSize%2Cptr.Font%2Ccint%2Ccint"
|
||||
title="getFontKerningSize(font: ptr Font; prevIndex: cint; index: cint): cint"><wbr />get<wbr />Font<wbr />Kerning<wbr />Size<span class="attachedType"></span></a></li>
|
||||
<li><a class="reference" href="#getFontKerningSizeGlyphs%2Cptr.Font%2CUint16%2CUint16"
|
||||
title="getFontKerningSizeGlyphs(font: ptr Font; previousCh: Uint16; ch: Uint16): cint"><wbr />get<wbr />Font<wbr />Kerning<wbr />Size<wbr />Glyphs<span class="attachedType"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
<div class="nine columns" id="content">
|
||||
<div id="tocRoot"></div>
|
||||
|
||||
<p class="module-desc"></p>
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="sdl2.html">sdl2</a>
|
||||
</dl></div>
|
||||
<div class="section" id="7">
|
||||
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
||||
<dl class="item">
|
||||
<a id="Font"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">incompleteStruct</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="10">
|
||||
<h1><a class="toc-backref" href="#10">Consts</a></h1>
|
||||
<dl class="item">
|
||||
<a id="SDLttfStd"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfStd"><span class="Identifier">SDLttfStd</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfGit"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfGit"><span class="Identifier">SDLttfGit</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfDL"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfDL"><span class="Identifier">SDLttfDL</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfStatic"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfStatic"><span class="Identifier">SDLttfStatic</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfSetVer"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfSetVer"><span class="Identifier">SDLttfSetVer</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfLPath"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfLPath"><span class="Identifier">SDLttfLPath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_ttf/buildcache/libSDL2_ttf.a"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SDLttfPath"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SDLttfPath"><span class="Identifier">SDLttfPath</span></a> <span class="Other">=</span> <span class="StringLit">"/Users/joey/Projects/nim-sdl2/src/build/sdl2_ttf/SDL_ttf.h"</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="SetError"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#SetError"><span class="Identifier">SetError</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="GetError"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#GetError"><span class="Identifier">GetError</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="MAJOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#MAJOR_VERSION"><span class="Identifier">MAJOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="MINOR_VERSION"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#MINOR_VERSION"><span class="Identifier">MINOR_VERSION</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="PATCHLEVEL"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#PATCHLEVEL"><span class="Identifier">PATCHLEVEL</span></a> <span class="Other">=</span> <span class="DecNumber">15</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="UNICODE_BOM_NATIVE"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#UNICODE_BOM_NATIVE"><span class="Identifier">UNICODE_BOM_NATIVE</span></a> <span class="Other">=</span> <span class="DecNumber">0x0000FEFF</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="UNICODE_BOM_SWAPPED"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#UNICODE_BOM_SWAPPED"><span class="Identifier">UNICODE_BOM_SWAPPED</span></a> <span class="Other">=</span> <span class="DecNumber">0x0000FFFE</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="STYLE_NORMAL"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#STYLE_NORMAL"><span class="Identifier">STYLE_NORMAL</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000000</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="STYLE_BOLD"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#STYLE_BOLD"><span class="Identifier">STYLE_BOLD</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000001</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="STYLE_ITALIC"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#STYLE_ITALIC"><span class="Identifier">STYLE_ITALIC</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000002</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="STYLE_UNDERLINE"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#STYLE_UNDERLINE"><span class="Identifier">STYLE_UNDERLINE</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000004</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="STYLE_STRIKETHROUGH"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#STYLE_STRIKETHROUGH"><span class="Identifier">STYLE_STRIKETHROUGH</span></a> <span class="Other">=</span> <span class="DecNumber">0x00000008</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="HINTING_NORMAL"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#HINTING_NORMAL"><span class="Identifier">HINTING_NORMAL</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="HINTING_LIGHT"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#HINTING_LIGHT"><span class="Identifier">HINTING_LIGHT</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="HINTING_MONO"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#HINTING_MONO"><span class="Identifier">HINTING_MONO</span></a> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="HINTING_NONE"></a>
|
||||
<dt><pre><a href="sdl2_ttf.html#HINTING_NONE"><span class="Identifier">HINTING_NONE</span></a> <span class="Other">=</span> <span class="DecNumber">3</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<a id="linked_Version"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#linked_Version"><span class="Identifier">linked_Version</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Version"><span class="Identifier">Version</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_Linked_Version"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Make sure this is defined (only available in newer SDL versions)
|
||||
This function gets the version of the dynamically linked SDL_ttf library.
|
||||
it should NOT be used to fill a version structure, instead you should
|
||||
use the SDL_TTF_VERSION() macro.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="byteSwappedUNICODE,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#byteSwappedUNICODE%2Ccint"><span class="Identifier">byteSwappedUNICODE</span></a><span class="Other">(</span><span class="Identifier">swapped</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_ByteSwappedUNICODE"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="init"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#init"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_Init"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Initialize the TTF engine - returns 0 if successful, -1 on error</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="openFont,cstring,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#openFont%2Ccstring%2Ccint"><span class="Identifier">openFont</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">ptsize</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_OpenFont"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="openFontIndex,cstring,cint,clong"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#openFontIndex%2Ccstring%2Ccint%2Cclong"><span class="Identifier">openFontIndex</span></a><span class="Other">(</span><span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">ptsize</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">clong</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_OpenFontIndex"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="openFontRW,ptr.RWops,cint,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#openFontRW%2Cptr.RWops%2Ccint%2Ccint"><span class="Identifier">openFontRW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">ptsize</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_OpenFontRW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="openFontIndexRW,ptr.RWops,cint,cint,clong"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#openFontIndexRW%2Cptr.RWops%2Ccint%2Ccint%2Cclong"><span class="Identifier">openFontIndexRW</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#RWops"><span class="Identifier">RWops</span></a><span class="Other">;</span> <span class="Identifier">freesrc</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">ptsize</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">clong</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_OpenFontIndexRW"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontStyle,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontStyle%2Cptr.Font"><span class="Identifier">getFontStyle</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontStyle"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setFontStyle,ptr.Font,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setFontStyle%2Cptr.Font%2Ccint"><span class="Identifier">setFontStyle</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">style</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SetFontStyle"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontOutline,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontOutline%2Cptr.Font"><span class="Identifier">getFontOutline</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontOutline"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setFontOutline,ptr.Font,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setFontOutline%2Cptr.Font%2Ccint"><span class="Identifier">setFontOutline</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">outline</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SetFontOutline"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontHinting,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontHinting%2Cptr.Font"><span class="Identifier">getFontHinting</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontHinting"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setFontHinting,ptr.Font,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setFontHinting%2Cptr.Font%2Ccint"><span class="Identifier">setFontHinting</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">hinting</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SetFontHinting"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontHeight,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontHeight%2Cptr.Font"><span class="Identifier">fontHeight</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontHeight"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the total height of the font - usually equal to point size</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontAscent,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontAscent%2Cptr.Font"><span class="Identifier">fontAscent</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontAscent"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the offset from the baseline to the top of the font
|
||||
This is a positive value, relative to the baseline.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontDescent,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontDescent%2Cptr.Font"><span class="Identifier">fontDescent</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontDescent"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the offset from the baseline to the bottom of the font
|
||||
This is a negative value, relative to the baseline.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontLineSkip,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontLineSkip%2Cptr.Font"><span class="Identifier">fontLineSkip</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontLineSkip"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the recommended spacing between lines of text for this font</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontKerning,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontKerning%2Cptr.Font"><span class="Identifier">getFontKerning</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontKerning"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get/Set whether or not kerning is allowed for this font</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="setFontKerning,ptr.Font,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#setFontKerning%2Cptr.Font%2Ccint"><span class="Identifier">setFontKerning</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">allowed</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SetFontKerning"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontFaces,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontFaces%2Cptr.Font"><span class="Identifier">fontFaces</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">clong</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontFaces"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the number of faces of the font</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontFaceIsFixedWidth,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontFaceIsFixedWidth%2Cptr.Font"><span class="Identifier">fontFaceIsFixedWidth</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontFaceIsFixedWidth"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the font face attributes, if any</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontFaceFamilyName,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontFaceFamilyName%2Cptr.Font"><span class="Identifier">fontFaceFamilyName</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontFaceFamilyName"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="fontFaceStyleName,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#fontFaceStyleName%2Cptr.Font"><span class="Identifier">fontFaceStyleName</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cstring</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_FontFaceStyleName"</span><span class="Other">,</span>
|
||||
<span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="glyphIsProvided,ptr.Font,Uint16"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#glyphIsProvided%2Cptr.Font%2CUint16"><span class="Identifier">glyphIsProvided</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GlyphIsProvided"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Check wether a glyph is provided by the font or not</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="glyphMetrics,ptr.Font,Uint16,ptr.cint,ptr.cint,ptr.cint,ptr.cint,ptr.cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#glyphMetrics%2Cptr.Font%2CUint16%2Cptr.cint%2Cptr.cint%2Cptr.cint%2Cptr.cint%2Cptr.cint"><span class="Identifier">glyphMetrics</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">minx</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">maxx</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span>
|
||||
<span class="Identifier">miny</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">maxy</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">advance</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GlyphMetrics"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the metrics (dimensions) of a glyph
|
||||
To understand what these metrics mean, here is a useful link:
|
||||
http:freetype.sourceforge.net/freetype2/docs/tutorial/step2.html</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="sizeText,ptr.Font,cstring,ptr.cint,ptr.cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sizeText%2Cptr.Font%2Ccstring%2Cptr.cint%2Cptr.cint"><span class="Identifier">sizeText</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">h</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SizeText"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the dimensions of a rendered string of text</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="sizeUTF8,ptr.Font,cstring,ptr.cint,ptr.cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sizeUTF8%2Cptr.Font%2Ccstring%2Cptr.cint%2Cptr.cint"><span class="Identifier">sizeUTF8</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">h</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SizeUTF8"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="sizeUNICODE,ptr.Font,ptr.Uint16,ptr.cint,ptr.cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#sizeUNICODE%2Cptr.Font%2Cptr.Uint16%2Cptr.cint%2Cptr.cint"><span class="Identifier">sizeUNICODE</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">h</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_SizeUNICODE"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderText_Solid,ptr.Font,cstring,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderText_Solid%2Cptr.Font%2Ccstring%2CColor"><span class="Identifier">renderText_Solid</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderText_Solid"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Create an 8-bit palettized surface and render the given text 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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUTF8_Solid,ptr.Font,cstring,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUTF8_Solid%2Cptr.Font%2Ccstring%2CColor"><span class="Identifier">renderUTF8_Solid</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUTF8_Solid"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUNICODE_Solid,ptr.Font,ptr.Uint16,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUNICODE_Solid%2Cptr.Font%2Cptr.Uint16%2CColor"><span class="Identifier">renderUNICODE_Solid</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUNICODE_Solid"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderGlyph_Solid,ptr.Font,Uint16,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderGlyph_Solid%2Cptr.Font%2CUint16%2CColor"><span class="Identifier">renderGlyph_Solid</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderGlyph_Solid"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderText_Shaded,ptr.Font,cstring,Color,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderText_Shaded%2Cptr.Font%2Ccstring%2CColor%2CColor"><span class="Identifier">renderText_Shaded</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span> <span class="Identifier">bg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderText_Shaded"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUTF8_Shaded,ptr.Font,cstring,Color,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUTF8_Shaded%2Cptr.Font%2Ccstring%2CColor%2CColor"><span class="Identifier">renderUTF8_Shaded</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span> <span class="Identifier">bg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUTF8_Shaded"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUNICODE_Shaded,ptr.Font,ptr.Uint16,Color,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUNICODE_Shaded%2Cptr.Font%2Cptr.Uint16%2CColor%2CColor"><span class="Identifier">renderUNICODE_Shaded</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span> <span class="Identifier">bg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUNICODE_Shaded"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderGlyph_Shaded,ptr.Font,Uint16,Color,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderGlyph_Shaded%2Cptr.Font%2CUint16%2CColor%2CColor"><span class="Identifier">renderGlyph_Shaded</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span> <span class="Identifier">bg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderGlyph_Shaded"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderText_Blended,ptr.Font,cstring,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderText_Blended%2Cptr.Font%2Ccstring%2CColor"><span class="Identifier">renderText_Blended</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderText_Blended"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUTF8_Blended,ptr.Font,cstring,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUTF8_Blended%2Cptr.Font%2Ccstring%2CColor"><span class="Identifier">renderUTF8_Blended</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUTF8_Blended"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUNICODE_Blended,ptr.Font,ptr.Uint16,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUNICODE_Blended%2Cptr.Font%2Cptr.Uint16%2CColor"><span class="Identifier">renderUNICODE_Blended</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUNICODE_Blended"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderText_Blended_Wrapped,ptr.Font,cstring,Color,Uint32"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderText_Blended_Wrapped%2Cptr.Font%2Ccstring%2CColor%2CUint32"><span class="Identifier">renderText_Blended_Wrapped</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">wrapLength</span><span class="Other">:</span> <a href="sdl2.html#Uint32"><span class="Identifier">Uint32</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderText_Blended_Wrapped"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
Text is wrapped to multiple lines on line endings and on word boundaries
|
||||
if it extends beyond wrapLength in pixels.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUTF8_Blended_Wrapped,ptr.Font,cstring,Color,Uint32"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUTF8_Blended_Wrapped%2Cptr.Font%2Ccstring%2CColor%2CUint32"><span class="Identifier">renderUTF8_Blended_Wrapped</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">wrapLength</span><span class="Other">:</span> <a href="sdl2.html#Uint32"><span class="Identifier">Uint32</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUTF8_Blended_Wrapped"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderUNICODE_Blended_Wrapped,ptr.Font,ptr.Uint16,Color,Uint32"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderUNICODE_Blended_Wrapped%2Cptr.Font%2Cptr.Uint16%2CColor%2CUint32"><span class="Identifier">renderUNICODE_Blended_Wrapped</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">;</span>
|
||||
<span class="Identifier">wrapLength</span><span class="Other">:</span> <a href="sdl2.html#Uint32"><span class="Identifier">Uint32</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderUNICODE_Blended_Wrapped"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="renderGlyph_Blended,ptr.Font,Uint16,Color"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#renderGlyph_Blended%2Cptr.Font%2CUint16%2CColor"><span class="Identifier">renderGlyph_Blended</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">fg</span><span class="Other">:</span> <a href="sdl2.html#Color"><span class="Identifier">Color</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2.html#Surface"><span class="Identifier">Surface</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_RenderGlyph_Blended"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>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.
|
||||
This function returns the new surface, or NULL if there was an error.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="closeFont,ptr.Font"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#closeFont%2Cptr.Font"><span class="Identifier">closeFont</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_CloseFont"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Close an opened font file</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="quit"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#quit"><span class="Identifier">quit</span></a><span class="Other">(</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_Quit"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>De-initialize the TTF engine</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="wasInit"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#wasInit"><span class="Identifier">wasInit</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_WasInit"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Check if the TTF engine is initialized</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontKerningSize,ptr.Font,cint,cint"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontKerningSize%2Cptr.Font%2Ccint%2Ccint"><span class="Identifier">getFontKerningSize</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">prevIndex</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">;</span> <span class="Identifier">index</span><span class="Other">:</span> <span class="Identifier">cint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontKerningSize"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the kerning size of two glyphs indices
|
||||
DEPRECATED: this function requires FreeType font indexes, not glyphs,
|
||||
by accident, which we don't expose through this API, so it could give
|
||||
wildly incorrect results, especially with non-ASCII values.
|
||||
Going forward, please use TTF_GetFontKerningSizeGlyphs() instead, which
|
||||
does what you probably expected this function to do.</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
<a id="getFontKerningSizeGlyphs,ptr.Font,Uint16,Uint16"></a>
|
||||
<dt><pre><span class="Keyword">proc</span> <a href="#getFontKerningSizeGlyphs%2Cptr.Font%2CUint16%2CUint16"><span class="Identifier">getFontKerningSizeGlyphs</span></a><span class="Other">(</span><span class="Identifier">font</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="sdl2_ttf.html#Font"><span class="Identifier">Font</span></a><span class="Other">;</span> <span class="Identifier">previousCh</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">;</span> <span class="Identifier">ch</span><span class="Other">:</span> <a href="sdl2.html#Uint16"><span class="Identifier">Uint16</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
|
||||
<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"TTF_GetFontKerningSizeGlyphs"</span><span class="Other">,</span> <span class="Identifier">cdecl</span></span><span class="Other">.}</span></span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<pre>Get the kerning size of two glyphs</pre>
|
||||
|
||||
|
||||
</dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small style="color: var(--hint);">Made with Nim. Generated: 2020-04-26 21:10:29 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
72
docs/sdl2/sdl2_ttf.idx
Normal file
72
docs/sdl2/sdl2_ttf.idx
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
SDLttfStd sdl2/sdl2_ttf.html#SDLttfStd sdl2_ttf: SDLttfStd
|
||||
SDLttfGit sdl2/sdl2_ttf.html#SDLttfGit sdl2_ttf: SDLttfGit
|
||||
SDLttfDL sdl2/sdl2_ttf.html#SDLttfDL sdl2_ttf: SDLttfDL
|
||||
SDLttfStatic sdl2/sdl2_ttf.html#SDLttfStatic sdl2_ttf: SDLttfStatic
|
||||
SDLttfSetVer sdl2/sdl2_ttf.html#SDLttfSetVer sdl2_ttf: SDLttfSetVer
|
||||
SDLttfLPath sdl2/sdl2_ttf.html#SDLttfLPath sdl2_ttf: SDLttfLPath
|
||||
SDLttfPath sdl2/sdl2_ttf.html#SDLttfPath sdl2_ttf: SDLttfPath
|
||||
SetError sdl2/sdl2_ttf.html#SetError sdl2_ttf: SetError
|
||||
GetError sdl2/sdl2_ttf.html#GetError sdl2_ttf: GetError
|
||||
MAJOR_VERSION sdl2/sdl2_ttf.html#MAJOR_VERSION sdl2_ttf: MAJOR_VERSION
|
||||
MINOR_VERSION sdl2/sdl2_ttf.html#MINOR_VERSION sdl2_ttf: MINOR_VERSION
|
||||
PATCHLEVEL sdl2/sdl2_ttf.html#PATCHLEVEL sdl2_ttf: PATCHLEVEL
|
||||
UNICODE_BOM_NATIVE sdl2/sdl2_ttf.html#UNICODE_BOM_NATIVE sdl2_ttf: UNICODE_BOM_NATIVE
|
||||
UNICODE_BOM_SWAPPED sdl2/sdl2_ttf.html#UNICODE_BOM_SWAPPED sdl2_ttf: UNICODE_BOM_SWAPPED
|
||||
STYLE_NORMAL sdl2/sdl2_ttf.html#STYLE_NORMAL sdl2_ttf: STYLE_NORMAL
|
||||
STYLE_BOLD sdl2/sdl2_ttf.html#STYLE_BOLD sdl2_ttf: STYLE_BOLD
|
||||
STYLE_ITALIC sdl2/sdl2_ttf.html#STYLE_ITALIC sdl2_ttf: STYLE_ITALIC
|
||||
STYLE_UNDERLINE sdl2/sdl2_ttf.html#STYLE_UNDERLINE sdl2_ttf: STYLE_UNDERLINE
|
||||
STYLE_STRIKETHROUGH sdl2/sdl2_ttf.html#STYLE_STRIKETHROUGH sdl2_ttf: STYLE_STRIKETHROUGH
|
||||
HINTING_NORMAL sdl2/sdl2_ttf.html#HINTING_NORMAL sdl2_ttf: HINTING_NORMAL
|
||||
HINTING_LIGHT sdl2/sdl2_ttf.html#HINTING_LIGHT sdl2_ttf: HINTING_LIGHT
|
||||
HINTING_MONO sdl2/sdl2_ttf.html#HINTING_MONO sdl2_ttf: HINTING_MONO
|
||||
HINTING_NONE sdl2/sdl2_ttf.html#HINTING_NONE sdl2_ttf: HINTING_NONE
|
||||
Font sdl2/sdl2_ttf.html#Font sdl2_ttf: Font
|
||||
linked_Version sdl2/sdl2_ttf.html#linked_Version sdl2_ttf: linked_Version(): ptr Version
|
||||
byteSwappedUNICODE sdl2/sdl2_ttf.html#byteSwappedUNICODE,cint sdl2_ttf: byteSwappedUNICODE(swapped: cint)
|
||||
init sdl2/sdl2_ttf.html#init sdl2_ttf: init(): cint
|
||||
openFont sdl2/sdl2_ttf.html#openFont,cstring,cint sdl2_ttf: openFont(file: cstring; ptsize: cint): ptr Font
|
||||
openFontIndex sdl2/sdl2_ttf.html#openFontIndex,cstring,cint,clong sdl2_ttf: openFontIndex(file: cstring; ptsize: cint; index: clong): ptr Font
|
||||
openFontRW sdl2/sdl2_ttf.html#openFontRW,ptr.RWops,cint,cint sdl2_ttf: openFontRW(src: ptr RWops; freesrc: cint; ptsize: cint): ptr Font
|
||||
openFontIndexRW sdl2/sdl2_ttf.html#openFontIndexRW,ptr.RWops,cint,cint,clong sdl2_ttf: openFontIndexRW(src: ptr RWops; freesrc: cint; ptsize: cint; index: clong): ptr Font
|
||||
getFontStyle sdl2/sdl2_ttf.html#getFontStyle,ptr.Font sdl2_ttf: getFontStyle(font: ptr Font): cint
|
||||
setFontStyle sdl2/sdl2_ttf.html#setFontStyle,ptr.Font,cint sdl2_ttf: setFontStyle(font: ptr Font; style: cint)
|
||||
getFontOutline sdl2/sdl2_ttf.html#getFontOutline,ptr.Font sdl2_ttf: getFontOutline(font: ptr Font): cint
|
||||
setFontOutline sdl2/sdl2_ttf.html#setFontOutline,ptr.Font,cint sdl2_ttf: setFontOutline(font: ptr Font; outline: cint)
|
||||
getFontHinting sdl2/sdl2_ttf.html#getFontHinting,ptr.Font sdl2_ttf: getFontHinting(font: ptr Font): cint
|
||||
setFontHinting sdl2/sdl2_ttf.html#setFontHinting,ptr.Font,cint sdl2_ttf: setFontHinting(font: ptr Font; hinting: cint)
|
||||
fontHeight sdl2/sdl2_ttf.html#fontHeight,ptr.Font sdl2_ttf: fontHeight(font: ptr Font): cint
|
||||
fontAscent sdl2/sdl2_ttf.html#fontAscent,ptr.Font sdl2_ttf: fontAscent(font: ptr Font): cint
|
||||
fontDescent sdl2/sdl2_ttf.html#fontDescent,ptr.Font sdl2_ttf: fontDescent(font: ptr Font): cint
|
||||
fontLineSkip sdl2/sdl2_ttf.html#fontLineSkip,ptr.Font sdl2_ttf: fontLineSkip(font: ptr Font): cint
|
||||
getFontKerning sdl2/sdl2_ttf.html#getFontKerning,ptr.Font sdl2_ttf: getFontKerning(font: ptr Font): cint
|
||||
setFontKerning sdl2/sdl2_ttf.html#setFontKerning,ptr.Font,cint sdl2_ttf: setFontKerning(font: ptr Font; allowed: cint)
|
||||
fontFaces sdl2/sdl2_ttf.html#fontFaces,ptr.Font sdl2_ttf: fontFaces(font: ptr Font): clong
|
||||
fontFaceIsFixedWidth sdl2/sdl2_ttf.html#fontFaceIsFixedWidth,ptr.Font sdl2_ttf: fontFaceIsFixedWidth(font: ptr Font): cint
|
||||
fontFaceFamilyName sdl2/sdl2_ttf.html#fontFaceFamilyName,ptr.Font sdl2_ttf: fontFaceFamilyName(font: ptr Font): cstring
|
||||
fontFaceStyleName sdl2/sdl2_ttf.html#fontFaceStyleName,ptr.Font sdl2_ttf: fontFaceStyleName(font: ptr Font): cstring
|
||||
glyphIsProvided sdl2/sdl2_ttf.html#glyphIsProvided,ptr.Font,Uint16 sdl2_ttf: glyphIsProvided(font: ptr Font; ch: Uint16): cint
|
||||
glyphMetrics sdl2/sdl2_ttf.html#glyphMetrics,ptr.Font,Uint16,ptr.cint,ptr.cint,ptr.cint,ptr.cint,ptr.cint sdl2_ttf: glyphMetrics(font: ptr Font; ch: Uint16; minx: ptr cint; maxx: ptr cint; miny: ptr cint;\n maxy: ptr cint; advance: ptr cint): cint
|
||||
sizeText sdl2/sdl2_ttf.html#sizeText,ptr.Font,cstring,ptr.cint,ptr.cint sdl2_ttf: sizeText(font: ptr Font; text: cstring; w: ptr cint; h: ptr cint): cint
|
||||
sizeUTF8 sdl2/sdl2_ttf.html#sizeUTF8,ptr.Font,cstring,ptr.cint,ptr.cint sdl2_ttf: sizeUTF8(font: ptr Font; text: cstring; w: ptr cint; h: ptr cint): cint
|
||||
sizeUNICODE sdl2/sdl2_ttf.html#sizeUNICODE,ptr.Font,ptr.Uint16,ptr.cint,ptr.cint sdl2_ttf: sizeUNICODE(font: ptr Font; text: ptr Uint16; w: ptr cint; h: ptr cint): cint
|
||||
renderText_Solid sdl2/sdl2_ttf.html#renderText_Solid,ptr.Font,cstring,Color sdl2_ttf: renderText_Solid(font: ptr Font; text: cstring; fg: Color): ptr Surface
|
||||
renderUTF8_Solid sdl2/sdl2_ttf.html#renderUTF8_Solid,ptr.Font,cstring,Color sdl2_ttf: renderUTF8_Solid(font: ptr Font; text: cstring; fg: Color): ptr Surface
|
||||
renderUNICODE_Solid sdl2/sdl2_ttf.html#renderUNICODE_Solid,ptr.Font,ptr.Uint16,Color sdl2_ttf: renderUNICODE_Solid(font: ptr Font; text: ptr Uint16; fg: Color): ptr Surface
|
||||
renderGlyph_Solid sdl2/sdl2_ttf.html#renderGlyph_Solid,ptr.Font,Uint16,Color sdl2_ttf: renderGlyph_Solid(font: ptr Font; ch: Uint16; fg: Color): ptr Surface
|
||||
renderText_Shaded sdl2/sdl2_ttf.html#renderText_Shaded,ptr.Font,cstring,Color,Color sdl2_ttf: renderText_Shaded(font: ptr Font; text: cstring; fg: Color; bg: Color): ptr Surface
|
||||
renderUTF8_Shaded sdl2/sdl2_ttf.html#renderUTF8_Shaded,ptr.Font,cstring,Color,Color sdl2_ttf: renderUTF8_Shaded(font: ptr Font; text: cstring; fg: Color; bg: Color): ptr Surface
|
||||
renderUNICODE_Shaded sdl2/sdl2_ttf.html#renderUNICODE_Shaded,ptr.Font,ptr.Uint16,Color,Color sdl2_ttf: renderUNICODE_Shaded(font: ptr Font; text: ptr Uint16; fg: Color; bg: Color): ptr Surface
|
||||
renderGlyph_Shaded sdl2/sdl2_ttf.html#renderGlyph_Shaded,ptr.Font,Uint16,Color,Color sdl2_ttf: renderGlyph_Shaded(font: ptr Font; ch: Uint16; fg: Color; bg: Color): ptr Surface
|
||||
renderText_Blended sdl2/sdl2_ttf.html#renderText_Blended,ptr.Font,cstring,Color sdl2_ttf: renderText_Blended(font: ptr Font; text: cstring; fg: Color): ptr Surface
|
||||
renderUTF8_Blended sdl2/sdl2_ttf.html#renderUTF8_Blended,ptr.Font,cstring,Color sdl2_ttf: renderUTF8_Blended(font: ptr Font; text: cstring; fg: Color): ptr Surface
|
||||
renderUNICODE_Blended sdl2/sdl2_ttf.html#renderUNICODE_Blended,ptr.Font,ptr.Uint16,Color sdl2_ttf: renderUNICODE_Blended(font: ptr Font; text: ptr Uint16; fg: Color): ptr Surface
|
||||
renderText_Blended_Wrapped sdl2/sdl2_ttf.html#renderText_Blended_Wrapped,ptr.Font,cstring,Color,Uint32 sdl2_ttf: renderText_Blended_Wrapped(font: ptr Font; text: cstring; fg: Color; wrapLength: Uint32): ptr Surface
|
||||
renderUTF8_Blended_Wrapped sdl2/sdl2_ttf.html#renderUTF8_Blended_Wrapped,ptr.Font,cstring,Color,Uint32 sdl2_ttf: renderUTF8_Blended_Wrapped(font: ptr Font; text: cstring; fg: Color; wrapLength: Uint32): ptr Surface
|
||||
renderUNICODE_Blended_Wrapped sdl2/sdl2_ttf.html#renderUNICODE_Blended_Wrapped,ptr.Font,ptr.Uint16,Color,Uint32 sdl2_ttf: renderUNICODE_Blended_Wrapped(font: ptr Font; text: ptr Uint16; fg: Color;\n wrapLength: Uint32): ptr Surface
|
||||
renderGlyph_Blended sdl2/sdl2_ttf.html#renderGlyph_Blended,ptr.Font,Uint16,Color sdl2_ttf: renderGlyph_Blended(font: ptr Font; ch: Uint16; fg: Color): ptr Surface
|
||||
closeFont sdl2/sdl2_ttf.html#closeFont,ptr.Font sdl2_ttf: closeFont(font: ptr Font)
|
||||
quit sdl2/sdl2_ttf.html#quit sdl2_ttf: quit()
|
||||
wasInit sdl2/sdl2_ttf.html#wasInit sdl2_ttf: wasInit(): cint
|
||||
getFontKerningSize sdl2/sdl2_ttf.html#getFontKerningSize,ptr.Font,cint,cint sdl2_ttf: getFontKerningSize(font: ptr Font; prevIndex: cint; index: cint): cint
|
||||
getFontKerningSizeGlyphs sdl2/sdl2_ttf.html#getFontKerningSizeGlyphs,ptr.Font,Uint16,Uint16 sdl2_ttf: getFontKerningSizeGlyphs(font: ptr Font; previousCh: Uint16; ch: Uint16): cint
|
||||
Loading…
Add table
Add a link
Reference in a new issue