Module tksdl

Functions

• MIDINoteToFrequency(float note) : float (tksdl) - Convert MIDI note to frequency

Classes

• AudioDevice - Static class that represents a wrapper audio output via SDL.
    Methods:
  • closeDSP() - Close sound device
  • enableFileOutput(boolean bEnabled) - Enable/disable file output
  • finishBlock() - Finally send sample block to audio device
  • getBpm() : float - Query beats per minute
  • getPpq() : int - Query precision per quarter
  • getSwapstereo() : boolean - Query whether stereo channels are swapped
  • getVolume() : float - Query master volume
  • openDSP(float freq, int bufSize) : boolean - Open sound device with the given parameters
  • processTimeFrames() - Trigger onAudioFrame(), onAudioRender() signal callbacks
  • setBpm(float bpm) - Set beats per minute
  • setDefaultBufferSize(int bufSize) - Set output buffer size (and thus audio latency). Warning: Not all drivers can handle small buffer sizes. The default buffer size is 8192 samples
  • setFileName(String fileName) - Where to write the sample data when file output is enabled
  • setPpq(int ppq) - Set precision per quarter
  • setSwapstereo(boolean b) - Enable stereo channel swapping
  • setVolume(float f) - Set master volume for sample mixer.
  • start() - Start sound output
  • stop() - Stop sound output
  
  
• AudioSample - 
    Methods:
  • allocBuffer(int l, float f, int ch, sw) : boolean - Allocate new audio buffer
  • convertChannels(int ch) - Convert sample to given number of channels
  • copyBufferFrom(AudioSample o) - Copy audio sample data from other sample
  • freeBuffer() - Free memory occupied by sample data
  • getBaseFrequency() : float - Query sample base frequency
  • getChannels() : int - Query number of channels
  • getFrequency() : float - Query sample frequency
  • getLength() : int - Query sample length
  • getOffset() : int - Query sample offset
  • getRepeatLength() : int - Query sample repeat length
  • getRepeatOffset() : int - Get sample repeat offset
  • loadAIFF(String name) : boolean - Load AIFF sample from pak file
  • loadLocalAIFF(String name) : boolean - Load AIFF sample from local file
  • normalize() - Normalize sample data
  • setBaseFrequency(float f) - Set sample base frequency
  • setFrequency(float f) - Set sample frequency
  • setLength(int len) - Set sample length
  • setOffset(int off) - Set sample offset
  • setRepeatLength(int len) - Set sample repeat length
  • setRepeatOffset(int off) - Query sample repeat offset
  • visitBuffer(AudioSample o) - Share sample data with other sample
  
  
• Cursor - Represents a mouse cursor shape
    Methods:
  • create(String pixels(int w, h, hotx, hoty) : boolean - Create new monochrome cursor shape from string. 'X' or 'x' means a set pixel and '.' means a cleared pixel.
  • revert() - Revert to previous cursor shape
  • show() : boolean - Change cursor to this shape. 
  
  
• FPS - Utility class for measuring/controlling frames per second
    Methods:
  • getAverage() : float - Get average FPS rate (Hz)
  • getCurrent() : float - Get current FPS (in Hz, extrapolated from last frame)
  • getLimit() : int - Query current FPS limit
  • getMax() : float - Query maximum FPS rate
  • getNumFramesRendered() - Query total number of frames rendered
  • getPrecision() : float - Return current precision.
  • getReal() : float - Return real interpolated frames per second
  • getTickBuffer() : int - Query current maximum number of ticks to catch up
  • getTickInterval() : float - Query current tick interval
  • getTotalTime() : int - Get total time (millisec)
  • reset() - Reset FPS counters.
  • setLimit(int limit) - Set FPS limit (in Hz)
  • setMax(float max) - Set maximum FPS rate (Hz).
  • setTickBuffer(int size) - Set the maximum number of ticks to catch up to if the rendering is too slow.
  • setTickInterval(float interval) - Set desired tick interval in millisec.
  
  
• Joystick - Represents an SDL joystick device
    Methods:
  • getAxis(int axis) : int - Query current value of a joystick axis.
  • getBall(int ball, Object ret) : boolean - Query relative trackball motion
  • getButton(int button) : int - Query joystick button state
  • getHat(int hat) : int - Query the current state of a joystick hat
  • getIndex() : int - Get the instance ID of an opened joystick (SDL_JoystickInstanceID())
  • getName() : String - Query joystick device name
  • getNumAxes() : int - Query number of joystick axes
  • getNumBalls() : int - Query number of trackballs
  • getNumButtons() : int - Query number of buttons
  • getNumHats() : int - Query number of hats
  
    Constants:
  • int SDL_HAT_CENTERED - 
  • int SDL_HAT_DOWN - 
  • int SDL_HAT_LEFT - 
  • int SDL_HAT_LEFTDOWN - 
  • int SDL_HAT_LEFTUP - 
  • int SDL_HAT_RIGHT - 
  • int SDL_HAT_RIGHTDOWN - 
  • int SDL_HAT_RIGHTUP - 
  • int SDL_HAT_UP - 
  
  
• Key - Represents a keyboard event
    Methods:
  • getAlpha() : int - Return (untranslated) ASCII code or 0 if this is a special key event.
  • getCode() : int - Query raw key code
  • getCodeName() : String - Return raw keycode name
  • getMod() : int - Query modifier mask
  • getModName() : String - Return modifier mask name
  • getName() : String - Return full keyevent name
  • getNameFor(int key, mod) : String - Return full name for given key code and modifier mask.
  • getPressed() : int - Query pressed (raw) key code. Returns 0 if this is not a keypress event.
  • getReleased() : int - Query release (raw) key code. Return 0 if this is not a keyrelease event.
  • getUnicode() : int - Return (translated) unicode char.
  • modAlt() : boolean - Query whether left or right alt key modifiers are used
  • modAltOnly() : boolean - Query whether only the left or right alt key modifiers are used
  • modCaps() : boolean - Query whether capslock modifier is used
  • modCmd() : boolean - Query whether left or right (macOS) command key modifiers are used
  • modCmdOnly() : boolean - Query whether only the left or right alt key modifiers are used
  • modCtrl() : boolean - Query whether left or right control key modifiers are used
  • modCtrlOnly() : boolean - Query whether only the left or right control key modifiers are used
  • modNone() : boolean - Query whether no key modifiers are used
  • modShift() : boolean - Query whether left or right shift key modifiers are used
  • modShiftOnly() : boolean - Query whether only the left or right shift key modifiers are used
  • modShiftOrCaps() : boolean - Query whether left or right shift key modifiers or capslock is used
  • setAlpha(int c) - Set (untranslated) ASCII key code
  • setCode(int code) - Set raw keycode.
  • setCodeName(String s) - Set key code by name
  • SetLocalToRawKeyTableByName(String name) : boolean - Install localized keycode to raw scancode translation table.
  • setMod(int mod) - Set modifier mask
  • setModName(String s) - Set modifier mask by name
  • setName(String s) - Set key code and modifier mask by name
  • setPressed(int code) - Set raw keycode and set pressed flag.
  • setReleased(int code) - Set raw keycode and set released flag.
  • setUnicode(int c) - Set unicode char
  
    Constants:
  • int DCON - 
  • int STDERR - 
  • int STDOUT - 
  • int UC_CTRL_A - 
  • int UC_CTRL_B - 
  • int UC_CTRL_C - 
  • int UC_CTRL_D - 
  • int UC_CTRL_E - 
  • int UC_CTRL_F - 
  • int UC_CTRL_G - 
  • int UC_CTRL_H - 
  • int UC_CTRL_I - 
  • int UC_CTRL_J - 
  • int UC_CTRL_K - 
  • int UC_CTRL_L - 
  • int UC_CTRL_M - 
  • int UC_CTRL_N - 
  • int UC_CTRL_O - 
  • int UC_CTRL_P - 
  • int UC_CTRL_Q - 
  • int UC_CTRL_R - 
  • int UC_CTRL_S - 
  • int UC_CTRL_T - 
  • int UC_CTRL_U - 
  • int UC_CTRL_V - 
  • int UC_CTRL_W - 
  • int UC_CTRL_X - 
  • int UC_CTRL_Y - 
  • int UC_CTRL_Z - 
  • int VKEY_0 - 
  • int VKEY_1 - 
  • int VKEY_2 - 
  • int VKEY_3 - 
  • int VKEY_4 - 
  • int VKEY_5 - 
  • int VKEY_6 - 
  • int VKEY_7 - 
  • int VKEY_8 - 
  • int VKEY_9 - 
  • int VKEY_AMPERSAND - 
  • int VKEY_ASTERISK - 
  • int VKEY_AT - 
  • int VKEY_BACKQUOTE - 
  • int VKEY_BACKSLASH - 
  • int VKEY_BACKSPACE - 
  • int VKEY_BREAK - 
  • int VKEY_CAPSLOCK - 
  • int VKEY_CARET - 
  • int VKEY_CLEAR - 
  • int VKEY_COLON - 
  • int VKEY_COMMA - 
  • int VKEY_COMPOSE - 
  • int VKEY_DELETE - 
  • int VKEY_DOLLAR - 
  • int VKEY_DOWN - 
  • int VKEY_END - 
  • int VKEY_EQUALS - 
  • int VKEY_ESCAPE - 
  • int VKEY_EURO - 
  • int VKEY_EXCLAIM - 
  • int VKEY_F1 - 
  • int VKEY_F10 - 
  • int VKEY_F11 - 
  • int VKEY_F12 - 
  • int VKEY_F13 - 
  • int VKEY_F14 - 
  • int VKEY_F15 - 
  • int VKEY_F2 - 
  • int VKEY_F3 - 
  • int VKEY_F4 - 
  • int VKEY_F5 - 
  • int VKEY_F6 - 
  • int VKEY_F7 - 
  • int VKEY_F8 - 
  • int VKEY_F9 - 
  • int VKEY_GREATER - 
  • int VKEY_HASH - 
  • int VKEY_HELP - 
  • int VKEY_HOME - 
  • int VKEY_INSERT - 
  • int VKEY_JOY0AXIS0NEG - 
  • int VKEY_JOY0AXIS0POS - 
  • int VKEY_JOY0AXIS1NEG - 
  • int VKEY_JOY0AXIS1POS - 
  • int VKEY_JOY0BUTTON0 - 
  • int VKEY_JOY0BUTTON1 - 
  • int VKEY_JOY0BUTTON2 - 
  • int VKEY_JOY0BUTTON3 - 
  • int VKEY_JOY0BUTTON4 - 
  • int VKEY_JOY0BUTTON5 - 
  • int VKEY_JOY0BUTTON6 - 
  • int VKEY_JOY0BUTTON7 - 
  • int VKEY_JOY0BUTTON8 - 
  • int VKEY_JOY1AXIS0NEG - 
  • int VKEY_JOY1AXIS0POS - 
  • int VKEY_JOY1AXIS1NEG - 
  • int VKEY_JOY1AXIS1POS - 
  • int VKEY_JOY1BUTTON0 - 
  • int VKEY_JOY1BUTTON1 - 
  • int VKEY_JOY1BUTTON2 - 
  • int VKEY_JOY1BUTTON3 - 
  • int VKEY_JOY1BUTTON4 - 
  • int VKEY_JOY1BUTTON5 - 
  • int VKEY_JOY1BUTTON6 - 
  • int VKEY_JOY1BUTTON7 - 
  • int VKEY_JOY1BUTTON8 - 
  • int VKEY_JOY2AXIS0NEG - 
  • int VKEY_JOY2AXIS0POS - 
  • int VKEY_JOY2AXIS1NEG - 
  • int VKEY_JOY2AXIS1POS - 
  • int VKEY_JOY2BUTTON0 - 
  • int VKEY_JOY2BUTTON1 - 
  • int VKEY_JOY2BUTTON2 - 
  • int VKEY_JOY2BUTTON3 - 
  • int VKEY_JOY2BUTTON4 - 
  • int VKEY_JOY2BUTTON5 - 
  • int VKEY_JOY2BUTTON6 - 
  • int VKEY_JOY2BUTTON7 - 
  • int VKEY_JOY2BUTTON8 - 
  • int VKEY_JOY3AXIS0NEG - 
  • int VKEY_JOY3AXIS0POS - 
  • int VKEY_JOY3AXIS1NEG - 
  • int VKEY_JOY3AXIS1POS - 
  • int VKEY_JOY3BUTTON0 - 
  • int VKEY_JOY3BUTTON1 - 
  • int VKEY_JOY3BUTTON2 - 
  • int VKEY_JOY3BUTTON3 - 
  • int VKEY_JOY3BUTTON4 - 
  • int VKEY_JOY3BUTTON5 - 
  • int VKEY_JOY3BUTTON6 - 
  • int VKEY_JOY3BUTTON7 - 
  • int VKEY_JOY3BUTTON8 - 
  • int VKEY_KP_0 - 
  • int VKEY_KP_1 - 
  • int VKEY_KP_2 - 
  • int VKEY_KP_3 - 
  • int VKEY_KP_4 - 
  • int VKEY_KP_5 - 
  • int VKEY_KP_6 - 
  • int VKEY_KP_7 - 
  • int VKEY_KP_8 - 
  • int VKEY_KP_9 - 
  • int VKEY_KP_DIVIDE - 
  • int VKEY_KP_ENTER - 
  • int VKEY_KP_EQUALS - 
  • int VKEY_KP_MINUS - 
  • int VKEY_KP_MULTIPLY - 
  • int VKEY_KP_PERIOD - 
  • int VKEY_KP_PLUS - 
  • int VKEY_LALT - *  (note) left control key on macOS
  • int VKEY_LCTRL - 
  • int VKEY_LEFT - 
  • int VKEY_LEFTBRACKET - 
  • int VKEY_LEFTPAREN - 
  • int VKEY_LESS - 
  • int VKEY_LMETA - *  (note) left command key on macOS
  • int VKEY_LSHIFT - 
  • int VKEY_LSUPER - 
  • int VKEY_MENU - 
  • int VKEY_MINUS - 
  • int VKEY_MODE - 
  • int VKEY_MOUSEBUTTON0 - 
  • int VKEY_MOUSEBUTTON1 - 
  • int VKEY_MOUSEBUTTON2 - 
  • int VKEY_MOUSEBUTTON3 - 
  • int VKEY_MOUSEBUTTON4 - 
  • int VKEY_NUMLOCK - 
  • int VKEY_PAGEDOWN - 
  • int VKEY_PAGEUP - 
  • int VKEY_PAUSE - 
  • int VKEY_PERIOD - 
  • int VKEY_PLUS - 
  • int VKEY_POWER - 
  • int VKEY_PRINT - 
  • int VKEY_QUESTION - 
  • int VKEY_QUOTE - 
  • int VKEY_QUOTEDBL - 
  • int VKEY_RALT - 
  • int VKEY_RCTRL - 
  • int VKEY_RETURN - 
  • int VKEY_RIGHT - 
  • int VKEY_RIGHTBRACKET - 
  • int VKEY_RIGHTPAREN - 
  • int VKEY_RMETA - 
  • int VKEY_RSHIFT - 
  • int VKEY_RSUPER - 
  • int VKEY_SCROLLOCK - 
  • int VKEY_SEMICOLON - 
  • int VKEY_SLASH - 
  • int VKEY_SPACE - 
  • int VKEY_SYSREQ - 
  • int VKEY_TAB - 
  • int VKEY_UNDERSCORE - 
  • int VKEY_UP - 
  • int VMOD_CAPS - 
  • int VMOD_LALT - 
  • int VMOD_LCTRL - 
  • int VMOD_LMETA - *  == KMOD_LGUI
  • int VMOD_LSHIFT - 
  • int VMOD_MODE - 
  • int VMOD_NUM - 
  • int VMOD_RALT - 
  • int VMOD_RCTRL - 
  • int VMOD_RMETA - *  == KMOD_RGUI
  • int VMOD_RSHIFT - 
  
  
• Mouse - Static wrapper class for the Mouse device
    Methods:
  • getButtons() : int - Get current button mask
  • getChangedButtons() - Query changed button mask
  • getDx() : int - Get relative horizontal mouse position
  • getDy() - Get relative vertical mouse position
  • getPointerMode() : int - Query current mouse pointer autohide mode.
  • getX() : int - Get absolute horizontal mouse position
  • getY() : int - Get absolute vertical mouse position
  • grab() - Grab mouse
  • isGrabbed() : boolean - Query whether the mouse is currently grabbed
  • setPointerMode(int mode) - Set autohide pointer mode.
  • showPointer(boolean bVisible) - Show/hide the mouse pointer
  • toggleGrab() - Toggle mouse grab
  • ungrab() - Ungrab mouse
  • unproject(Object nearRet, farRet) - Unproject mouse position and return near/far vectors
  • warpTo(int x, y) - Move mouse cursor to specified window coordinates
  
  
• SamplePlayer - A very basic sample player class.
    Methods:
  • getPan() : float - Query panning offset for next noteOn calls
  • getPolyphony() : int - Query polyphony
  • getSample() : AudioSample - Query currently active sample
  • getVolume() : float - Query global volume
  • noteOff(int note) - Stop sample that is has been playing the given note for the longest time
  • noteOn(int note, float v) - Trigger note using the currently active sample
  • processSamples(FloatArray fa) - Render/mix samples to the given output stream
  • setPan(float v) - Set panning offset for next noteOn
  • setPolyphony(int numVoices) - Set polyphony
  • setSample(AudioSample sample) - Set active sample
  • setVolume(float v) - Set global volume
  
  
• SDL - Static wrapper class for the SDL library.
    Methods:
  • delay(int millisec) - Suspend thread for the given number of millisec
  • enableKeyRepeat(int delay, rate) - Configure SDL key repeat
  • enableUNICODE(boolean bEnabled) - Configure whether unicode conversion shall be performed when processing keyboard events
  • eventLoop() - Enter SDL event loop. 
  • exitEventLoop() - Exit SDL event loop.
  • getCursorZoom() : int - Query cursor shape zoom factor
  • getEventPolling() : boolean - Query whether blocking waits shall be used when retrieving the next SDL message
  • getJoystick(int dev) : Joystick - Return Joystick device object. Lazy-inits SDL JOYSTICK subsystem.
  • getNumJoysticks() : int - Query number of available joystick devices. Lazy-inits SDL JOYSTICK subsystem.
  • getRedrawFlag() : int - Query redraw behaviour
  • getTicks() : int - Return number of ticks (millisec) since app. start
  • getTimerInterval() : int - Query timer interval.
  • isApplicationActive() : boolean - Query whether the application windows is currently in the foreground.
  • reportJoystickEvent(boolean bEnable) - Configure whether joystick events shall be reported
  • sendEvent(String ev) - Post event message to event queue
  • setCursorZoom(int zoom) - Sets cursor shape zoom factor (e.g. for Linux 4k screens)
  • setEventPolling(boolean bEnabled) - Configure whether blocking waits shall be used when retrieving the next SDL message
  • setIconFromBMP(Buffer bmpData) - Set window icon
  • setRedrawFlag(int flags) - Control redraw behaviour
  • setTimerInterval(int intervalMillisec) - Set timer interval for onTimer() signal/callback.
  • triggerEvent(String ev) - Immediately send user event
  • updateJoysticks() - Update joystick state
  
    Constants:
  • int DEFAULT_KEYBOARD_REPEAT_DELAY - 
  • int DEFAULT_KEYBOARD_REPEAT_INTERVAL - 
  • int MOUSE_LBUTTON - 
  • int MOUSE_MBUTTON - 
  • int MOUSE_POINTER_ENTER - 
  • int MOUSE_POINTER_MANUAL - 
  • int MOUSE_POINTER_MOVE - 
  • int MOUSE_RBUTTON - 
  • int MOUSE_WHEELDOWN - 
  • int MOUSE_WHEELUP - 
  • int REDRAW_ALL - 
  • int REDRAW_DIRTY - 
  • int SDL_NOFRAME - 
  • int SDL_RESIZABLE - 
  
  
• Viewport - Static wrapper class for a couple of viewport related functions
    Methods:
  • beginPaint() - Begin painting
  • close() - Close desktop or fullscreen window
  • endPaint() - Flush GL commandlist and swap buffers
  • getDepth() : int - Query color depth
  • getDesktopHeight() : int - Query desktop height
  • getDesktopWidth() : int - Query desktop width
  • getDoubleBuffer() : boolean - Query whether a double buffered OpenGL surface shall be allocated
  • getDpi() : int - Query dots-per-inch resolution for current window/screen.
  • getEnableGLError() : boolean - Query whether GL error reporting (see setEnableGLError()) is currently enabled.
  • getFlags() : int - Query openWindow() resp. openScreen() flags
  • getFrequency() : int - Query monitor frequency
  • getHeight() : int - Query window/screen height
  • getMultisampleBuffers() : int - Query number of GL multisample buffers
  • getMultisampleSamples() : int - Query number of GL multisample samples
  • getPositionX() : int - Query (desktop) window position x
  • getPositionY() : int - Query (desktop) window position y
  • getSizeX() : int - Query (desktop) window width (including borders / title bar)
  • getSizeY() : int - Query (desktop) window height (including borders / title bar)
  • getWidth() : int - Query window/screen width
  • interruptScreenSaver() - Try to interrupt the screensaver, usually by sending a synthetic event to the root/desktop window.
  • isFullScreen() - 
  • needRedraw() - If the repaint strategy is REDRAW_DIRTY, this will cause a display redraw.
  • openScreen(int w, h, z) : boolean - Open fullscreen window
  • openWindow(int w, h) : boolean - Open desktop window.
  • resizeWindow(int w, h) : boolean - Resize desktop window
  • setCaption() : String - Set window title
  • setDoubleBuffer(boolean bEnabled) - Hint that a double buffered OpenGL surface shall be allocated
  • setEnableGLError(boolean bEnabled) - Enable/disable GL error reporting (default=false).
  • setEnableRendering(boolean bEnabled) - Mainly for debugging purposes / CPU load measurement
  • setFlags(int flags) - Set flags for openWindow() resp. openScreen() call
  • setGeometry(int x, y, w, h) - Move (desktop) window to another screen position and (optionally) resize it.
  • setMinimumSize(int w, h) - Set minimum view size.
  • setMultisampleBuffers(int num) - Set number of GL multisample buffers.
  • setMultisampleSamples(int num) - Set number of GL multisample samples
  • setScreenResolution(int w, h, z) - Set fullscreen resolution and depth for next toggleFullScreen() call
  • setStencilBits(int num) - Set number of stencil buffer bits
  • swapInterval(int interval) - A wrapper for the wglSwapIntervalEXT() resp. glXSwapIntervalSGI() native functions
  • toggleFullScreen() - Toggle fullscreen mode
  • waitVBlank() - Wait for vertical retrace interrupt